Amazon.CloudFormation.Model

Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.

For more information, see Configuring a target account gate.

The AccountLimit data type.

CloudFormation has the following limits per account:

• Number of concurrent resources

• Number of stacks

• Number of stack outputs

For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide.

Container for the parameters to the ActivateOrganizationsAccess operation. Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

This is the response object from the ActivateOrganizationsAccess operation.

Container for the parameters to the ActivateType operation. Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

This is the response object from the ActivateType operation.

The resource with the name requested already exists.

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

Container for the parameters to the BatchDescribeTypeConfigurations operation. Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

This is the response object from the BatchDescribeTypeConfigurations operation.

Container for the parameters to the CancelUpdateStack operation. 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.

This is the response object from the CancelUpdateStack operation.

An error occurred during a CloudFormation registry operation.

The Change structure describes the changes CloudFormation will perform if you execute the change set.

Specifies the resource, the hook, and the hook version to be invoked.

Specifies RESOURCE type target details for activated hooks.

Specifies target details for an activated hook.

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

Paginators for the CloudFormation service

No more than 5 generated templates can be in an InProgress or Pending status at one time. This error is also returned if a generated template that is in an InProgress or Pending status is attempted to be updated or deleted.

Container for the parameters to the ContinueUpdateRollback operation. 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 fix the error 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.

The output for a ContinueUpdateRollback operation.

Container for the parameters to the CreateChangeSet operation. 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 action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet 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.

The output for the CreateChangeSet action.

The specified resource exists, but has been changed.

Container for the parameters to the CreateGeneratedTemplate operation. Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.

This is the response object from the CreateGeneratedTemplate operation.

Container for the parameters to the CreateStackInstances operation. 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.

This is the response object from the CreateStackInstances operation.

Container for the parameters to the CreateStack operation. 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 operation.

The output for a CreateStack action.

Container for the parameters to the CreateStackSet operation. Creates a stack set.

This is the response object from the CreateStackSet operation.

Container for the parameters to the DeactivateOrganizationsAccess operation. Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

This is the response object from the DeactivateOrganizationsAccess operation.

Container for the parameters to the DeactivateType operation. 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.

This is the response object from the DeactivateType operation.

Container for the parameters to the DeleteChangeSet operation. 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.

The output for the DeleteChangeSet action.

Container for the parameters to the DeleteGeneratedTemplate operation. Deleted a generated template.

This is the response object from the DeleteGeneratedTemplate operation.

Container for the parameters to the DeleteStackInstances operation. Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

This is the response object from the DeleteStackInstances operation.

Container for the parameters to the DeleteStack operation. Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.

This is the response object from the DeleteStack operation.

Container for the parameters to the DeleteStackSet operation. 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.

This is the response object from the DeleteStackSet operation.

[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

For update operations, you can specify either Accounts or OrganizationalUnitIds. For create and delete operations, specify OrganizationalUnitIds.

Container for the parameters to the DeregisterType operation. 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 DescribeType.

This is the response object from the DeregisterType operation.

Container for the parameters to the DescribeAccountLimits operation. 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 CloudFormation Quotas in the CloudFormation User Guide.

The output for the DescribeAccountLimits action.

Container for the parameters to the DescribeChangeSetHooks operation. Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

This is the response object from the DescribeChangeSetHooks operation.

Container for the parameters to the DescribeChangeSet operation. 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 Updating Stacks Using Change Sets in the CloudFormation User Guide.

The output for the DescribeChangeSet action.

Container for the parameters to the DescribeGeneratedTemplate operation. Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.

This is the response object from the DescribeGeneratedTemplate operation.

Container for the parameters to the DescribeOrganizationsAccess operation. Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.

This is the response object from the DescribeOrganizationsAccess operation.

Container for the parameters to the DescribePublisher operation. 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:

• RegisterPublisher

• Publishing extensions to make them available for public use in the CloudFormation CLI User Guide

This is the response object from the DescribePublisher operation.

Container for the parameters to the DescribeResourceScan operation. Describes details of a resource scan.

This is the response object from the DescribeResourceScan operation.

Container for the parameters to the DescribeStackDriftDetectionStatus operation. 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 its 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 Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift 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 to return drift information about the stack and its resources.

This is the response object from the DescribeStackDriftDetectionStatus operation.

Container for the parameters to the DescribeStackEvents operation. Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events 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).

The output for a DescribeStackEvents action.

Container for the parameters to the DescribeStackInstance operation. Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

This is the response object from the DescribeStackInstance operation.

Container for the parameters to the DescribeStackResourceDrifts operation. 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 Resources that Support Drift Detection.

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

This is the response object from the DescribeStackResourceDrifts operation.

Container for the parameters to the DescribeStackResource operation. 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.

The output for a DescribeStackResource action.

Container for the parameters to the DescribeStackResources operation. 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 CloudFormation User Guide.

The output for a DescribeStackResources action.

Container for the parameters to the DescribeStackSetOperation operation. Returns the description of the specified StackSet operation.

This is the response object from the DescribeStackSetOperation operation.

Container for the parameters to the DescribeStackSet operation. Returns the description of the specified StackSet.

This is the response object from the DescribeStackSet operation.

Container for the parameters to the DescribeStacks operation. Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.

If the stack doesn't exist, a ValidationError is returned.

The output for a DescribeStacks action.

Container for the parameters to the DescribeTypeRegistration operation. Returns information about an extension's registration, including its current status and type and version identifiers.

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

Once the registration request has completed, use DescribeType to return detailed information about an extension.

This is the response object from the DescribeTypeRegistration operation.

Container for the parameters to the DescribeType operation. 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.

This is the response object from the DescribeType operation.

Container for the parameters to the DetectStackDrift operation. Detects whether a stack's actual configuration differs, or has drifted, from its 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 Detecting Unregulated Configuration Changes to Stacks and Resources.

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

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts 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.

This is the response object from the DetectStackDrift operation.

Container for the parameters to the DetectStackResourceDrift operation. Returns information about whether a resource's actual configuration differs, or has drifted, from its 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 Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift 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 Resources that Support Drift Detection.

This is the response object from the DetectStackResourceDrift operation.

Container for the parameters to the DetectStackSetDrift operation. 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 How CloudFormation performs drift detection on a stack set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation 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 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 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 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 Detecting unmanaged changes in stack sets.

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.

This is the response object from the DetectStackSetDrift operation.

Container for the parameters to the EstimateTemplateCost operation. 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.

The output for a EstimateTemplateCost action.

Container for the parameters to the ExecuteChangeSet operation. 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 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.

The output for the ExecuteChangeSet action.

The Export structure describes the exported output values for a stack.

The generated template was not found.

Container for the parameters to the GetGeneratedTemplate operation. Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.

This is the response object from the GetGeneratedTemplate operation.

Container for the parameters to the GetStackPolicy operation. Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

The output for the GetStackPolicy action.

Container for the parameters to the GetTemplate operation. 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.

The output for GetTemplate action.

Container for the parameters to the GetTemplateSummary operation. 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.

The output for the GetTemplateSummary action.

Container for the parameters to the ImportStacksToStackSet operation. 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.

This is the response object from the ImportStacksToStackSet operation.

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

The specified operation isn't valid.

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

The quota for the resource has already been reached.

For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.

Container for the parameters to the ListChangeSets operation. 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.

The output for the ListChangeSets action.

Container for the parameters to the ListExports operation. 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 Fn::ImportValue function.

For more information, see CloudFormation export stack output values.

This is the response object from the ListExports operation.

Container for the parameters to the ListGeneratedTemplates operation. Lists your generated templates in this Region.

This is the response object from the ListGeneratedTemplates operation.

Container for the parameters to the ListImports operation. 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.

For more information about importing an exported output value, see the Fn::ImportValue function.

This is the response object from the ListImports operation.

Container for the parameters to the ListResourceScanRelatedResources operation. Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

This is the response object from the ListResourceScanRelatedResources operation.

Container for the parameters to the ListResourceScanResources operation. Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.

This is the response object from the ListResourceScanResources operation.

Container for the parameters to the ListResourceScans operation. List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

This is the response object from the ListResourceScans operation.

Container for the parameters to the ListStackInstanceResourceDrifts operation. Returns drift information for resources in a stack instance.

ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.

This is the response object from the ListStackInstanceResourceDrifts operation.

Container for the parameters to the ListStackInstances operation. 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.

This is the response object from the ListStackInstances operation.

Container for the parameters to the ListStackResources operation. 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.

The output for a ListStackResources action.

Container for the parameters to the ListStackSetAutoDeploymentTargets operation. Returns summary information about deployment targets for a stack set.

This is the response object from the ListStackSetAutoDeploymentTargets operation.

Container for the parameters to the ListStackSetOperationResults operation. Returns summary information about the results of a stack set operation.

This is the response object from the ListStackSetOperationResults operation.

Container for the parameters to the ListStackSetOperations operation. Returns summary information about operations performed on a stack set.

This is the response object from the ListStackSetOperations operation.

Container for the parameters to the ListStackSets operation. 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.

This is the response object from the ListStackSets operation.

Container for the parameters to the ListStacks operation. 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).

The output for ListStacks action.

Container for the parameters to the ListTypeRegistrations operation. Returns a list of registration tokens for the specified extension(s).

This is the response object from the ListTypeRegistrations operation.

Container for the parameters to the ListTypes operation. Returns summary information about extension that have been registered with CloudFormation.

This is the response object from the ListTypes operation.

Container for the parameters to the ListTypeVersions operation. Returns summary information about the versions of an extension.

This is the response object from the ListTypeVersions operation.

Contains logging configuration information for an extension.

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

For more information about modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.

The specified name is already in use.

The specified operation ID already exists.

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

The specified ID refers to an operation that doesn't exist.

The status that operation results are filtered by.

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

The Output data type.

The Parameter data type.

A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, CloudFormation returns only the AllowedValues property.

The ParameterDeclaration data type.

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Container for the parameters to the PublishType operation. 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 Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

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

This is the response object from the PublishType operation.

Container for the parameters to the RecordHandlerProgress operation. Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

This is the response object from the RecordHandlerProgress operation.

Container for the parameters to the RegisterPublisher operation. 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 Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

This is the response object from the RegisterPublisher operation.

Container for the parameters to the RegisterType operation. 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 Creating Resource Providers 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 to deregister specific extension versions if necessary.

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

Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

This is the response object from the RegisterType operation.

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

For more information, see Activating public modules for use in your account in the CloudFormation User Guide.

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.

A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

Details about a resource in a generated template

Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.

A resource scan is currently in progress. Only one can be run at a time for an account in a Region.

The limit on resource scans has been exceeded. Reasons include:

• Exceeded the daily quota for resource scans.

• A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.

• The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.

The resource scan was not found.

A summary of the resource scan. This is returned by the ListResourceScan API action.

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

Describes the target resource of an import operation.

Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.

Container for the parameters to the RollbackStack operation. 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 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

This is the response object from the RollbackStack operation.

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources.

Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.

Container for the parameters to the SetStackPolicy operation. Sets a stack policy for a specified stack.

This is the response object from the SetStackPolicy operation.

Container for the parameters to the SetTypeConfiguration operation. 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. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

This is the response object from the SetTypeConfiguration operation.

Container for the parameters to the SetTypeDefaultVersion operation. Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

This is the response object from the SetTypeDefaultVersion operation.

Container for the parameters to the SignalResource operation. 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.

This is the response object from the SignalResource operation.

The Stack data type.

Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.

Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.

The StackEvent data type.

An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.

The detailed status of the stack instance.

The filter to apply to stack instances

The specified stack instance doesn't exist.

The structure containing summary information about resource drifts for a stack instance.

The structure that contains summary information about a stack instance.

The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.

The StackResource data type.

Contains detailed information about the specified stack resource.

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

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

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

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

Contains high-level information about the specified stack resource.

A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

One of the targets for the stack set. Returned by the ListStackSetAutoDeploymentTargets API operation.

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress isn't included.

For stack set operations, includes information about drift operations currently being performed on the stack set.

For more information, see Detecting unmanaged changes in stack sets in the CloudFormation User Guide.

You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.

The specified stack set doesn't exist.

The structure that contains information about a stack set operation.

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

The structure that contains information about a specified operation's results for a given account in a given Region.

Detailed information about the StackSet operation.

The structures that contain summary information about the specified operation.

The structures that contain summary information about the specified stack set.

The StackSummary Data Type

Another operation has been performed on this stack set since the specified operation was performed.

Container for the parameters to the StartResourceScan operation. Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.

This is the response object from the StartResourceScan operation.

Container for the parameters to the StopStackSetOperation operation. 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.

This is the response object from the StopStackSetOperation operation.

The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

The configuration details of a generated template.

The TemplateParameter data type.

A summary of the progress of the template generation.

The summary of a generated template.

Options for the GetTemplateSummary API action.

Container for the parameters to the TestType operation. 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 Testing your public extension prior to publishing 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.

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType 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 Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

This is the response object from the TestType operation.

A client request token already exists.

Detailed information concerning the specification of a CloudFormation extension in a given account and Region.

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Identifying information for the configuration of a CloudFormation extension.

The specified extension configuration can't be found.

Filter criteria to use in determining which extensions to return.

The specified extension doesn't exist in the CloudFormation registry.

Contains summary information about the specified CloudFormation extension.

Contains summary information about a specific version of a CloudFormation extension.

Container for the parameters to the UpdateGeneratedTemplate operation. Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.

This is the response object from the UpdateGeneratedTemplate operation.

Container for the parameters to the UpdateStackInstances operation. 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 CreateStackInstances.

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 UpdateStackSet 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 UpdateStackSet 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.

This is the response object from the UpdateStackInstances operation.

The input for UpdateStack action.

The output for an UpdateStack action.

Container for the parameters to the UpdateStackSet operation. 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 calls on the specified stack set use the updated stack set.

This is the response object from the UpdateStackSet operation.

Container for the parameters to the UpdateTerminationProtection operation. 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 Protecting a Stack From Being Deleted in the CloudFormation User Guide.

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

This is the response object from the UpdateTerminationProtection operation.

Container for the parameters to the ValidateTemplate operation. 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.

The output for ValidateTemplate action.

The warnings generated for a specific resource for this generated template.

A specific property that is impacted by a warning.

Contains any warnings returned by the GetTemplateSummary API action.

Paginators for the CloudFormation service

Paginator for the DescribeAccountLimits operation

Paginator for the DescribeStackEvents operation

Paginator for the DescribeStackResourceDrifts operation

Paginator for the DescribeStacks operation

Paginator for the ListChangeSets operation

Paginator for the ListExports operation

Paginator for the ListGeneratedTemplates operation

Paginator for the ListImports operation

Paginator for the ListResourceScanRelatedResources operation

Paginator for the ListResourceScanResources operation

Paginator for the ListResourceScans operation

Paginator for the ListStackInstances operation

Paginator for the ListStackResources operation

Paginator for the ListStackSetOperationResults operation

Paginator for the ListStackSetOperations operation

Paginator for the ListStackSets operation

Paginator for the ListStacks operation

Paginator for the ListTypeRegistrations operation

Paginator for the ListTypes operation

Paginator for the ListTypeVersions operation