amazonaws.com – cloudformation

OpenAPI apis-guru cloud

CloudFormation

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 .

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 .

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:cloudformation/2010-05-15.json
Provider: amazonaws.com:cloudformation / cloudformation
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/cloudformation/2010-05-15/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/cloudformation/2010-05-15/openapi.yaml

Tools (134)

Extracted live via the executor SDK.

actionActivateType.getActivateType

Activates a public third-party extension, making it available for use in stack templates. For more information, see in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration [blocked] to specify configuration properties for the extension. For more information, see in the CloudFormation User Guide.
actionActivateType.postActivateType

Activates a public third-party extension, making it available for use in stack templates. For more information, see in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration [blocked] to specify configuration properties for the extension. For more information, see in the CloudFormation User Guide.
actionBatchDescribeTypeConfigurations.getBatchDescribeTypeConfigurations

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

For more information, see in the CloudFormation User Guide.
actionBatchDescribeTypeConfigurations.postBatchDescribeTypeConfigurations

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

For more information, see in the CloudFormation User Guide.
actionCancelUpdateStack.getCancelUpdateStack

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.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
actionCancelUpdateStack.postCancelUpdateStack

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.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
actionContinueUpdateRollback.getContinueUpdateRollback

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED 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.
actionContinueUpdateRollback.postContinueUpdateRollback

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED 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.
actionCreateChangeSet.getCreateChangeSet

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 ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet [blocked] action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet [blocked] action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
actionCreateChangeSet.postCreateChangeSet

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 ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet [blocked] action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet [blocked] action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
actionCreateStack.getCreateStack

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks [blocked]operation.
actionCreateStack.postCreateStack

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks [blocked]operation.
actionCreateStackInstances.getCreateStackInstances

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
actionCreateStackInstances.postCreateStackInstances

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
actionCreateStackSet.getCreateStackSet

Creates a stack set.
actionCreateStackSet.postCreateStackSet

Creates a stack set.
actionDeactivateType.getDeactivateType

Deactivates a public extension that was previously activated in this account and region.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
actionDeactivateType.postDeactivateType

Deactivates a public extension that was previously activated in this account and region.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
actionDeleteChangeSet.getDeleteChangeSet

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
actionDeleteChangeSet.postDeleteChangeSet

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
actionDeleteStack.getDeleteStack

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks [blocked] operation if the deletion has been completed successfully.
actionDeleteStack.postDeleteStack

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks [blocked] operation if the deletion has been completed successfully.
actionDeleteStackInstances.getDeleteStackInstances

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
actionDeleteStackInstances.postDeleteStackInstances

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
actionDeleteStackSet.getDeleteStackSet

Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances [blocked].
actionDeleteStackSet.postDeleteStackSet

Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances [blocked].
actionDeregisterType.getDeregisterType

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use .
actionDeregisterType.postDeregisterType

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use .
actionDescribeAccountLimits.getDescribeAccountLimits

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see in the CloudFormation User Guide.
actionDescribeAccountLimits.postDescribeAccountLimits

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see in the CloudFormation User Guide.
actionDescribeChangeSet.getDescribeChangeSet

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see in the CloudFormation User Guide.
actionDescribeChangeSet.postDescribeChangeSet

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see in the CloudFormation User Guide.
actionDescribeChangeSetHooks.getDescribeChangeSetHooks

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
actionDescribeChangeSetHooks.postDescribeChangeSetHooks

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
actionDescribePublisher.getDescribePublisher
Returns information about a CloudFormation extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information about registering as a publisher, see:
- in the CloudFormation CLI User Guide
actionDescribePublisher.postDescribePublisher
Returns information about a CloudFormation extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information about registering as a publisher, see:
- in the CloudFormation CLI User Guide
actionDescribeStackDriftDetectionStatus.getDescribeStackDriftDetectionStatus

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see .

Use DetectStackDrift [blocked] to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts [blocked] to return drift information about the stack and its resources.
actionDescribeStackDriftDetectionStatus.postDescribeStackDriftDetectionStatus

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see .

Use DetectStackDrift [blocked] to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts [blocked] to return drift information about the stack and its resources.
actionDescribeStackEvents.getDescribeStackEvents

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to in the CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
actionDescribeStackEvents.postDescribeStackEvents

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to in the CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
actionDescribeStackInstance.getDescribeStackInstance

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances [blocked].
actionDescribeStackInstance.postDescribeStackInstance

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances [blocked].
actionDescribeStackResource.getDescribeStackResource

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
actionDescribeStackResource.postDescribeStackResource

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
actionDescribeStackResourceDrifts.getDescribeStackResourceDrifts

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see .

Use DetectStackResourceDrift [blocked] to detect drift on individual resources, or DetectStackDrift [blocked] to detect drift on all supported resources for a given stack.
actionDescribeStackResourceDrifts.postDescribeStackResourceDrifts

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see .

Use DetectStackResourceDrift [blocked] to detect drift on individual resources, or DetectStackDrift [blocked] to detect drift on all supported resources for a given stack.
actionDescribeStackResources.getDescribeStackResources

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the .

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
actionDescribeStackResources.postDescribeStackResources

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the .

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
actionDescribeStacks.getDescribeStacks

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack doesn't exist, an ValidationError is returned.
actionDescribeStacks.postDescribeStacks

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack doesn't exist, an ValidationError is returned.
actionDescribeStackSet.getDescribeStackSet

Returns the description of the specified stack set.
actionDescribeStackSet.postDescribeStackSet

Returns the description of the specified stack set.
actionDescribeStackSetOperation.getDescribeStackSetOperation

Returns the description of the specified stack set operation.
actionDescribeStackSetOperation.postDescribeStackSetOperation

Returns the description of the specified stack set operation.
actionDescribeType.getDescribeType

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.
actionDescribeType.postDescribeType

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.
actionDescribeTypeRegistration.getDescribeTypeRegistration

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType [blocked] , you can then use DescribeTypeRegistration [blocked] to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType [blocked] to return detailed information about an extension.
actionDescribeTypeRegistration.postDescribeTypeRegistration

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType [blocked] , you can then use DescribeTypeRegistration [blocked] to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType [blocked] to return detailed information about an extension.
actionDetectStackDrift.getDetectStackDrift

Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see .

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift [blocked] to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see .

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus [blocked] to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts [blocked] to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
actionDetectStackDrift.postDetectStackDrift

Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see .

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift [blocked] to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see .

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus [blocked] to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts [blocked] to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
actionDetectStackResourceDrift.getDetectStackResourceDrift

Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see .

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift [blocked] to detect drift on all resources in a given stack that support drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see .
actionDetectStackResourceDrift.postDetectStackResourceDrift

Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see .

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift [blocked] to detect drift on all resources in a given stack that support drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see .
actionDetectStackSetDrift.getDetectStackSetDrift
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see .

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation [blocked] to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:
- Use DescribeStackSet [blocked] to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
- Use ListStackInstances [blocked] to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
- Use DescribeStackInstance [blocked] to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see .

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation [blocked] .
actionDetectStackSetDrift.postDetectStackSetDrift
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see .

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation [blocked] to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:
- Use DescribeStackSet [blocked] to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
- Use ListStackInstances [blocked] to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
- Use DescribeStackInstance [blocked] to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see .

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation [blocked] .
actionEstimateTemplateCost.getEstimateTemplateCost

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
actionEstimateTemplateCost.postEstimateTemplateCost

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
actionExecuteChangeSet.getExecuteChangeSet

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks [blocked] action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.
actionExecuteChangeSet.postExecuteChangeSet

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks [blocked] action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.
actionGetStackPolicy.getGetStackPolicy

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
actionGetStackPolicy.postGetStackPolicy

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
actionGetTemplate.getGetTemplate

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template doesn't exist, a ValidationError is returned.
actionGetTemplate.postGetTemplate

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template doesn't exist, a ValidationError is returned.
actionGetTemplateSummary.getGetTemplateSummary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.
actionGetTemplateSummary.postGetTemplateSummary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.
actionImportStacksToStackSet.getImportStacksToStackSet

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

ImportStacksToStackSet is only supported by self-managed permissions.
actionImportStacksToStackSet.postImportStacksToStackSet

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

ImportStacksToStackSet is only supported by self-managed permissions.
actionListChangeSets.getListChangeSets

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
actionListChangeSets.postListChangeSets

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
actionListExports.getListExports

Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the function.

For more information, see .
actionListExports.postListExports

Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the function.

For more information, see .
actionListImports.getListImports

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports [blocked].

For more information about importing an exported output value, see the function.
actionListImports.postListImports

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports [blocked].

For more information about importing an exported output value, see the function.
actionListStackInstances.getListStackInstances

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
actionListStackInstances.postListStackInstances

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
actionListStackResources.getListStackResources

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
actionListStackResources.postListStackResources

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
actionListStacks.getListStacks

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
actionListStacks.postListStacks

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
actionListStackSetOperationResults.getListStackSetOperationResults

Returns summary information about the results of a stack set operation.
actionListStackSetOperationResults.postListStackSetOperationResults

Returns summary information about the results of a stack set operation.
actionListStackSetOperations.getListStackSetOperations

Returns summary information about operations performed on a stack set.
actionListStackSetOperations.postListStackSetOperations

Returns summary information about operations performed on a stack set.
actionListStackSets.getListStackSets
Returns summary information about stack sets that are associated with the user.
- [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
- [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.
- [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.
actionListStackSets.postListStackSets
Returns summary information about stack sets that are associated with the user.
- [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
- [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.
- [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.
actionListTypeRegistrations.getListTypeRegistrations

Returns a list of registration tokens for the specified extension(s).
actionListTypeRegistrations.postListTypeRegistrations

Returns a list of registration tokens for the specified extension(s).
actionListTypes.getListTypes

Returns summary information about extension that have been registered with CloudFormation.
actionListTypes.postListTypes

Returns summary information about extension that have been registered with CloudFormation.
actionListTypeVersions.getListTypeVersions

Returns summary information about the versions of an extension.
actionListTypeVersions.postListTypeVersions

Returns summary information about the versions of an extension.
actionPublishType.getPublishType

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see .
actionPublishType.postPublishType

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see .
actionRecordHandlerProgress.getRecordHandlerProgress

Reports progress of a resource handler to CloudFormation.

Reserved for use by the . Don't use this API in your code.
actionRecordHandlerProgress.postRecordHandlerProgress

Reports progress of a resource handler to CloudFormation.

Reserved for use by the . Don't use this API in your code.
actionRegisterPublisher.getRegisterPublisher

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see in the CloudFormation CLI User Guide.
actionRegisterPublisher.postRegisterPublisher

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see in the CloudFormation CLI User Guide.
actionRegisterType.getRegisterType
Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
- Validating the extension schema.
- Determining which handlers, if any, have been specified for the extension.
- Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType [blocked] to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType [blocked] , you can use DescribeTypeRegistration [blocked] to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration [blocked] to specify configuration properties for the extension. For more information, see in the CloudFormation User Guide.
actionRegisterType.postRegisterType
Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
- Validating the extension schema.
- Determining which handlers, if any, have been specified for the extension.
- Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType [blocked] to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType [blocked] , you can use DescribeTypeRegistration [blocked] to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration [blocked] to specify configuration properties for the extension. For more information, see in the CloudFormation User Guide.
actionRollbackStack.getRollbackStack
When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks [blocked] operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.
- CREATE_COMPLETE
- UPDATE_COMPLETE
- UPDATE_ROLLBACK_COMPLETE
- IMPORT_COMPLETE
- IMPORT_ROLLBACK_COMPLETE
*_
actionRollbackStack.postRollbackStack
When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks [blocked] operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.
- CREATE_COMPLETE
- UPDATE_COMPLETE
- UPDATE_ROLLBACK_COMPLETE
- IMPORT_COMPLETE
- IMPORT_ROLLBACK_COMPLETE
*_
actionSetStackPolicy.getSetStackPolicy

Sets a stack policy for a specified stack.
actionSetStackPolicy.postSetStackPolicy

Sets a stack policy for a specified stack.
actionSetTypeConfiguration.getSetTypeConfiguration

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType [blocked]. For more information, see in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see in the CloudFormation User Guide.
actionSetTypeConfiguration.postSetTypeConfiguration

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType [blocked]. For more information, see in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see in the CloudFormation User Guide.
actionSetTypeDefaultVersion.getSetTypeDefaultVersion

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
actionSetTypeDefaultVersion.postSetTypeDefaultVersion

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
actionSignalResource.getSignalResource

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
actionSignalResource.postSignalResource

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
actionStopStackSetOperation.getStopStackSetOperation

Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
actionStopStackSetOperation.postStopStackSetOperation

Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
actionTestType.getTestType
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
- For resource types, this includes passing all contracts tests defined for the type.
- For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see in the CloudFormation CLI User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType [blocked].

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see in the CloudFormation CLI User Guide.
actionTestType.postTestType
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
- For resource types, this includes passing all contracts tests defined for the type.
- For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see in the CloudFormation CLI User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType [blocked].

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see in the CloudFormation CLI User Guide.
actionUpdateStack.getUpdateStack

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks [blocked] action.

To get a copy of the template for an existing stack, you can use the GetTemplate [blocked] action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see .
actionUpdateStack.postUpdateStack

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks [blocked] action.

To get a copy of the template for an existing stack, you can use the GetTemplate [blocked] action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see .
actionUpdateStackInstances.getUpdateStackInstances

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use .

During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
actionUpdateStackInstances.postUpdateStackInstances

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use .

During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
actionUpdateStackSet.getUpdateStackSet

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances [blocked] calls on the specified stack set use the updated stack set.
actionUpdateStackSet.postUpdateStackSet

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances [blocked] calls on the specified stack set use the updated stack set.
actionUpdateTerminationProtection.getUpdateTerminationProtection

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see in the CloudFormation User Guide.

For , termination protection is set on the root stack and can't be changed directly on the nested stack.
actionUpdateTerminationProtection.postUpdateTerminationProtection

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see in the CloudFormation User Guide.

For , termination protection is set on the root stack and can't be changed directly on the nested stack.
actionValidateTemplate.getValidateTemplate

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
actionValidateTemplate.postValidateTemplate

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools