@itentialopensource/adapter-aws_cloudformation

openapi: 3.0.0 info: title: AWS CloudFormation description: <fullname>CloudFormation</fullname> CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure. With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>. CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/"> <code>docs.aws.amazon.com</code> </a>. contact: name: Mike Ralphson url: https://github.com/mermade/aws2openapi email: mike.ralphson@gmail.com version: '2010-05-15' servers: - url: http://cloudformation.{region}.amazonaws.com description: The AWS CloudFormation multi-region endpoint variables: 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 region - url: https://cloudformation.{region}.amazonaws.com description: The AWS CloudFormation multi-region endpoint variables: 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 region - url: http://cloudformation.{region}.amazonaws.com.cn description: The AWS CloudFormation endpoint for China (Beijing) and China (Ningxia) variables: 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 region - url: https://cloudformation.{region}.amazonaws.com.cn description: The AWS CloudFormation endpoint for China (Beijing) and China (Ningxia) variables: 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 region paths: /#Action=ActivateType: get: summary: GET_ActivateType description: Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public extensions</a> in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and region, use <a href="AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the CloudFormation User Guide. operationId: GET_ActivateType parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Type in: query description: 'The extension type. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.' style: form explode: true schema: allOf: - $ref: '#/components/schemas/ThirdPartyType' - description: 'The extension type. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.' - name: PublicTypeArn in: query description: 'The Amazon Resource Name (ARN) of the public extension. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.' style: form explode: true schema: maxLength: 1024 pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+ type: string - name: PublisherId in: query description: 'The ID of the extension publisher. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.' style: form explode: true schema: maxLength: 40 minLength: 1 pattern: '[0-9a-zA-Z]{12,40}' type: string - name: TypeName in: query description: 'The name of the extension. Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.' style: form explode: true schema: maxLength: 204 minLength: 10 pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}' type: string - name: TypeNameAlias in: query description: An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console. An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases. style: form explode: true schema: maxLength: 204 minLength: 10 pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}' type: string - name: AutoUpdate in: query 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. The default is <code>true</code>. style: form explode: true schema: type: boolean - name: LoggingConfig in: query description: '' style: form explode: true schema: $ref: '#/components/schemas/LoggingConfig' - name: ExecutionRoleArn in: query description: The name of the IAM execution role to use to activate the extension. style: form explode: true schema: maxLength: 256 minLength: 1 pattern: arn:.+:iam::[0-9]{12}:role/.+ type: string - name: VersionBump in: query description: 'Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of <code>AutoUpdate</code>. <ul> <li> <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is available. </li> <li> <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is available. </li> </ul>' style: form explode: true schema: allOf: - $ref: '#/components/schemas/VersionBump' - description: 'Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of <code>AutoUpdate</code>. <ul> <li> <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is available. </li> <li> <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is available. </li> </ul>' - name: MajorVersion in: query description: The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected. You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not both. style: form explode: true schema: maximum: 100000 minimum: 1 type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: text/xml: schema: allOf: - $ref: '#/components/schemas/ActivateTypeOutput' - xml: name: ActivateTypeOutput attribute: false wrapped: false '480': description: CFNRegistryException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false '481': description: TypeNotFoundException headers: {} content: text/xml: schema: xml: name: response481 attribute: false wrapped: false deprecated: false post: summary: POST_ActivateType description: Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public extensions</a> in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and region, use <a href="AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the CloudFormation User Guide. operationId: POST_ActivateType parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' - name: Content-Type in: header description: '' required: true style: simple schema: enum: - text/xml type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/ActivateTypeInput' - xml: name: ActivateTypeInput attribute: false wrapped: false required: false responses: '200': description: Success headers: {} content: text/xml: schema: allOf: - $ref: '#/components/schemas/ActivateTypeOutput' - xml: name: ActivateTypeOutput attribute: false wrapped: false '480': description: CFNRegistryException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false '481': description: TypeNotFoundException headers: {} content: text/xml: schema: xml: name: response481 attribute: false wrapped: false deprecated: false /#Action=BatchDescribeTypeConfigurations: get: summary: GET_BatchDescribeTypeConfigurations description: Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the CloudFormation User Guide. operationId: GET_BatchDescribeTypeConfigurations parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: TypeConfigurationIdentifiers in: query description: The list of identifiers for the desired extension configurations. required: true style: form explode: true schema: minItems: 1 type: array items: $ref: '#/components/schemas/TypeConfigurationIdentifier' - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action2' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: text/xml: schema: allOf: - $ref: '#/components/schemas/BatchDescribeTypeConfigurationsOutput' - xml: name: BatchDescribeTypeConfigurationsOutput attribute: false wrapped: false '480': description: TypeConfigurationNotFoundException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false '481': description: CFNRegistryException headers: {} content: text/xml: schema: xml: name: response481 attribute: false wrapped: false deprecated: false post: summary: POST_BatchDescribeTypeConfigurations description: Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the CloudFormation User Guide. operationId: POST_BatchDescribeTypeConfigurations parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action2' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' - name: Content-Type in: header description: '' required: true style: simple schema: enum: - text/xml type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/BatchDescribeTypeConfigurationsInput' - xml: name: BatchDescribeTypeConfigurationsInput attribute: false wrapped: false required: false responses: '200': description: Success headers: {} content: text/xml: schema: allOf: - $ref: '#/components/schemas/BatchDescribeTypeConfigurationsOutput' - xml: name: BatchDescribeTypeConfigurationsOutput attribute: false wrapped: false '480': description: TypeConfigurationNotFoundException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false '481': description: CFNRegistryException headers: {} content: text/xml: schema: xml: name: response481 attribute: false wrapped: false deprecated: false /#Action=CancelUpdateStack: get: summary: GET_CancelUpdateStack description: Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note> You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state. </note> operationId: GET_CancelUpdateStack parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: StackName in: query description: The name or the unique stack ID that's associated with the stack. required: true style: form explode: true schema: type: string - name: ClientRequestToken in: query description: A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully received them. style: form explode: true schema: maxLength: 128 minLength: 1 pattern: '[a-zA-Z0-9][-a-zA-Z0-9]*' type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action4' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: {} '480': description: TokenAlreadyExistsException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false deprecated: false post: summary: POST_CancelUpdateStack description: Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note> You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state. </note> operationId: POST_CancelUpdateStack parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action4' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' - name: Content-Type in: header description: '' required: true style: simple schema: enum: - text/xml type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/CancelUpdateStackInput' - xml: name: CancelUpdateStackInput attribute: false wrapped: false required: false responses: '200': description: Success headers: {} content: {} '480': description: TokenAlreadyExistsException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false deprecated: false /#Action=ContinueUpdateRollback: get: summary: GET_ContinueUpdateRollback description: For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. operationId: GET_ContinueUpdateRollback parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: StackName in: query description: The name or the unique ID of the stack that you want to continue rolling back. <note> Don't specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource). </note> required: true style: form explode: true schema: minLength: 1 pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*) type: string - name: RoleARN in: query description: The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials. style: form explode: true schema: maxLength: 2048 minLength: 20 type: string - name: ResourcesToSkip in: query description: "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. <important> Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </important> Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. <note> Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks\">Using ResourcesToSkip to recover a nested stacks hierarchy</a>. </note>" style: form explode: true schema: type: array items: pattern: '[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\.[a-zA-Z0-9]+' type: string - name: ClientRequestToken in: query description: A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this token if you plan to retry requests so that CloudFormationknows that you're not attempting to continue the rollback to a stack with the same name. You might retry <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation successfully received them. style: form explode: true schema: maxLength: 128 minLength: 1 pattern: '[a-zA-Z0-9][-a-zA-Z0-9]*' type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action6' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: text/xml: schema: type: object description: The output for a <a>ContinueUpdateRollback</a> operation. xml: name: response200 attribute: false wrapped: false '480': description: TokenAlreadyExistsException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false deprecated: false post: summary: POST_ContinueUpdateRollback description: For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. operationId: POST_ContinueUpdateRollback parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action6' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' - name: Content-Type in: header description: '' required: true style: simple schema: enum: - text/xml type: string requestBody: description: '' content: application/xml: schema: allOf: - $ref: '#/components/schemas/ContinueUpdateRollbackInput' - xml: name: ContinueUpdateRollbackInput attribute: false wrapped: false required: false responses: '200': description: Success headers: {} content: text/xml: schema: type: object description: The output for a <a>ContinueUpdateRollback</a> operation. xml: name: response200 attribute: false wrapped: false '480': description: TokenAlreadyExistsException headers: {} content: text/xml: schema: xml: name: response480 attribute: false wrapped: false deprecated: false /#Action=CreateChangeSet: get: summary: GET_CreateChangeSet description: Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action. When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make changes until you execute the change set. To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to <code>True</code>. operationId: GET_CreateChangeSet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: StackName in: query description: The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values. required: true style: form explode: true schema: minLength: 1 pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*) type: string - name: TemplateBody in: query description: 'A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.' style: form explode: true schema: minLength: 1 type: string - name: TemplateURL in: query description: "The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>." style: form explode: true schema: maxLength: 1024 minLength: 1 type: string - name: UsePreviousTemplate in: query description: Whether to reuse the template that's associated with the stack to create the change set. style: form explode: true schema: type: boolean - name: Parameters in: query description: A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a>Parameter</a> data type. style: form explode: true schema: type: array items: $ref: '#/components/schemas/Parameter' - name: Capabilities in: query description: In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack. <ul> <li> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability. <ul> <li> If you have IAM resources, you can specify either capability. </li> <li> If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. </li> <li> If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error. </li> </ul> If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary. <ul> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html"> AWS::IAM::AccessKey</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html"> AWS::IAM::Group</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html"> AWS::IAM::Policy</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html"> AWS::IAM::Role</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html"> AWS::IAM::User</a> </li> <li> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a> </li> </ul> For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM resources in CloudFormation templates</a>. </li> <li> <code>CAPABILITY_AUTO_EXPAND</code> Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/Use