SDK for PHP 3.x

Client: Aws\CloudFormation\CloudFormationClient
Service ID: cloudformation
Version: 2010-05-15

This page describes the parameters and results for the operations of the AWS CloudFormation (2010-05-15), and shows how to use the Aws\CloudFormation\CloudFormationClient object to call the described operations. This documentation is specific to the 2010-05-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ActivateOrganizationsAccess ( array $params = [] )
Activate trusted access with Organizations.
ActivateType ( array $params = [] )
Activates a public third-party extension, making it available for use in stack templates.
BatchDescribeTypeConfigurations ( array $params = [] )
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
CancelUpdateStack ( array $params = [] )
Cancels an update on the specified stack.
ContinueUpdateRollback ( array $params = [] )
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state.
CreateChangeSet ( array $params = [] )
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
CreateGeneratedTemplate ( array $params = [] )
Creates a template from existing resources that are not already managed with CloudFormation.
CreateStack ( array $params = [] )
Creates a stack as specified in the template.
CreateStackInstances ( array $params = [] )
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.
CreateStackSet ( array $params = [] )
Creates a stack set.
DeactivateOrganizationsAccess ( array $params = [] )
Deactivates trusted access with Organizations.
DeactivateType ( array $params = [] )
Deactivates a public extension that was previously activated in this account and Region.
DeleteChangeSet ( array $params = [] )
Deletes the specified change set.
DeleteGeneratedTemplate ( array $params = [] )
Deleted a generated template.
DeleteStack ( array $params = [] )
Deletes a specified stack.
DeleteStackInstances ( array $params = [] )
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
DeleteStackSet ( array $params = [] )
Deletes a stack set.
DeregisterType ( array $params = [] )
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use.
DescribeAccountLimits ( array $params = [] )
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.
DescribeChangeSet ( array $params = [] )
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.
DescribeChangeSetHooks ( array $params = [] )
Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
DescribeGeneratedTemplate ( array $params = [] )
Describes a generated template.
DescribeOrganizationsAccess ( array $params = [] )
Retrieves information about the account's OrganizationAccess status.
DescribePublisher ( array $params = [] )
Returns information about a CloudFormation extension publisher.
DescribeResourceScan ( array $params = [] )
Describes details of a resource scan.
DescribeStackDriftDetectionStatus ( array $params = [] )
Returns information about a stack drift detection operation.
DescribeStackEvents ( array $params = [] )
Returns all stack related events for a specified stack in reverse chronological order.
DescribeStackInstance ( array $params = [] )
Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
DescribeStackResource ( array $params = [] )
Returns a description of the specified resource in the specified stack.
DescribeStackResourceDrifts ( array $params = [] )
Returns drift information for the resources that have been checked for drift in the specified stack.
DescribeStackResources ( array $params = [] )
Returns Amazon Web Services resource descriptions for running and deleted stacks.
DescribeStackSet ( array $params = [] )
Returns the description of the specified StackSet.
DescribeStackSetOperation ( array $params = [] )
Returns the description of the specified StackSet operation.
DescribeStacks ( array $params = [] )
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
DescribeType ( array $params = [] )
Returns detailed information about an extension that has been registered.
DescribeTypeRegistration ( array $params = [] )
Returns information about an extension's registration, including its current status and type and version identifiers.
DetectStackDrift ( array $params = [] )
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.
DetectStackResourceDrift ( array $params = [] )
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.
DetectStackSetDrift ( array $params = [] )
Detect drift on a stack set.
EstimateTemplateCost ( array $params = [] )
Returns the estimated monthly cost of a template.
ExecuteChangeSet ( array $params = [] )
Updates a stack using the input information that was provided when the specified change set was created.
GetGeneratedTemplate ( array $params = [] )
Retrieves a generated template.
GetStackPolicy ( array $params = [] )
Returns the stack policy for a specified stack.
GetTemplate ( array $params = [] )
Returns the template body for a specified stack.
GetTemplateSummary ( array $params = [] )
Returns information about a new or existing template.
ImportStacksToStackSet ( array $params = [] )
Import existing stacks into a new stack sets.
ListChangeSets ( array $params = [] )
Returns the ID and status of each active change set for a stack.
ListExports ( array $params = [] )
Lists all exported output values in the account and Region in which you call this action.
ListGeneratedTemplates ( array $params = [] )
Lists your generated templates in this Region.
ListImports ( array $params = [] )
Lists all stacks that are importing an exported output value.
ListResourceScanRelatedResources ( array $params = [] )
Lists the related resources for a list of resources from a resource scan.
ListResourceScanResources ( array $params = [] )
Lists the resources from a resource scan.
ListResourceScans ( array $params = [] )
List the resource scans from newest to oldest.
ListStackInstanceResourceDrifts ( array $params = [] )
Returns drift information for resources in a stack instance.
ListStackInstances ( array $params = [] )
Returns summary information about stack instances that are associated with the specified stack set.
ListStackResources ( array $params = [] )
Returns descriptions of all resources of the specified stack.
ListStackSetAutoDeploymentTargets ( array $params = [] )
Returns summary information about deployment targets for a stack set.
ListStackSetOperationResults ( array $params = [] )
Returns summary information about the results of a stack set operation.
ListStackSetOperations ( array $params = [] )
Returns summary information about operations performed on a stack set.
ListStackSets ( array $params = [] )
Returns summary information about stack sets that are associated with the user.
ListStacks ( array $params = [] )
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
ListTypeRegistrations ( array $params = [] )
Returns a list of registration tokens for the specified extension(s).
ListTypeVersions ( array $params = [] )
Returns summary information about the versions of an extension.
ListTypes ( array $params = [] )
Returns summary information about extension that have been registered with CloudFormation.
PublishType ( array $params = [] )
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
RecordHandlerProgress ( array $params = [] )
Reports progress of a resource handler to CloudFormation.
RegisterPublisher ( array $params = [] )
Registers your account as a publisher of public extensions in the CloudFormation registry.
RegisterType ( array $params = [] )
Registers an extension with the CloudFormation service.
RollbackStack ( array $params = [] )
When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails.
SetStackPolicy ( array $params = [] )
Sets a stack policy for a specified stack.
SetTypeConfiguration ( array $params = [] )
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
SetTypeDefaultVersion ( array $params = [] )
Specify the default version of an extension.
SignalResource ( array $params = [] )
Sends a signal to the specified resource with a success or failure status.
StartResourceScan ( array $params = [] )
Starts a scan of the resources in this account in this Region.
StopStackSetOperation ( array $params = [] )
Stops an in-progress operation on a stack set and its associated stack instances.
TestType ( array $params = [] )
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
UpdateGeneratedTemplate ( array $params = [] )
Updates a generated template.
UpdateStack ( array $params = [] )
Updates a stack as specified in the template.
UpdateStackInstances ( array $params = [] )
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.
UpdateStackSet ( array $params = [] )
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
UpdateTerminationProtection ( array $params = [] )
Updates termination protection for the specified stack.
ValidateTemplate ( array $params = [] )
Validates a specified template.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeAccountLimits
DescribeStackEvents
DescribeStackResourceDrifts
DescribeStackResources
DescribeStacks
ListChangeSets
ListExports
ListGeneratedTemplates
ListImports
ListResourceScanRelatedResources
ListResourceScanResources
ListResourceScans
ListStackInstances
ListStackResources
ListStackSetOperationResults
ListStackSetOperations
ListStackSets
ListStacks
ListTypeRegistrations
ListTypeVersions
ListTypes

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
StackExists DescribeStacks 5 20
StackCreateComplete DescribeStacks 30 120
StackDeleteComplete DescribeStacks 30 120
StackUpdateComplete DescribeStacks 30 120
StackImportComplete DescribeStacks 30 120
StackRollbackComplete DescribeStacks 30 120
ChangeSetCreateComplete DescribeChangeSet 30 120
TypeRegistrationComplete DescribeTypeRegistration 30 120

Operations

ActivateOrganizationsAccess

$result = $client->activateOrganizationsAccess([/* ... */]);
$promise = $client->activateOrganizationsAccessAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->activateOrganizationsAccess([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidOperationException:

The specified operation isn't valid.

OperationNotFoundException:

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

ActivateType

$result = $client->activateType([/* ... */]);
$promise = $client->activateTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->activateType([
    'AutoUpdate' => true || false,
    'ExecutionRoleArn' => '<string>',
    'LoggingConfig' => [
        'LogGroupName' => '<string>', // REQUIRED
        'LogRoleArn' => '<string>', // REQUIRED
    ],
    'MajorVersion' => <integer>,
    'PublicTypeArn' => '<string>',
    'PublisherId' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'TypeNameAlias' => '<string>',
    'VersionBump' => 'MAJOR|MINOR',
]);

Parameter Details

Members
AutoUpdate
Type: boolean

Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is true.

ExecutionRoleArn
Type: string

The name of the IAM execution role to use to activate the extension.

LoggingConfig
Type: LoggingConfig structure

Contains logging configuration information for an extension.

MajorVersion
Type: long (int|float)

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump, but not both.

PublicTypeArn
Type: string

The Amazon Resource Name (ARN) of the public extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

PublisherId
Type: string

The ID of the extension publisher.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

Type
Type: string

The extension type.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

TypeName
Type: string

The name of the extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

TypeNameAlias
Type: string

An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

VersionBump
Type: string

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

  • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

  • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the activated extension, in this account and Region.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

BatchDescribeTypeConfigurations

$result = $client->batchDescribeTypeConfigurations([/* ... */]);
$promise = $client->batchDescribeTypeConfigurationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchDescribeTypeConfigurations([
    'TypeConfigurationIdentifiers' => [ // REQUIRED
        [
            'Type' => 'RESOURCE|MODULE|HOOK',
            'TypeArn' => '<string>',
            'TypeConfigurationAlias' => '<string>',
            'TypeConfigurationArn' => '<string>',
            'TypeName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
TypeConfigurationIdentifiers
Required: Yes
Type: Array of TypeConfigurationIdentifier structures

The list of identifiers for the desired extension configurations.

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'TypeConfigurationIdentifier' => [
                'Type' => 'RESOURCE|MODULE|HOOK',
                'TypeArn' => '<string>',
                'TypeConfigurationAlias' => '<string>',
                'TypeConfigurationArn' => '<string>',
                'TypeName' => '<string>',
            ],
        ],
        // ...
    ],
    'TypeConfigurations' => [
        [
            'Alias' => '<string>',
            'Arn' => '<string>',
            'Configuration' => '<string>',
            'IsDefaultConfiguration' => true || false,
            'LastUpdated' => <DateTime>,
            'TypeArn' => '<string>',
            'TypeName' => '<string>',
        ],
        // ...
    ],
    'UnprocessedTypeConfigurations' => [
        [
            'Type' => 'RESOURCE|MODULE|HOOK',
            'TypeArn' => '<string>',
            'TypeConfigurationAlias' => '<string>',
            'TypeConfigurationArn' => '<string>',
            'TypeName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Errors
Type: Array of BatchDescribeTypeConfigurationsError structures

A list of information concerning any errors generated during the setting of the specified configurations.

TypeConfigurations
Type: Array of TypeConfigurationDetails structures

A list of any of the specified extension configurations from the CloudFormation registry.

UnprocessedTypeConfigurations
Type: Array of TypeConfigurationIdentifier structures

A list of any of the specified extension configurations that CloudFormation could not process for any reason.

Errors

TypeConfigurationNotFoundException:

The specified extension configuration can't be found.

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

CancelUpdateStack

$result = $client->cancelUpdateStack([/* ... */]);
$promise = $client->cancelUpdateStackAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelUpdateStack([
    'ClientRequestToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

StackName
Required: Yes
Type: string

If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account.

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

The name or the unique stack ID that's associated with the stack.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TokenAlreadyExistsException:

A client request token already exists.

ContinueUpdateRollback

$result = $client->continueUpdateRollback([/* ... */]);
$promise = $client->continueUpdateRollbackAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->continueUpdateRollback([
    'ClientRequestToken' => '<string>',
    'ResourcesToSkip' => ['<string>', ...],
    'RoleARN' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received them.

ResourcesToSkip
Type: Array of strings

A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

StackName
Required: Yes
Type: string

The name or the unique ID of the stack that you want to continue rolling back.

Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TokenAlreadyExistsException:

A client request token already exists.

CreateChangeSet

$result = $client->createChangeSet([/* ... */]);
$promise = $client->createChangeSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createChangeSet([
    'Capabilities' => ['<string>', ...],
    'ChangeSetName' => '<string>', // REQUIRED
    'ChangeSetType' => 'CREATE|UPDATE|IMPORT',
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'ImportExistingResources' => true || false,
    'IncludeNestedStacks' => true || false,
    'NotificationARNs' => ['<string>', ...],
    'OnStackFailure' => 'DO_NOTHING|ROLLBACK|DELETE',
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'ResourceTypes' => ['<string>', ...],
    'ResourcesToImport' => [
        [
            'LogicalResourceId' => '<string>', // REQUIRED
            'ResourceIdentifier' => ['<string>', ...], // REQUIRED
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RoleARN' => '<string>',
    'RollbackConfiguration' => [
        'MonitoringTimeInMinutes' => <integer>,
        'RollbackTriggers' => [
            [
                'Arn' => '<string>', // REQUIRED
                'Type' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'StackName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
    'UsePreviousTemplate' => true || false,
]);

Parameter Details

Members
Capabilities
Type: Array of strings

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM resources in CloudFormation templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.

    If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

    For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

Only one of the Capabilities and ResourceType parameters can be specified.

ChangeSetName
Required: Yes
Type: string

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

ChangeSetType
Type: string

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

ClientToken
Type: string

A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

Description
Type: string

A description to help you identify this change set.

ImportExistingResources
Type: boolean

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.

IncludeNestedStacks
Type: boolean

Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

NotificationARNs
Type: Array of strings

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

OnStackFailure
Type: string

Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

For nested stacks, when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.

Parameters
Type: Array of Parameter structures

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

ResourceTypes
Type: Array of strings

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

Only one of the Capabilities and ResourceType parameters can be specified.

ResourcesToImport
Type: Array of ResourceToImport structures

The resources to import into your stack.

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

RollbackConfiguration
Type: RollbackConfiguration structure

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

StackName
Required: Yes
Type: string

The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Tags
Type: Array of Tag structures

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

TemplateBody
Type: string

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

TemplateURL
Type: string

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only TemplateBody or TemplateURL.

UsePreviousTemplate
Type: boolean

Whether to reuse the template that's associated with the stack to create the change set.

Result Syntax

[
    'Id' => '<string>',
    'StackId' => '<string>',
]

Result Details

Members
Id
Type: string

The Amazon Resource Name (ARN) of the change set.

StackId
Type: string

The unique ID of the stack.

Errors

AlreadyExistsException:

The resource with the name requested already exists.

InsufficientCapabilitiesException:

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

LimitExceededException:

The quota for the resource has already been reached.

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

CreateGeneratedTemplate

$result = $client->createGeneratedTemplate([/* ... */]);
$promise = $client->createGeneratedTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createGeneratedTemplate([
    'GeneratedTemplateName' => '<string>', // REQUIRED
    'Resources' => [
        [
            'LogicalResourceId' => '<string>',
            'ResourceIdentifier' => ['<string>', ...], // REQUIRED
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'StackName' => '<string>',
    'TemplateConfiguration' => [
        'DeletionPolicy' => 'DELETE|RETAIN',
        'UpdateReplacePolicy' => 'DELETE|RETAIN',
    ],
]);

Parameter Details

Members
GeneratedTemplateName
Required: Yes
Type: string

The name assigned to the generated template.

Resources
Type: Array of ResourceDefinition structures

An optional list of resources to be included in the generated template.

If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.

StackName
Type: string

An optional name or ARN of a stack to use as the base stack for the generated template.

TemplateConfiguration
Type: TemplateConfiguration structure

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

Result Syntax

[
    'GeneratedTemplateId' => '<string>',
]

Result Details

Members
GeneratedTemplateId
Type: string

The ID of the generated template.

Errors

AlreadyExistsException:

The resource with the name requested already exists.

LimitExceededException:

The quota for the resource has already been reached.

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

ConcurrentResourcesLimitExceededException:

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.

Examples

Example 1: To create a generated template

This example creates a generated template with a resources file.

$result = $client->createGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
    'Resources' => [
        [
            'ResourceIdentifier' => [
                'BucketName' => 'jazz-bucket',
            ],
            'ResourceType' => 'AWS::S3::Bucket',
        ],
        [
            'ResourceIdentifier' => [
                'DhcpOptionsId' => 'random-id123',
            ],
            'ResourceType' => 'AWS::EC2::DHCPOptions',
        ],
    ],
]);

Result syntax:

[
    'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca',
]

CreateStack

$result = $client->createStack([/* ... */]);
$promise = $client->createStackAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createStack([
    'Capabilities' => ['<string>', ...],
    'ClientRequestToken' => '<string>',
    'DisableRollback' => true || false,
    'EnableTerminationProtection' => true || false,
    'NotificationARNs' => ['<string>', ...],
    'OnFailure' => 'DO_NOTHING|ROLLBACK|DELETE',
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'ResourceTypes' => ['<string>', ...],
    'RetainExceptOnCreate' => true || false,
    'RoleARN' => '<string>',
    'RollbackConfiguration' => [
        'MonitoringTimeInMinutes' => <integer>,
        'RollbackTriggers' => [
            [
                'Arn' => '<string>', // REQUIRED
                'Type' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'StackName' => '<string>', // REQUIRED
    'StackPolicyBody' => '<string>',
    'StackPolicyURL' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
    'TimeoutInMinutes' => <integer>,
]);

Parameter Details

Members
Capabilities
Type: Array of strings

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

    You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation macros to perform custom processing on templates.

Only one of the Capabilities and ResourceType parameters can be specified.

ClientRequestToken
Type: string

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

DisableRollback
Type: boolean

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

EnableTerminationProtection
Type: boolean

Whether to enable termination protection on 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. Termination protection is deactivated on stacks by default.

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

NotificationARNs
Type: Array of strings

The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

OnFailure
Type: string

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Parameters
Type: Array of Parameter structures

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

ResourceTypes
Type: Array of strings

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Only one of the Capabilities and ResourceType parameters can be specified.

RetainExceptOnCreate
Type: boolean

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

RollbackConfiguration
Type: RollbackConfiguration structure

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

StackName
Required: Yes
Type: string

The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.

StackPolicyBody
Type: string

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

StackPolicyURL
Type: string

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Tags
Type: Array of Tag structures

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

TemplateBody
Type: string

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

TemplateURL
Type: string

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

TimeoutInMinutes
Type: int

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Result Syntax

[
    'StackId' => '<string>',
]

Result Details

Members
StackId
Type: string

Unique identifier of the stack.

Errors

LimitExceededException:

The quota for the resource has already been reached.

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

AlreadyExistsException:

The resource with the name requested already exists.

TokenAlreadyExistsException:

A client request token already exists.

InsufficientCapabilitiesException:

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

CreateStackInstances

$result = $client->createStackInstances([/* ... */]);
$promise = $client->createStackInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createStackInstances([
    'Accounts' => ['<string>', ...],
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'DeploymentTargets' => [
        'AccountFilterType' => 'NONE|INTERSECTION|DIFFERENCE|UNION',
        'Accounts' => ['<string>', ...],
        'AccountsUrl' => '<string>',
        'OrganizationalUnitIds' => ['<string>', ...],
    ],
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'ParameterOverrides' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'Regions' => ['<string>', ...], // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Accounts
Type: Array of strings

[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

DeploymentTargets
Type: DeploymentTargets structure

[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

OperationId
Type: string

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

ParameterOverrides
Type: Array of Parameter structures

A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.

  • To leave all parameters set to their present values, don't specify this property at all.

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

You can only override 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.

Regions
Required: Yes
Type: Array of strings

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to create stack instances from.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The unique identifier for this stack set operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationInProgressException:

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

OperationIdAlreadyExistsException:

The specified operation ID already exists.

StaleRequestException:

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

InvalidOperationException:

The specified operation isn't valid.

LimitExceededException:

The quota for the resource has already been reached.

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

CreateStackSet

$result = $client->createStackSet([/* ... */]);
$promise = $client->createStackSetAsync([/* ... */]);

Creates a stack set.

Parameter Syntax

$result = $client->createStackSet([
    'AdministrationRoleARN' => '<string>',
    'AutoDeployment' => [
        'Enabled' => true || false,
        'RetainStacksOnAccountRemoval' => true || false,
    ],
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'Capabilities' => ['<string>', ...],
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'ExecutionRoleName' => '<string>',
    'ManagedExecution' => [
        'Active' => true || false,
    ],
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'PermissionModel' => 'SERVICE_MANAGED|SELF_MANAGED',
    'StackId' => '<string>',
    'StackSetName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
]);

Parameter Details

Members
AdministrationRoleARN
Type: string

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

AutoDeployment
Type: AutoDeployment structure

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Capabilities
Type: Array of strings

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

ClientRequestToken
Type: string

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Description
Type: string

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

ExecutionRoleName
Type: string

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

ManagedExecution
Type: ManagedExecution structure

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

Parameters
Type: Array of Parameter structures

The input parameters for the stack set template.

PermissionModel
Type: string

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

StackId
Type: string

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

StackSetName
Required: Yes
Type: string

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Tags
Type: Array of Tag structures

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

TemplateBody
Type: string

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

TemplateURL
Type: string

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Result Syntax

[
    'StackSetId' => '<string>',
]

Result Details

Members
StackSetId
Type: string

The ID of the stack set that you're creating.

Errors

NameAlreadyExistsException:

The specified name is already in use.

CreatedButModifiedException:

The specified resource exists, but has been changed.

LimitExceededException:

The quota for the resource has already been reached.

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

DeactivateOrganizationsAccess

$result = $client->deactivateOrganizationsAccess([/* ... */]);
$promise = $client->deactivateOrganizationsAccessAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deactivateOrganizationsAccess([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidOperationException:

The specified operation isn't valid.

OperationNotFoundException:

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

DeactivateType

$result = $client->deactivateType([/* ... */]);
$promise = $client->deactivateTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deactivateType([
    'Arn' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) for the extension, in this account and Region.

Conditional: You must specify either Arn, or TypeName and Type.

Type
Type: string

The extension type.

Conditional: You must specify either Arn, or TypeName and Type.

TypeName
Type: string

The type name of the extension, in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.

Conditional: You must specify either Arn, or TypeName and Type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

DeleteChangeSet

$result = $client->deleteChangeSet([/* ... */]);
$promise = $client->deleteChangeSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteChangeSet([
    'ChangeSetName' => '<string>', // REQUIRED
    'StackName' => '<string>',
]);

Parameter Details

Members
ChangeSetName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the change set that you want to delete.

StackName
Type: string

If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidChangeSetStatusException:

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.

DeleteGeneratedTemplate

$result = $client->deleteGeneratedTemplate([/* ... */]);
$promise = $client->deleteGeneratedTemplateAsync([/* ... */]);

Deleted a generated template.

Parameter Syntax

$result = $client->deleteGeneratedTemplate([
    'GeneratedTemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
GeneratedTemplateName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of a generated template.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

GeneratedTemplateNotFoundException:

The generated template was not found.

ConcurrentResourcesLimitExceededException:

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.

Examples

Example 1: To delete a generated template

This example deletes a generated template

$result = $client->deleteGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
]);

DeleteStack

$result = $client->deleteStack([/* ... */]);
$promise = $client->deleteStackAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteStack([
    'ClientRequestToken' => '<string>',
    'DeletionMode' => 'STANDARD|FORCE_DELETE_STACK',
    'RetainResources' => ['<string>', ...],
    'RoleARN' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

DeletionMode
Type: string

Specifies the deletion mode for the stack. Possible values are:

  • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

  • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

RetainResources
Type: Array of strings

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.

Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

StackName
Required: Yes
Type: string

The name or the unique stack ID that's associated with the stack.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TokenAlreadyExistsException:

A client request token already exists.

DeleteStackInstances

$result = $client->deleteStackInstances([/* ... */]);
$promise = $client->deleteStackInstancesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteStackInstances([
    'Accounts' => ['<string>', ...],
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'DeploymentTargets' => [
        'AccountFilterType' => 'NONE|INTERSECTION|DIFFERENCE|UNION',
        'Accounts' => ['<string>', ...],
        'AccountsUrl' => '<string>',
        'OrganizationalUnitIds' => ['<string>', ...],
    ],
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'Regions' => ['<string>', ...], // REQUIRED
    'RetainStacks' => true || false, // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Accounts
Type: Array of strings

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

DeploymentTargets
Type: DeploymentTargets structure

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

OperationId
Type: string

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

Regions
Required: Yes
Type: Array of strings

The Amazon Web Services Regions where you want to delete stack set instances.

RetainStacks
Required: Yes
Type: boolean

Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see Stack set operation options.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to delete stack instances for.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The unique identifier for this stack set operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationInProgressException:

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

OperationIdAlreadyExistsException:

The specified operation ID already exists.

StaleRequestException:

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

InvalidOperationException:

The specified operation isn't valid.

DeleteStackSet

$result = $client->deleteStackSet([/* ... */]);
$promise = $client->deleteStackSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteStackSet([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

StackSetNotEmptyException:

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.

OperationInProgressException:

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

DeregisterType

$result = $client->deregisterType([/* ... */]);
$promise = $client->deregisterTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deregisterType([
    'Arn' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

Type
Type: string

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName
Type: string

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

VersionId
Type: string

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

DescribeAccountLimits

$result = $client->describeAccountLimits([/* ... */]);
$promise = $client->describeAccountLimitsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeAccountLimits([
    'NextToken' => '<string>',
]);

Parameter Details

Members
NextToken
Type: string

A string that identifies the next page of limits that you want to retrieve.

Result Syntax

[
    'AccountLimits' => [
        [
            'Name' => '<string>',
            'Value' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
AccountLimits
Type: Array of AccountLimit structures

An account limit structure that contain a list of CloudFormation account limits and their values.

NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

Errors

There are no errors described for this operation.

DescribeChangeSet

$result = $client->describeChangeSet([/* ... */]);
$promise = $client->describeChangeSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeChangeSet([
    'ChangeSetName' => '<string>', // REQUIRED
    'IncludePropertyValues' => true || false,
    'NextToken' => '<string>',
    'StackName' => '<string>',
]);

Parameter Details

Members
ChangeSetName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

IncludePropertyValues
Type: boolean

If true, the returned changes include detailed changes in the property values.

NextToken
Type: string

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

StackName
Type: string

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

Result Syntax

[
    'Capabilities' => ['<string>', ...],
    'ChangeSetId' => '<string>',
    'ChangeSetName' => '<string>',
    'Changes' => [
        [
            'HookInvocationCount' => <integer>,
            'ResourceChange' => [
                'Action' => 'Add|Modify|Remove|Import|Dynamic',
                'AfterContext' => '<string>',
                'BeforeContext' => '<string>',
                'ChangeSetId' => '<string>',
                'Details' => [
                    [
                        'CausingEntity' => '<string>',
                        'ChangeSource' => 'ResourceReference|ParameterReference|ResourceAttribute|DirectModification|Automatic',
                        'Evaluation' => 'Static|Dynamic',
                        'Target' => [
                            'AfterValue' => '<string>',
                            'Attribute' => 'Properties|Metadata|CreationPolicy|UpdatePolicy|DeletionPolicy|UpdateReplacePolicy|Tags',
                            'AttributeChangeType' => 'Add|Remove|Modify',
                            'BeforeValue' => '<string>',
                            'Name' => '<string>',
                            'Path' => '<string>',
                            'RequiresRecreation' => 'Never|Conditionally|Always',
                        ],
                    ],
                    // ...
                ],
                'LogicalResourceId' => '<string>',
                'ModuleInfo' => [
                    'LogicalIdHierarchy' => '<string>',
                    'TypeHierarchy' => '<string>',
                ],
                'PhysicalResourceId' => '<string>',
                'PolicyAction' => 'Delete|Retain|Snapshot|ReplaceAndDelete|ReplaceAndRetain|ReplaceAndSnapshot',
                'Replacement' => 'True|False|Conditional',
                'ResourceType' => '<string>',
                'Scope' => ['<string>', ...],
            ],
            'Type' => 'Resource',
        ],
        // ...
    ],
    'CreationTime' => <DateTime>,
    'Description' => '<string>',
    'ExecutionStatus' => 'UNAVAILABLE|AVAILABLE|EXECUTE_IN_PROGRESS|EXECUTE_COMPLETE|EXECUTE_FAILED|OBSOLETE',
    'ImportExistingResources' => true || false,
    'IncludeNestedStacks' => true || false,
    'NextToken' => '<string>',
    'NotificationARNs' => ['<string>', ...],
    'OnStackFailure' => 'DO_NOTHING|ROLLBACK|DELETE',
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'ParentChangeSetId' => '<string>',
    'RollbackConfiguration' => [
        'MonitoringTimeInMinutes' => <integer>,
        'RollbackTriggers' => [
            [
                'Arn' => '<string>',
                'Type' => '<string>',
            ],
            // ...
        ],
    ],
    'RootChangeSetId' => '<string>',
    'StackId' => '<string>',
    'StackName' => '<string>',
    'Status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|FAILED',
    'StatusReason' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Capabilities
Type: Array of strings

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

ChangeSetId
Type: string

The Amazon Resource Name (ARN) of the change set.

ChangeSetName
Type: string

The name of the change set.

Changes
Type: Array of Change structures

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time when the change set was created, in UTC.

Description
Type: string

Information about the change set.

ExecutionStatus
Type: string

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

ImportExistingResources
Type: boolean

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

IncludeNestedStacks
Type: boolean

Verifies if IncludeNestedStacks is set to True.

NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

NotificationARNs
Type: Array of strings

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

OnStackFailure
Type: string

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

Parameters
Type: Array of Parameter structures

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

ParentChangeSetId
Type: string

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

RollbackConfiguration
Type: RollbackConfiguration structure

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

RootChangeSetId
Type: string

Specifies the change set ID of the root change set in the current nested change set hierarchy.

StackId
Type: string

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

StackName
Type: string

The name of the stack that's associated with the change set.

Status
Type: string

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

StatusReason
Type: string

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

Tags
Type: Array of Tag structures

If you execute the change set, the tags that will be associated with the stack.

Errors

ChangeSetNotFoundException:

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

DescribeChangeSetHooks

$result = $client->describeChangeSetHooks([/* ... */]);
$promise = $client->describeChangeSetHooksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeChangeSetHooks([
    'ChangeSetName' => '<string>', // REQUIRED
    'LogicalResourceId' => '<string>',
    'NextToken' => '<string>',
    'StackName' => '<string>',
]);

Parameter Details

Members
ChangeSetName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

LogicalResourceId
Type: string

If specified, lists only the hooks related to the specified LogicalResourceId.

NextToken
Type: string

A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.

StackName
Type: string

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

Result Syntax

[
    'ChangeSetId' => '<string>',
    'ChangeSetName' => '<string>',
    'Hooks' => [
        [
            'FailureMode' => 'FAIL|WARN',
            'InvocationPoint' => 'PRE_PROVISION',
            'TargetDetails' => [
                'ResourceTargetDetails' => [
                    'LogicalResourceId' => '<string>',
                    'ResourceAction' => 'Add|Modify|Remove|Import|Dynamic',
                    'ResourceType' => '<string>',
                ],
                'TargetType' => 'RESOURCE',
            ],
            'TypeConfigurationVersionId' => '<string>',
            'TypeName' => '<string>',
            'TypeVersionId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'StackId' => '<string>',
    'StackName' => '<string>',
    'Status' => 'PLANNING|PLANNED|UNAVAILABLE',
]

Result Details

Members
ChangeSetId
Type: string

The change set identifier (stack ID).

ChangeSetName
Type: string

The change set name.

Hooks
Type: Array of ChangeSetHook structures

List of hook objects.

NextToken
Type: string

Pagination token, null or empty if no more results.

StackId
Type: string

The stack identifier (stack ID).

StackName
Type: string

The stack name.

Status
Type: string

Provides the status of the change set hook.

Errors

ChangeSetNotFoundException:

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

DescribeGeneratedTemplate

$result = $client->describeGeneratedTemplate([/* ... */]);
$promise = $client->describeGeneratedTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeGeneratedTemplate([
    'GeneratedTemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
GeneratedTemplateName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of a generated template.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'GeneratedTemplateId' => '<string>',
    'GeneratedTemplateName' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Progress' => [
        'ResourcesFailed' => <integer>,
        'ResourcesPending' => <integer>,
        'ResourcesProcessing' => <integer>,
        'ResourcesSucceeded' => <integer>,
    ],
    'Resources' => [
        [
            'LogicalResourceId' => '<string>',
            'ResourceIdentifier' => ['<string>', ...],
            'ResourceStatus' => 'PENDING|IN_PROGRESS|FAILED|COMPLETE',
            'ResourceStatusReason' => '<string>',
            'ResourceType' => '<string>',
            'Warnings' => [
                [
                    'Properties' => [
                        [
                            'Description' => '<string>',
                            'PropertyPath' => '<string>',
                            'Required' => true || false,
                        ],
                        // ...
                    ],
                    'Type' => 'MUTUALLY_EXCLUSIVE_PROPERTIES|UNSUPPORTED_PROPERTIES|MUTUALLY_EXCLUSIVE_TYPES',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'StackId' => '<string>',
    'Status' => 'CREATE_PENDING|UPDATE_PENDING|DELETE_PENDING|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|FAILED|COMPLETE',
    'StatusReason' => '<string>',
    'TemplateConfiguration' => [
        'DeletionPolicy' => 'DELETE|RETAIN',
        'UpdateReplacePolicy' => 'DELETE|RETAIN',
    ],
    'TotalWarnings' => <integer>,
]

Result Details

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was created.

GeneratedTemplateId
Type: string

The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

GeneratedTemplateName
Type: string

The name of the generated template.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was last updated.

Progress
Type: TemplateProgress structure

An object describing the progress of the template generation.

Resources
Type: Array of ResourceDetail structures

A list of objects describing the details of the resources in the template generation.

StackId
Type: string

The stack ARN of the base stack if a base stack was provided when generating the template.

Status
Type: string

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

StatusReason
Type: string

The reason for the current template generation status. This will provide more details if a failure happened.

TemplateConfiguration
Type: TemplateConfiguration structure

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

TotalWarnings
Type: int

The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

Errors

GeneratedTemplateNotFoundException:

The generated template was not found.

Examples

Example 1: To describe a generated template

This example describes a generated template

$result = $client->describeGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
]);

Result syntax:

[
    'CreationTime' => ,
    'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:*:generatedtemplate/*',
    'GeneratedTemplateName' => 'DeletedResourceTest',
    'LastUpdatedTime' => ,
    'Progress' => [
        'ResourcesFailed' => 0,
        'ResourcesPending' => 0,
        'ResourcesProcessing' => 0,
        'ResourcesSucceeded' => 0,
    ],
    'Status' => 'COMPLETE',
    'StatusReason' => 'All resources complete',
    'TemplateConfiguration' => [
        'DeletionPolicy' => 'RETAIN',
        'UpdateReplacePolicy' => 'RETAIN',
    ],
    'TotalWarnings' => 0,
]

DescribeOrganizationsAccess

$result = $client->describeOrganizationsAccess([/* ... */]);
$promise = $client->describeOrganizationsAccessAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeOrganizationsAccess([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Result Syntax

[
    'Status' => 'ENABLED|DISABLED|DISABLED_PERMANENTLY',
]

Result Details

Members
Status
Type: string

Presents the status of the OrganizationAccess.

Errors

InvalidOperationException:

The specified operation isn't valid.

OperationNotFoundException:

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

DescribePublisher

$result = $client->describePublisher([/* ... */]);
$promise = $client->describePublisherAsync([/* ... */]);

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:

Parameter Syntax

$result = $client->describePublisher([
    'PublisherId' => '<string>',
]);

Parameter Details

Members
PublisherId
Type: string

The ID of the 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.

Result Syntax

[
    'IdentityProvider' => 'AWS_Marketplace|GitHub|Bitbucket',
    'PublisherId' => '<string>',
    'PublisherProfile' => '<string>',
    'PublisherStatus' => 'VERIFIED|UNVERIFIED',
]

Result Details

Members
IdentityProvider
Type: string

The type of account used as the identity provider when registering this publisher with CloudFormation.

PublisherId
Type: string

The ID of the extension publisher.

PublisherProfile
Type: string

The URL to the publisher's profile with the identity provider.

PublisherStatus
Type: string

Whether the publisher is verified. Currently, all registered publishers are verified.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

DescribeResourceScan

$result = $client->describeResourceScan([/* ... */]);
$promise = $client->describeResourceScanAsync([/* ... */]);

Describes details of a resource scan.

Parameter Syntax

$result = $client->describeResourceScan([
    'ResourceScanId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceScanId
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource scan.

Result Syntax

[
    'EndTime' => <DateTime>,
    'PercentageCompleted' => <float>,
    'ResourceScanId' => '<string>',
    'ResourceTypes' => ['<string>', ...],
    'ResourcesRead' => <integer>,
    'ResourcesScanned' => <integer>,
    'StartTime' => <DateTime>,
    'Status' => 'IN_PROGRESS|FAILED|COMPLETE|EXPIRED',
    'StatusReason' => '<string>',
]

Result Details

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was finished.

PercentageCompleted
Type: double

The percentage of the resource scan that has been completed.

ResourceScanId
Type: string

The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

ResourceTypes
Type: Array of strings

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

ResourcesRead
Type: int

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

ResourcesScanned
Type: int

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was started.

Status
Type: string

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

StatusReason
Type: string

The reason for the resource scan status, providing more information if a failure happened.

Errors

ResourceScanNotFoundException:

The resource scan was not found.

Examples

Example 1: To describe a selected resource scan

This example describes a selected resource scan

$result = $client->describeResourceScan([
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
]);

Result syntax:

[
    'EndTime' => ,
    'PercentageCompleted' => 100,
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
    'ResourceTypes' => [
        'AWS::Amplify::App',
        'AWS::ApiGateway::Deployment',
        'AWS::ApiGateway::DocumentationPart',
        'AWS::ApiGateway::Model',
        'AWS::ApiGateway::Resource',
        'AWS::ApiGateway::RestApi',
        'AWS::ApiGateway::Stage',
        'AWS::AppConfig::Extension',
        'AWS::ApplicationAutoScaling::ScalableTarget',
        'AWS::Athena::WorkGroup',
        'AWS::Cassandra::Keyspace',
        'AWS::CloudFront::CachePolicy',
        'AWS::CloudFront::Function',
        'AWS::CloudFront::OriginRequestPolicy',
        'AWS::CloudTrail::Trail',
        'AWS::CloudWatch::Alarm',
        'AWS::CodeDeploy::Application',
        'AWS::CodeDeploy::DeploymentConfig',
        'AWS::Cognito::UserPool',
        'AWS::Cognito::UserPoolGroup',
        'AWS::Cognito::UserPoolUser',
        'AWS::DynamoDB::Table',
        'AWS::EC2::DHCPOptions',
        'AWS::EC2::EIP',
        'AWS::EC2::InternetGateway',
        'AWS::EC2::LaunchTemplate',
        'AWS::EC2::NetworkAcl',
        'AWS::EC2::Route',
        'AWS::EC2::RouteTable',
        'AWS::EC2::SubnetNetworkAclAssociation',
        'AWS::EC2::SubnetRouteTableAssociation',
        'AWS::EC2::VPC',
        'AWS::EC2::VPCDHCPOptionsAssociation',
        'AWS::EC2::VPCGatewayAttachment',
        'AWS::ECR::Repository',
        'AWS::ECS::Cluster',
        'AWS::ECS::ClusterCapacityProviderAssociations',
        'AWS::ECS::Service',
        'AWS::ECS::TaskDefinition',
        'AWS::ElastiCache::SubnetGroup',
        'AWS::ElastiCache::User',
        'AWS::Events::EventBus',
        'AWS::Events::Rule',
        'AWS::GameLift::Location',
        'AWS::GuardDuty::Detector',
        'AWS::IAM::InstanceProfile',
        'AWS::IAM::ManagedPolicy',
        'AWS::IAM::Role',
        'AWS::IAM::User',
        'AWS::IoT::DomainConfiguration',
        'AWS::KMS::Alias',
        'AWS::KMS::Key',
        'AWS::Lambda::EventSourceMapping',
        'AWS::Lambda::Function',
        'AWS::Lambda::Permission',
        'AWS::Lambda::Version',
        'AWS::Logs::LogGroup',
        'AWS::Logs::LogStream',
        'AWS::MemoryDB::ACL',
        'AWS::MemoryDB::ParameterGroup',
        'AWS::MemoryDB::User',
        'AWS::RAM::Permission',
        'AWS::RDS::CustomDBEngineVersion',
        'AWS::Route53Resolver::ResolverRuleAssociation',
        'AWS::S3::AccessPoint',
        'AWS::S3::BucketPolicy',
        'AWS::S3::StorageLens',
        'AWS::SNS::Topic',
        'AWS::SQS::Queue',
        'AWS::SSM::Association',
        'AWS::SSM::Document',
        'AWS::StepFunctions::StateMachine',
        'AWS::XRay::Group',
        'AWS::XRay::SamplingRule',
    ],
    'ResourcesRead' => 25107,
    'StartTime' => ,
    'Status' => 'COMPLETE',
]

DescribeStackDriftDetectionStatus

$result = $client->describeStackDriftDetectionStatus([/* ... */]);
$promise = $client->describeStackDriftDetectionStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStackDriftDetectionStatus([
    'StackDriftDetectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
StackDriftDetectionId
Required: Yes
Type: string

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

Result Syntax

[
    'DetectionStatus' => 'DETECTION_IN_PROGRESS|DETECTION_FAILED|DETECTION_COMPLETE',
    'DetectionStatusReason' => '<string>',
    'DriftedStackResourceCount' => <integer>,
    'StackDriftDetectionId' => '<string>',
    'StackDriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
    'StackId' => '<string>',
    'Timestamp' => <DateTime>,
]

Result Details

Members
DetectionStatus
Required: Yes
Type: string

The status of the stack drift detection operation.

  • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

    If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

  • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

  • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

DetectionStatusReason
Type: string

The reason the stack drift detection operation has its current status.

DriftedStackResourceCount
Type: int

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

StackDriftDetectionId
Required: Yes
Type: string

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

StackDriftStatus
Type: string

Status of the stack's actual configuration compared to its expected configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

StackId
Required: Yes
Type: string

The ID of the stack.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which the stack drift detection operation was initiated.

Errors

There are no errors described for this operation.

DescribeStackEvents

$result = $client->describeStackEvents([/* ... */]);
$promise = $client->describeStackEventsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeStackEvents([
    'NextToken' => '<string>',
    'StackName' => '<string>',
]);

Parameter Details

Members
NextToken
Type: string

A string that identifies the next page of events that you want to retrieve.

StackName
Type: string

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Result Syntax

[
    'NextToken' => '<string>',
    'StackEvents' => [
        [
            'ClientRequestToken' => '<string>',
            'DetailedStatus' => 'CONFIGURATION_COMPLETE|VALIDATION_FAILED',
            'EventId' => '<string>',
            'HookFailureMode' => 'FAIL|WARN',
            'HookInvocationPoint' => 'PRE_PROVISION',
            'HookStatus' => 'HOOK_IN_PROGRESS|HOOK_COMPLETE_SUCCEEDED|HOOK_COMPLETE_FAILED|HOOK_FAILED',
            'HookStatusReason' => '<string>',
            'HookType' => '<string>',
            'LogicalResourceId' => '<string>',
            'PhysicalResourceId' => '<string>',
            'ResourceProperties' => '<string>',
            'ResourceStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|DELETE_SKIPPED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_COMPLETE|IMPORT_FAILED|IMPORT_COMPLETE|IMPORT_IN_PROGRESS|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETE|ROLLBACK_FAILED',
            'ResourceStatusReason' => '<string>',
            'ResourceType' => '<string>',
            'StackId' => '<string>',
            'StackName' => '<string>',
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

StackEvents
Type: Array of StackEvent structures

A list of StackEvents structures.

Errors

There are no errors described for this operation.

DescribeStackInstance

$result = $client->describeStackInstance([/* ... */]);
$promise = $client->describeStackInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStackInstance([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'StackInstanceAccount' => '<string>', // REQUIRED
    'StackInstanceRegion' => '<string>', // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

StackInstanceAccount
Required: Yes
Type: string

The ID of an Amazon Web Services account that's associated with this stack instance.

StackInstanceRegion
Required: Yes
Type: string

The name of a Region that's associated with this stack instance.

StackSetName
Required: Yes
Type: string

The name or the unique stack ID of the stack set that you want to get stack instance information for.

Result Syntax

[
    'StackInstance' => [
        'Account' => '<string>',
        'DriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
        'LastDriftCheckTimestamp' => <DateTime>,
        'LastOperationId' => '<string>',
        'OrganizationalUnitId' => '<string>',
        'ParameterOverrides' => [
            [
                'ParameterKey' => '<string>',
                'ParameterValue' => '<string>',
                'ResolvedValue' => '<string>',
                'UsePreviousValue' => true || false,
            ],
            // ...
        ],
        'Region' => '<string>',
        'StackId' => '<string>',
        'StackInstanceStatus' => [
            'DetailedStatus' => 'PENDING|RUNNING|SUCCEEDED|FAILED|CANCELLED|INOPERABLE|SKIPPED_SUSPENDED_ACCOUNT|FAILED_IMPORT',
        ],
        'StackSetId' => '<string>',
        'Status' => 'CURRENT|OUTDATED|INOPERABLE',
        'StatusReason' => '<string>',
    ],
]

Result Details

Members
StackInstance
Type: StackInstance structure

The stack instance that matches the specified request parameters.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

StackInstanceNotFoundException:

The specified stack instance doesn't exist.

DescribeStackResource

$result = $client->describeStackResource([/* ... */]);
$promise = $client->describeStackResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStackResource([
    'LogicalResourceId' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LogicalResourceId
Required: Yes
Type: string

The logical name of the resource as specified in the template.

Default: There is no default value.

StackName
Required: Yes
Type: string

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Result Syntax

[
    'StackResourceDetail' => [
        'Description' => '<string>',
        'DriftInformation' => [
            'LastCheckTimestamp' => <DateTime>,
            'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
        ],
        'LastUpdatedTimestamp' => <DateTime>,
        'LogicalResourceId' => '<string>',
        'Metadata' => '<string>',
        'ModuleInfo' => [
            'LogicalIdHierarchy' => '<string>',
            'TypeHierarchy' => '<string>',
        ],
        'PhysicalResourceId' => '<string>',
        'ResourceStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|DELETE_SKIPPED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_COMPLETE|IMPORT_FAILED|IMPORT_COMPLETE|IMPORT_IN_PROGRESS|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETE|ROLLBACK_FAILED',
        'ResourceStatusReason' => '<string>',
        'ResourceType' => '<string>',
        'StackId' => '<string>',
        'StackName' => '<string>',
    ],
]

Result Details

Members
StackResourceDetail
Type: StackResourceDetail structure

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

Errors

There are no errors described for this operation.

DescribeStackResourceDrifts

$result = $client->describeStackResourceDrifts([/* ... */]);
$promise = $client->describeStackResourceDriftsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStackResourceDrifts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
    'StackResourceDriftStatusFilters' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

A string that identifies the next page of stack resource drift results.

StackName
Required: Yes
Type: string

The name of the stack for which you want drift information.

StackResourceDriftStatusFilters
Type: Array of strings

The resource drift status values to use as filters for the resource drift results returned.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected template values.

  • IN_SYNC: The resource's actual configuration matches its expected template configuration.

  • NOT_CHECKED: CloudFormation doesn't currently return this value.

Result Syntax

[
    'NextToken' => '<string>',
    'StackResourceDrifts' => [
        [
            'ActualProperties' => '<string>',
            'ExpectedProperties' => '<string>',
            'LogicalResourceId' => '<string>',
            'ModuleInfo' => [
                'LogicalIdHierarchy' => '<string>',
                'TypeHierarchy' => '<string>',
            ],
            'PhysicalResourceId' => '<string>',
            'PhysicalResourceIdContext' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'PropertyDifferences' => [
                [
                    'ActualValue' => '<string>',
                    'DifferenceType' => 'ADD|REMOVE|NOT_EQUAL',
                    'ExpectedValue' => '<string>',
                    'PropertyPath' => '<string>',
                ],
                // ...
            ],
            'ResourceType' => '<string>',
            'StackId' => '<string>',
            'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

StackResourceDrifts
Required: Yes
Type: Array of StackResourceDrift structures

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 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 do not 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.

Errors

There are no errors described for this operation.

DescribeStackResources

$result = $client->describeStackResources([/* ... */]);
$promise = $client->describeStackResourcesAsync([/* ... */]);

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.

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

Parameter Syntax

$result = $client->describeStackResources([
    'LogicalResourceId' => '<string>',
    'PhysicalResourceId' => '<string>',
    'StackName' => '<string>',
]);

Parameter Details

Members
LogicalResourceId
Type: string

The logical name of the resource as specified in the template.

Default: There is no default value.

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you don't specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

StackName
Type: string

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.

Result Syntax

[
    'StackResources' => [
        [
            'Description' => '<string>',
            'DriftInformation' => [
                'LastCheckTimestamp' => <DateTime>,
                'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
            ],
            'LogicalResourceId' => '<string>',
            'ModuleInfo' => [
                'LogicalIdHierarchy' => '<string>',
                'TypeHierarchy' => '<string>',
            ],
            'PhysicalResourceId' => '<string>',
            'ResourceStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|DELETE_SKIPPED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_COMPLETE|IMPORT_FAILED|IMPORT_COMPLETE|IMPORT_IN_PROGRESS|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETE|ROLLBACK_FAILED',
            'ResourceStatusReason' => '<string>',
            'ResourceType' => '<string>',
            'StackId' => '<string>',
            'StackName' => '<string>',
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
StackResources
Type: Array of StackResource structures

A list of StackResource structures.

Errors

There are no errors described for this operation.

DescribeStackSet

$result = $client->describeStackSet([/* ... */]);
$promise = $client->describeStackSetAsync([/* ... */]);

Returns the description of the specified StackSet.

Parameter Syntax

$result = $client->describeStackSet([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set whose description you want.

Result Syntax

[
    'StackSet' => [
        'AdministrationRoleARN' => '<string>',
        'AutoDeployment' => [
            'Enabled' => true || false,
            'RetainStacksOnAccountRemoval' => true || false,
        ],
        'Capabilities' => ['<string>', ...],
        'Description' => '<string>',
        'ExecutionRoleName' => '<string>',
        'ManagedExecution' => [
            'Active' => true || false,
        ],
        'OrganizationalUnitIds' => ['<string>', ...],
        'Parameters' => [
            [
                'ParameterKey' => '<string>',
                'ParameterValue' => '<string>',
                'ResolvedValue' => '<string>',
                'UsePreviousValue' => true || false,
            ],
            // ...
        ],
        'PermissionModel' => 'SERVICE_MANAGED|SELF_MANAGED',
        'Regions' => ['<string>', ...],
        'StackSetARN' => '<string>',
        'StackSetDriftDetectionDetails' => [
            'DriftDetectionStatus' => 'COMPLETED|FAILED|PARTIAL_SUCCESS|IN_PROGRESS|STOPPED',
            'DriftStatus' => 'DRIFTED|IN_SYNC|NOT_CHECKED',
            'DriftedStackInstancesCount' => <integer>,
            'FailedStackInstancesCount' => <integer>,
            'InProgressStackInstancesCount' => <integer>,
            'InSyncStackInstancesCount' => <integer>,
            'LastDriftCheckTimestamp' => <DateTime>,
            'TotalStackInstancesCount' => <integer>,
        ],
        'StackSetId' => '<string>',
        'StackSetName' => '<string>',
        'Status' => 'ACTIVE|DELETED',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TemplateBody' => '<string>',
    ],
]

Result Details

Members
StackSet
Type: StackSet structure

The specified stack set.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

DescribeStackSetOperation

$result = $client->describeStackSetOperation([/* ... */]);
$promise = $client->describeStackSetOperationAsync([/* ... */]);

Returns the description of the specified StackSet operation.

Parameter Syntax

$result = $client->describeStackSetOperation([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'OperationId' => '<string>', // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

OperationId
Required: Yes
Type: string

The unique ID of the stack set operation.

StackSetName
Required: Yes
Type: string

The name or the unique stack ID of the stack set for the stack operation.

Result Syntax

[
    'StackSetOperation' => [
        'Action' => 'CREATE|UPDATE|DELETE|DETECT_DRIFT',
        'AdministrationRoleARN' => '<string>',
        'CreationTimestamp' => <DateTime>,
        'DeploymentTargets' => [
            'AccountFilterType' => 'NONE|INTERSECTION|DIFFERENCE|UNION',
            'Accounts' => ['<string>', ...],
            'AccountsUrl' => '<string>',
            'OrganizationalUnitIds' => ['<string>', ...],
        ],
        'EndTimestamp' => <DateTime>,
        'ExecutionRoleName' => '<string>',
        'OperationId' => '<string>',
        'OperationPreferences' => [
            'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
            'FailureToleranceCount' => <integer>,
            'FailureTolerancePercentage' => <integer>,
            'MaxConcurrentCount' => <integer>,
            'MaxConcurrentPercentage' => <integer>,
            'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
            'RegionOrder' => ['<string>', ...],
        ],
        'RetainStacks' => true || false,
        'StackSetDriftDetectionDetails' => [
            'DriftDetectionStatus' => 'COMPLETED|FAILED|PARTIAL_SUCCESS|IN_PROGRESS|STOPPED',
            'DriftStatus' => 'DRIFTED|IN_SYNC|NOT_CHECKED',
            'DriftedStackInstancesCount' => <integer>,
            'FailedStackInstancesCount' => <integer>,
            'InProgressStackInstancesCount' => <integer>,
            'InSyncStackInstancesCount' => <integer>,
            'LastDriftCheckTimestamp' => <DateTime>,
            'TotalStackInstancesCount' => <integer>,
        ],
        'StackSetId' => '<string>',
        'Status' => 'RUNNING|SUCCEEDED|FAILED|STOPPING|STOPPED|QUEUED',
        'StatusDetails' => [
            'FailedStackInstancesCount' => <integer>,
        ],
        'StatusReason' => '<string>',
    ],
]

Result Details

Members
StackSetOperation
Type: StackSetOperation structure

The specified stack set operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationNotFoundException:

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

DescribeStacks

$result = $client->describeStacks([/* ... */]);
$promise = $client->describeStacksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeStacks([
    'NextToken' => '<string>',
    'StackName' => '<string>',
]);

Parameter Details

Members
NextToken
Type: string

A string that identifies the next page of stacks that you want to retrieve.

StackName
Type: string

If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

Consider using the ListStacks API if you're not passing a parameter to StackName.

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Result Syntax

[
    'NextToken' => '<string>',
    'Stacks' => [
        [
            'Capabilities' => ['<string>', ...],
            'ChangeSetId' => '<string>',
            'CreationTime' => <DateTime>,
            'DeletionMode' => 'STANDARD|FORCE_DELETE_STACK',
            'DeletionTime' => <DateTime>,
            'Description' => '<string>',
            'DetailedStatus' => 'CONFIGURATION_COMPLETE|VALIDATION_FAILED',
            'DisableRollback' => true || false,
            'DriftInformation' => [
                'LastCheckTimestamp' => <DateTime>,
                'StackDriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
            ],
            'EnableTerminationProtection' => true || false,
            'LastUpdatedTime' => <DateTime>,
            'NotificationARNs' => ['<string>', ...],
            'Outputs' => [
                [
                    'Description' => '<string>',
                    'ExportName' => '<string>',
                    'OutputKey' => '<string>',
                    'OutputValue' => '<string>',
                ],
                // ...
            ],
            'Parameters' => [
                [
                    'ParameterKey' => '<string>',
                    'ParameterValue' => '<string>',
                    'ResolvedValue' => '<string>',
                    'UsePreviousValue' => true || false,
                ],
                // ...
            ],
            'ParentId' => '<string>',
            'RetainExceptOnCreate' => true || false,
            'RoleARN' => '<string>',
            'RollbackConfiguration' => [
                'MonitoringTimeInMinutes' => <integer>,
                'RollbackTriggers' => [
                    [
                        'Arn' => '<string>',
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'RootId' => '<string>',
            'StackId' => '<string>',
            'StackName' => '<string>',
            'StackStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|ROLLBACK_IN_PROGRESS|ROLLBACK_FAILED|ROLLBACK_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|UPDATE_IN_PROGRESS|UPDATE_COMPLETE_CLEANUP_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_FAILED|UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|REVIEW_IN_PROGRESS|IMPORT_IN_PROGRESS|IMPORT_COMPLETE|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE',
            'StackStatusReason' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TimeoutInMinutes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Stacks
Type: Array of Stack structures

A list of stack structures.

Errors

There are no errors described for this operation.

DescribeType

$result = $client->describeType([/* ... */]);
$promise = $client->describeTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeType([
    'Arn' => '<string>',
    'PublicVersionNumber' => '<string>',
    'PublisherId' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

PublicVersionNumber
Type: string

The version number of a public third-party extension.

PublisherId
Type: string

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

Type
Type: string

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName
Type: string

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

VersionId
Type: string

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

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

Result Syntax

[
    'Arn' => '<string>',
    'AutoUpdate' => true || false,
    'ConfigurationSchema' => '<string>',
    'DefaultVersionId' => '<string>',
    'DeprecatedStatus' => 'LIVE|DEPRECATED',
    'Description' => '<string>',
    'DocumentationUrl' => '<string>',
    'ExecutionRoleArn' => '<string>',
    'IsActivated' => true || false,
    'IsDefaultVersion' => true || false,
    'LastUpdated' => <DateTime>,
    'LatestPublicVersion' => '<string>',
    'LoggingConfig' => [
        'LogGroupName' => '<string>',
        'LogRoleArn' => '<string>',
    ],
    'OriginalTypeArn' => '<string>',
    'OriginalTypeName' => '<string>',
    'ProvisioningType' => 'NON_PROVISIONABLE|IMMUTABLE|FULLY_MUTABLE',
    'PublicVersionNumber' => '<string>',
    'PublisherId' => '<string>',
    'RequiredActivatedTypes' => [
        [
            'OriginalTypeName' => '<string>',
            'PublisherId' => '<string>',
            'SupportedMajorVersions' => [<integer>, ...],
            'TypeNameAlias' => '<string>',
        ],
        // ...
    ],
    'Schema' => '<string>',
    'SourceUrl' => '<string>',
    'TimeCreated' => <DateTime>,
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'TypeTestsStatus' => 'PASSED|FAILED|IN_PROGRESS|NOT_TESTED',
    'TypeTestsStatusDescription' => '<string>',
    'Visibility' => 'PUBLIC|PRIVATE',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

AutoUpdate
Type: boolean

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

ConfigurationSchema
Type: string

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

DefaultVersionId
Type: string

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion.

DeprecatedStatus
Type: string

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

Description
Type: string

The description of the extension.

DocumentationUrl
Type: string

The URL of a page providing detailed documentation for this extension.

ExecutionRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

IsActivated
Type: boolean

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

IsDefaultVersion
Type: boolean

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType.

  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

LatestPublicVersion
Type: string

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

LoggingConfig
Type: LoggingConfig structure

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

OriginalTypeArn
Type: string

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

OriginalTypeName
Type: string

For public extensions that have been activated for this account and Region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

ProvisioningType
Type: string

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

    • create

    • read

    • delete

PublicVersionNumber
Type: string

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

PublisherId
Type: string

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

RequiredActivatedTypes
Type: Array of RequiredActivatedType structures

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

Schema
Type: string

The schema that defines the extension.

For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

SourceUrl
Type: string

The URL of the source code for the extension.

TimeCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the specified private extension version was registered or activated in your account.

Type
Type: string

The kind of extension.

TypeName
Type: string

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

TypeTestsStatus
Type: string

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

    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 Command Line Interface User Guide.

  • FAILED: The extension has failed one or more contract tests.

  • IN_PROGRESS: Contract tests are currently being performed on the extension.

  • NOT_TESTED: Contract tests haven't been performed on the extension.

TypeTestsStatusDescription
Type: string

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

Visibility
Type: string

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

DescribeTypeRegistration

$result = $client->describeTypeRegistration([/* ... */]);
$promise = $client->describeTypeRegistrationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeTypeRegistration([
    'RegistrationToken' => '<string>', // REQUIRED
]);

Parameter Details

Members
RegistrationToken
Required: Yes
Type: string

The identifier for this registration request.

This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

Result Syntax

[
    'Description' => '<string>',
    'ProgressStatus' => 'COMPLETE|IN_PROGRESS|FAILED',
    'TypeArn' => '<string>',
    'TypeVersionArn' => '<string>',
]

Result Details

Members
Description
Type: string

The description of the extension registration request.

ProgressStatus
Type: string

The current status of the extension registration request.

TypeArn
Type: string

The Amazon Resource Name (ARN) of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

TypeVersionArn
Type: string

The Amazon Resource Name (ARN) of this specific version of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

DetectStackDrift

$result = $client->detectStackDrift([/* ... */]);
$promise = $client->detectStackDriftAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detectStackDrift([
    'LogicalResourceIds' => ['<string>', ...],
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LogicalResourceIds
Type: Array of strings

The logical names of any resources you want to use as filters.

StackName
Required: Yes
Type: string

The name of the stack for which you want to detect drift.

Result Syntax

[
    'StackDriftDetectionId' => '<string>',
]

Result Details

Members
StackDriftDetectionId
Required: Yes
Type: string

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

Errors

There are no errors described for this operation.

DetectStackResourceDrift

$result = $client->detectStackResourceDrift([/* ... */]);
$promise = $client->detectStackResourceDriftAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detectStackResourceDrift([
    'LogicalResourceId' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
LogicalResourceId
Required: Yes
Type: string

The logical name of the resource for which to return drift information.

StackName
Required: Yes
Type: string

The name of the stack to which the resource belongs.

Result Syntax

[
    'StackResourceDrift' => [
        'ActualProperties' => '<string>',
        'ExpectedProperties' => '<string>',
        'LogicalResourceId' => '<string>',
        'ModuleInfo' => [
            'LogicalIdHierarchy' => '<string>',
            'TypeHierarchy' => '<string>',
        ],
        'PhysicalResourceId' => '<string>',
        'PhysicalResourceIdContext' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'PropertyDifferences' => [
            [
                'ActualValue' => '<string>',
                'DifferenceType' => 'ADD|REMOVE|NOT_EQUAL',
                'ExpectedValue' => '<string>',
                'PropertyPath' => '<string>',
            ],
            // ...
        ],
        'ResourceType' => '<string>',
        'StackId' => '<string>',
        'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
        'Timestamp' => <DateTime>,
    ],
]

Result Details

Members
StackResourceDrift
Required: Yes
Type: StackResourceDrift structure

Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

Errors

There are no errors described for this operation.

DetectStackSetDrift

$result = $client->detectStackSetDrift([/* ... */]);
$promise = $client->detectStackSetDriftAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->detectStackSetDrift([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

OperationId
Type: string

The ID of the stack set operation.

OperationPreferences

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.

StackSetName
Required: Yes
Type: string

The name of the stack set on which to perform the drift detection operation.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The ID of the drift detection stack set operation.

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

Errors

InvalidOperationException:

The specified operation isn't valid.

OperationInProgressException:

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

StackSetNotFoundException:

The specified stack set doesn't exist.

EstimateTemplateCost

$result = $client->estimateTemplateCost([/* ... */]);
$promise = $client->estimateTemplateCostAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->estimateTemplateCost([
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
]);

Parameter Details

Members
Parameters
Type: Array of Parameter structures

A list of Parameter structures that specify input parameters.

TemplateBody
Type: string

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

TemplateURL
Type: string

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Result Syntax

[
    'Url' => '<string>',
]

Result Details

Members
Url
Type: string

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Errors

There are no errors described for this operation.

ExecuteChangeSet

$result = $client->executeChangeSet([/* ... */]);
$promise = $client->executeChangeSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->executeChangeSet([
    'ChangeSetName' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'DisableRollback' => true || false,
    'RetainExceptOnCreate' => true || false,
    'StackName' => '<string>',
]);

Parameter Details

Members
ChangeSetName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

ClientRequestToken
Type: string

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

DisableRollback
Type: boolean

Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

  • True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

  • False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

Default: True

RetainExceptOnCreate
Type: boolean

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

StackName
Type: string

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidChangeSetStatusException:

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.

ChangeSetNotFoundException:

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

InsufficientCapabilitiesException:

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

TokenAlreadyExistsException:

A client request token already exists.

GetGeneratedTemplate

$result = $client->getGeneratedTemplate([/* ... */]);
$promise = $client->getGeneratedTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getGeneratedTemplate([
    'Format' => 'JSON|YAML',
    'GeneratedTemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Format
Type: string

The language to use to retrieve for the generated template. Supported values are:

  • JSON

  • YAML

GeneratedTemplateName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

Result Syntax

[
    'Status' => 'CREATE_PENDING|UPDATE_PENDING|DELETE_PENDING|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|FAILED|COMPLETE',
    'TemplateBody' => '<string>',
]

Result Details

Members
Status
Type: string

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

TemplateBody
Type: string

The template body of the generated template, in the language specified by the Language parameter.

Errors

GeneratedTemplateNotFoundException:

The generated template was not found.

Examples

Example 1: To get a generated template in JSON format

This example gets a generated template ins JSON format.

$result = $client->getGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
]);

Result syntax:

[
    'Status' => 'COMPLETE',
    'TemplateBody' => '{"Metadata":{"TemplateId":"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*"},"Parameters":{"Stage":{"Default":"beta","Type":"String"}},"Resources":{"TestRole":{"Properties":{"AssumeRolePolicyDocument":{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":{"Fn::Sub":["arn:${AWS::Partition}:iam::${AccountId}:root",{"AccountId":{"Fn::AccountIdFromAlias":"test-account-alias"}}]}},"Action":"sts:AssumeRole"}]}},"Type":"AWS::IAM::Role","DeletionPolicy":"Delete"},"DocumentationPartl7ob4vsd76vs":{"UpdateReplacePolicy":"Retain","Type":"AWS::ApiGateway::DocumentationPart","DeletionPolicy":"Retain","Properties":{"RestApiId":"l7ob4vsd76","Properties":"{\n \"description\" : \"ListGeneratedTemplates 200 response\"\n}","Location":{"Path":"/ListGeneratedTemplates","Type":"RESPONSE","Method":"POST","StatusCode":"200"}}}}}',
]
Example 2: To get a generated template in YAML format

This example gets a generated template in YAML format.

$result = $client->getGeneratedTemplate([
    'Format' => 'YAML',
    'GeneratedTemplateName' => 'JazzyTemplate',
]);

Result syntax:

[
    'Status' => 'COMPLETE',
    'TemplateBody' => '---Metadata: TemplateId: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*"Parameters: Stage: Default: "beta" Type: "String"Resources: TestRole: Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Principal: AWS: Fn::Sub: - "arn:${AWS::Partition}:iam::${AccountId}:root" - AccountId: Fn::AccountIdFromAlias: "test-account-alias" Action: "sts:AssumeRole" Type: "AWS::IAM::Role" DeletionPolicy: "Delete" DocumentationPartl7ob4vsd76vsnAlFMLXKVm: UpdateReplacePolicy: "Retain" Type: "AWS::ApiGateway::DocumentationPart" DeletionPolicy: "Retain" Properties: RestApiId: "l7ob4vsd76" Properties: "{\n \"description\" : \"ListGeneratedTemplates 200 response\"\n\ }" Location: Path: "/ListGeneratedTemplates" Type: "RESPONSE" Method: "POST" StatusCode: "200"',
]

GetStackPolicy

$result = $client->getStackPolicy([/* ... */]);
$promise = $client->getStackPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getStackPolicy([
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
StackName
Required: Yes
Type: string

The name or unique stack ID that's associated with the stack whose policy you want to get.

Result Syntax

[
    'StackPolicyBody' => '<string>',
]

Result Details

Members
StackPolicyBody
Type: string

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide.)

Errors

There are no errors described for this operation.

GetTemplate

$result = $client->getTemplate([/* ... */]);
$promise = $client->getTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTemplate([
    'ChangeSetName' => '<string>',
    'StackName' => '<string>',
    'TemplateStage' => 'Original|Processed',
]);

Parameter Details

Members
ChangeSetName
Type: string

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

StackName
Type: string

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

TemplateStage
Type: string

For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, CloudFormation specifies Processed.

Result Syntax

[
    'StagesAvailable' => ['<string>', ...],
    'TemplateBody' => '<string>',
]

Result Details

Members
StagesAvailable
Type: Array of strings

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

TemplateBody
Type: string

Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

CloudFormation returns the same template that was used when the stack was created.

Errors

ChangeSetNotFoundException:

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

GetTemplateSummary

$result = $client->getTemplateSummary([/* ... */]);
$promise = $client->getTemplateSummaryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getTemplateSummary([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'StackName' => '<string>',
    'StackSetName' => '<string>',
    'TemplateBody' => '<string>',
    'TemplateSummaryConfig' => [
        'TreatUnrecognizedResourceTypesAsWarnings' => true || false,
    ],
    'TemplateURL' => '<string>',
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

StackName
Type: string

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

StackSetName
Type: string

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

TemplateBody
Type: string

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

TemplateSummaryConfig
Type: TemplateSummaryConfig structure

Specifies options for the GetTemplateSummary API action.

TemplateURL
Type: string

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Result Syntax

[
    'Capabilities' => ['<string>', ...],
    'CapabilitiesReason' => '<string>',
    'DeclaredTransforms' => ['<string>', ...],
    'Description' => '<string>',
    'Metadata' => '<string>',
    'Parameters' => [
        [
            'DefaultValue' => '<string>',
            'Description' => '<string>',
            'NoEcho' => true || false,
            'ParameterConstraints' => [
                'AllowedValues' => ['<string>', ...],
            ],
            'ParameterKey' => '<string>',
            'ParameterType' => '<string>',
        ],
        // ...
    ],
    'ResourceIdentifierSummaries' => [
        [
            'LogicalResourceIds' => ['<string>', ...],
            'ResourceIdentifiers' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'ResourceTypes' => ['<string>', ...],
    'Version' => '<string>',
    'Warnings' => [
        'UnrecognizedResourceTypes' => ['<string>', ...],
    ],
]

Result Details

Members
Capabilities
Type: Array of strings

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

CapabilitiesReason
Type: string

The list of resources that generated the values in the Capabilities response element.

DeclaredTransforms
Type: Array of strings

A list of the transforms that are declared in the template.

Description
Type: string

The value that's defined in the Description property of the template.

Metadata
Type: string

The value that's defined for the Metadata property of the template.

Parameters
Type: Array of ParameterDeclaration structures

A list of parameter declarations that describe various properties for each parameter.

ResourceIdentifierSummaries
Type: Array of ResourceIdentifierSummary structures

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

ResourceTypes
Type: Array of strings

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Version
Type: string

The Amazon Web Services template format version, which identifies the capabilities of the template.

Warnings
Type: Warnings structure

An object containing any warnings returned.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

ImportStacksToStackSet

$result = $client->importStacksToStackSet([/* ... */]);
$promise = $client->importStacksToStackSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->importStacksToStackSet([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'OrganizationalUnitIds' => ['<string>', ...],
    'StackIds' => ['<string>', ...],
    'StackIdsUrl' => '<string>',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • For service managed stack sets, specify DELEGATED_ADMIN.

OperationId
Type: string

A unique, user defined, identifier for the stack set operation.

OperationPreferences

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.

OrganizationalUnitIds
Type: Array of strings

The list of OU ID's to which the stacks being imported has to be mapped as deployment target.

StackIds
Type: Array of strings

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.

Specify either StackIds or StackIdsUrl.

StackIdsUrl
Type: string

The Amazon S3 URL which contains list of stack ids to be inputted.

Specify either StackIds or StackIdsUrl.

StackSetName
Required: Yes
Type: string

The name of the stack set. The name must be unique in the Region where you create your stack set.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The unique identifier for the stack set operation.

Errors

LimitExceededException:

The quota for the resource has already been reached.

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

StackSetNotFoundException:

The specified stack set doesn't exist.

InvalidOperationException:

The specified operation isn't valid.

OperationInProgressException:

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

OperationIdAlreadyExistsException:

The specified operation ID already exists.

StackNotFoundException:

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

StaleRequestException:

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

ListChangeSets

$result = $client->listChangeSets([/* ... */]);
$promise = $client->listChangeSetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listChangeSets([
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
NextToken
Type: string

A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

StackName
Required: Yes
Type: string

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'ChangeSetId' => '<string>',
            'ChangeSetName' => '<string>',
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'ExecutionStatus' => 'UNAVAILABLE|AVAILABLE|EXECUTE_IN_PROGRESS|EXECUTE_COMPLETE|EXECUTE_FAILED|OBSOLETE',
            'ImportExistingResources' => true || false,
            'IncludeNestedStacks' => true || false,
            'ParentChangeSetId' => '<string>',
            'RootChangeSetId' => '<string>',
            'StackId' => '<string>',
            'StackName' => '<string>',
            'Status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|FAILED',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

Summaries
Type: Array of ChangeSetSummary structures

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

Errors

There are no errors described for this operation.

ListExports

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listExports([
    'NextToken' => '<string>',
]);

Parameter Details

Members
NextToken
Type: string

A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

Result Syntax

[
    'Exports' => [
        [
            'ExportingStackId' => '<string>',
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Exports
Type: Array of Export structures

The output for the ListExports action.

NextToken
Type: string

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

Errors

There are no errors described for this operation.

ListGeneratedTemplates

$result = $client->listGeneratedTemplates([/* ... */]);
$promise = $client->listGeneratedTemplatesAsync([/* ... */]);

Lists your generated templates in this Region.

Parameter Syntax

$result = $client->listGeneratedTemplates([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.

NextToken
Type: string

A string that identifies the next page of resource scan results.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'CreationTime' => <DateTime>,
            'GeneratedTemplateId' => '<string>',
            'GeneratedTemplateName' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'NumberOfResources' => <integer>,
            'Status' => 'CREATE_PENDING|UPDATE_PENDING|DELETE_PENDING|CREATE_IN_PROGRESS|UPDATE_IN_PROGRESS|DELETE_IN_PROGRESS|FAILED|COMPLETE',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Summaries
Type: Array of TemplateSummary structures

A list of summaries of the generated templates.

Errors

There are no errors described for this operation.

Examples

Example 1: To list generated templates

This example lists the generated templates.

$result = $client->listGeneratedTemplates([
]);

Result syntax:

[
    'Summaries' => [
        [
            'CreationTime' => ,
            'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/abcdefghi-1234-abcd-abcd-abcdefgh1234567',
            'GeneratedTemplateName' => 'Template3',
            'LastUpdatedTime' => ,
            'NumberOfResources' => 85,
            'Status' => 'COMPLETE',
            'StatusReason' => 'All resources complete',
        ],
        [
            'CreationTime' => ,
            'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/bbcdefghi-1234-abcd-abcd-abcdefgh1234567',
            'GeneratedTemplateName' => 'Template2',
            'LastUpdatedTime' => ,
            'NumberOfResources' => 12,
            'Status' => 'COMPLETE',
            'StatusReason' => 'All resources complete',
        ],
        [
            'CreationTime' => ,
            'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/cbcdefghi-1234-abcd-abcd-abcdefgh1234567',
            'GeneratedTemplateName' => 'Template1',
            'LastUpdatedTime' => ,
            'NumberOfResources' => 19,
            'Status' => 'COMPLETE',
            'StatusReason' => 'All resources complete',
        ],
    ],
]

ListImports

$result = $client->listImports([/* ... */]);
$promise = $client->listImportsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listImports([
    'ExportName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members
ExportName
Required: Yes
Type: string

The name of the exported output value. CloudFormation returns the stack names that are importing this value.

NextToken
Type: string

A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

Result Syntax

[
    'Imports' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
Imports
Type: Array of strings

A list of stack names that are importing the specified exported output value.

NextToken
Type: string

A string that identifies the next page of exports. If there is no additional page, this value is null.

Errors

There are no errors described for this operation.

ListResourceScanRelatedResources

$result = $client->listResourceScanRelatedResources([/* ... */]);
$promise = $client->listResourceScanRelatedResourcesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listResourceScanRelatedResources([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceScanId' => '<string>', // REQUIRED
    'Resources' => [ // REQUIRED
        [
            'ResourceIdentifier' => ['<string>', ...], // REQUIRED
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
MaxResults
Type: int

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum value is 100.

NextToken
Type: string

A string that identifies the next page of resource scan results.

ResourceScanId
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource scan.

Resources
Required: Yes
Type: Array of ScannedResourceIdentifier structures

The list of resources for which you want to get the related resources. Up to 100 resources can be provided.

Result Syntax

[
    'NextToken' => '<string>',
    'RelatedResources' => [
        [
            'ManagedByStack' => true || false,
            'ResourceIdentifier' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

RelatedResources
Type: Array of ScannedResource structures

List of up to MaxResults resources in the specified resource scan related to the specified resources.

Errors

ResourceScanNotFoundException:

The resource scan was not found.

ResourceScanInProgressException:

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

Examples

Example 1: To list resource scan related resources

This example lists the resources related to the passed in resources

$result = $client->listResourceScanRelatedResources([
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
    'Resources' => [
        [
            'ResourceIdentifier' => [
                'BucketName' => 'jazz-bucket',
            ],
            'ResourceType' => 'AWS::S3::Bucket',
        ],
        [
            'ResourceIdentifier' => [
                'DhcpOptionsId' => 'random-id123',
            ],
            'ResourceType' => 'AWS::EC2::DHCPOptions',
        ],
    ],
]);

Result syntax:

[
    'RelatedResources' => [
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'DhcpOptionsId' => 'dopt-98765edcba',
                'VpcId' => 'vpc-0123456abcdefg',
            ],
            'ResourceType' => 'AWS::EC2::VPCDHCPOptionsAssociation',
        ],
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'VpcId' => 'vpc-0123456abcdefgabc',
            ],
            'ResourceType' => 'AWS::EC2::VPC',
        ],
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'DhcpOptionsId' => 'dopt-98765edcba',
                'VpcId' => 'vpc-123456abcdef',
            ],
            'ResourceType' => 'AWS::EC2::VPCDHCPOptionsAssociation',
        ],
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'VpcId' => 'vpc-12345678abcd',
            ],
            'ResourceType' => 'AWS::EC2::VPC',
        ],
    ],
]

ListResourceScanResources

$result = $client->listResourceScanResources([/* ... */]);
$promise = $client->listResourceScanResourcesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listResourceScanResources([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceIdentifier' => '<string>',
    'ResourceScanId' => '<string>', // REQUIRED
    'ResourceTypePrefix' => '<string>',
    'TagKey' => '<string>',
    'TagValue' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.

NextToken
Type: string

A string that identifies the next page of resource scan results.

ResourceIdentifier
Type: string

If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).

ResourceScanId
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource scan.

ResourceTypePrefix
Type: string

If specified, the returned resources will be of any of the resource types with the specified prefix.

TagKey
Type: string

If specified, the returned resources will have a matching tag key.

TagValue
Type: string

If specified, the returned resources will have a matching tag value.

Result Syntax

[
    'NextToken' => '<string>',
    'Resources' => [
        [
            'ManagedByStack' => true || false,
            'ResourceIdentifier' => ['<string>', ...],
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Resources
Type: Array of ScannedResource structures

List of up to MaxResults resources in the specified resource scan that match all of the specified filters.

Errors

ResourceScanNotFoundException:

The resource scan was not found.

ResourceScanInProgressException:

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

Examples

Example 1: To list the resources in your resource scan

This example lists the resources in your resource scan

$result = $client->listResourceScanResources([
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
]);

Result syntax:

[
    'NextToken' => 'AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=',
    'Resources' => [
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'Arn' => 'arn:aws:amplify:us-east-1:123456789012:apps/12345678',
            ],
            'ResourceType' => 'AWS::Amplify::App',
        ],
        [
            'ManagedByStack' => 1,
            'ResourceIdentifier' => [
                'DeploymentId' => '1234567',
                'RestApiId' => 'abcdefgh',
            ],
            'ResourceType' => 'AWS::ApiGateway::Deployment',
        ],
    ],
]
Example 2: To list the resources in your resource scan for specific resource type

This example lists the resources in your resource scan filtering only the resources that start with the passed in prefix

$result = $client->listResourceScanResources([
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
    'ResourceTypePrefix' => 'AWS::S3',
]);

Result syntax:

[
    'NextToken' => 'AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=',
    'Resources' => [
        [
            'ManagedByStack' => 1,
            'ResourceIdentifier' => [
                'Name' => 'test-access-point',
            ],
            'ResourceType' => 'AWS::S3::AccessPoint',
        ],
        [
            'ManagedByStack' => ,
            'ResourceIdentifier' => [
                'Bucket' => 'a-random-bucket',
            ],
            'ResourceType' => 'AWS::S3::BucketPolicy',
        ],
    ],
]

ListResourceScans

$result = $client->listResourceScans([/* ... */]);
$promise = $client->listResourceScansAsync([/* ... */]);

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

Parameter Syntax

$result = $client->listResourceScans([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.

NextToken
Type: string

A string that identifies the next page of resource scan results.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceScanSummaries' => [
        [
            'EndTime' => <DateTime>,
            'PercentageCompleted' => <float>,
            'ResourceScanId' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => 'IN_PROGRESS|FAILED|COMPLETE|EXPIRED',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

ResourceScanSummaries
Type: Array of ResourceScanSummary structures

The list of scans returned.

Errors

There are no errors described for this operation.

Examples

Example 1: Listing Resource Scans

This example shows how to list resource scans

$result = $client->listResourceScans([
]);

Result syntax:

[
    'ResourceScanSummaries' => [
        [
            'PercentageCompleted' => 37.4,
            'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/51448627-817f-40f0-b37c-f6e0f974340c',
            'StartTime' => ,
            'Status' => 'IN_PROGRESS',
        ],
        [
            'EndTime' => ,
            'PercentageCompleted' => 100,
            'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1',
            'StartTime' => ,
            'Status' => 'COMPLETE',
        ],
    ],
]

ListStackInstanceResourceDrifts

$result = $client->listStackInstanceResourceDrifts([/* ... */]);
$promise = $client->listStackInstanceResourceDriftsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listStackInstanceResourceDrifts([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperationId' => '<string>', // REQUIRED
    'StackInstanceAccount' => '<string>', // REQUIRED
    'StackInstanceRegion' => '<string>', // REQUIRED
    'StackInstanceResourceDriftStatuses' => ['<string>', ...],
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

OperationId
Required: Yes
Type: string

The unique ID of the drift operation.

StackInstanceAccount
Required: Yes
Type: string

The name of the Amazon Web Services account that you want to list resource drifts for.

StackInstanceRegion
Required: Yes
Type: string

The name of the Region where you want to list resource drifts.

StackInstanceResourceDriftStatuses
Type: Array of strings

The resource drift status of the stack instance.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected template values.

  • IN_SYNC: The resource's actual configuration matches its expected template configuration.

  • NOT_CHECKED: CloudFormation doesn't currently return this value.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to list drifted resources for.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'LogicalResourceId' => '<string>',
            'PhysicalResourceId' => '<string>',
            'PhysicalResourceIdContext' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'PropertyDifferences' => [
                [
                    'ActualValue' => '<string>',
                    'DifferenceType' => 'ADD|REMOVE|NOT_EQUAL',
                    'ExpectedValue' => '<string>',
                    'PropertyPath' => '<string>',
                ],
                // ...
            ],
            'ResourceType' => '<string>',
            'StackId' => '<string>',
            'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Summaries
Type: Array of StackInstanceResourceDriftsSummary structures

A list of StackInstanceResourceDriftsSummary structures that contain information about the specified stack instances.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

StackInstanceNotFoundException:

The specified stack instance doesn't exist.

OperationNotFoundException:

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

ListStackInstances

$result = $client->listStackInstances([/* ... */]);
$promise = $client->listStackInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listStackInstances([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'Filters' => [
        [
            'Name' => 'DETAILED_STATUS|LAST_OPERATION_ID|DRIFT_STATUS',
            'Values' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackInstanceAccount' => '<string>',
    'StackInstanceRegion' => '<string>',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Filters
Type: Array of StackInstanceFilter structures

The filter to apply to stack instances

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

StackInstanceAccount
Type: string

The name of the Amazon Web Services account that you want to list stack instances for.

StackInstanceRegion
Type: string

The name of the Region where you want to list stack instances.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to list stack instances for.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'Account' => '<string>',
            'DriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
            'LastDriftCheckTimestamp' => <DateTime>,
            'LastOperationId' => '<string>',
            'OrganizationalUnitId' => '<string>',
            'Region' => '<string>',
            'StackId' => '<string>',
            'StackInstanceStatus' => [
                'DetailedStatus' => 'PENDING|RUNNING|SUCCEEDED|FAILED|CANCELLED|INOPERABLE|SKIPPED_SUSPENDED_ACCOUNT|FAILED_IMPORT',
            ],
            'StackSetId' => '<string>',
            'Status' => 'CURRENT|OUTDATED|INOPERABLE',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Summaries
Type: Array of StackInstanceSummary structures

A list of StackInstanceSummary structures that contain information about the specified stack instances.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

ListStackResources

$result = $client->listStackResources([/* ... */]);
$promise = $client->listStackResourcesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listStackResources([
    'NextToken' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
NextToken
Type: string

A string that identifies the next page of stack resources that you want to retrieve.

StackName
Required: Yes
Type: string

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Result Syntax

[
    'NextToken' => '<string>',
    'StackResourceSummaries' => [
        [
            'DriftInformation' => [
                'LastCheckTimestamp' => <DateTime>,
                'StackResourceDriftStatus' => 'IN_SYNC|MODIFIED|DELETED|NOT_CHECKED',
            ],
            'LastUpdatedTimestamp' => <DateTime>,
            'LogicalResourceId' => '<string>',
            'ModuleInfo' => [
                'LogicalIdHierarchy' => '<string>',
                'TypeHierarchy' => '<string>',
            ],
            'PhysicalResourceId' => '<string>',
            'ResourceStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|DELETE_SKIPPED|UPDATE_IN_PROGRESS|UPDATE_FAILED|UPDATE_COMPLETE|IMPORT_FAILED|IMPORT_COMPLETE|IMPORT_IN_PROGRESS|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|UPDATE_ROLLBACK_FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETE|ROLLBACK_FAILED',
            'ResourceStatusReason' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

StackResourceSummaries
Type: Array of StackResourceSummary structures

A list of StackResourceSummary structures.

Errors

There are no errors described for this operation.

ListStackSetAutoDeploymentTargets

$result = $client->listStackSetAutoDeploymentTargets([/* ... */]);
$promise = $client->listStackSetAutoDeploymentTargetsAsync([/* ... */]);

Returns summary information about deployment targets for a stack set.

Parameter Syntax

$result = $client->listStackSetAutoDeploymentTargets([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

A string that identifies the next page of stack set deployment targets that you want to retrieve.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to get automatic deployment targets for.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'OrganizationalUnitId' => '<string>',
            'Regions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Summaries
Type: Array of StackSetAutoDeploymentTargetSummary structures

An array of summaries of the deployment targets for the stack set.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

ListStackSetOperationResults

$result = $client->listStackSetOperationResults([/* ... */]);
$promise = $client->listStackSetOperationResultsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listStackSetOperationResults([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'Filters' => [
        [
            'Name' => 'OPERATION_RESULT_STATUS',
            'Values' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperationId' => '<string>', // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Filters
Type: Array of OperationResultFilter structures

The filter to apply to operation results.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

OperationId
Required: Yes
Type: string

The ID of the stack set operation.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to get operation results for.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'Account' => '<string>',
            'AccountGateResult' => [
                'Status' => 'SUCCEEDED|FAILED|SKIPPED',
                'StatusReason' => '<string>',
            ],
            'OrganizationalUnitId' => '<string>',
            'Region' => '<string>',
            'Status' => 'PENDING|RUNNING|SUCCEEDED|FAILED|CANCELLED',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Summaries
Type: Array of StackSetOperationResultSummary structures

A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationNotFoundException:

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

ListStackSetOperations

$result = $client->listStackSetOperations([/* ... */]);
$promise = $client->listStackSetOperationsAsync([/* ... */]);

Returns summary information about operations performed on a stack set.

Parameter Syntax

$result = $client->listStackSetOperations([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to get operation summaries for.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'Action' => 'CREATE|UPDATE|DELETE|DETECT_DRIFT',
            'CreationTimestamp' => <DateTime>,
            'EndTimestamp' => <DateTime>,
            'OperationId' => '<string>',
            'OperationPreferences' => [
                'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
                'FailureToleranceCount' => <integer>,
                'FailureTolerancePercentage' => <integer>,
                'MaxConcurrentCount' => <integer>,
                'MaxConcurrentPercentage' => <integer>,
                'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
                'RegionOrder' => ['<string>', ...],
            ],
            'Status' => 'RUNNING|SUCCEEDED|FAILED|STOPPING|STOPPED|QUEUED',
            'StatusDetails' => [
                'FailedStackInstancesCount' => <integer>,
            ],
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Summaries
Type: Array of StackSetOperationSummary structures

A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

ListStackSets

$result = $client->listStackSets([/* ... */]);
$promise = $client->listStackSetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listStackSets([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'ACTIVE|DELETED',
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Status
Type: string

The status of the stack sets that you want to get summary information about.

Result Syntax

[
    'NextToken' => '<string>',
    'Summaries' => [
        [
            'AutoDeployment' => [
                'Enabled' => true || false,
                'RetainStacksOnAccountRemoval' => true || false,
            ],
            'Description' => '<string>',
            'DriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
            'LastDriftCheckTimestamp' => <DateTime>,
            'ManagedExecution' => [
                'Active' => true || false,
            ],
            'PermissionModel' => 'SERVICE_MANAGED|SELF_MANAGED',
            'StackSetId' => '<string>',
            'StackSetName' => '<string>',
            'Status' => 'ACTIVE|DELETED',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Summaries
Type: Array of StackSetSummary structures

A list of StackSetSummary structures that contain information about the user's stack sets.

Errors

There are no errors described for this operation.

ListStacks

$result = $client->listStacks([/* ... */]);
$promise = $client->listStacksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listStacks([
    'NextToken' => '<string>',
    'StackStatusFilter' => ['<string>', ...],
]);

Parameter Details

Members
NextToken
Type: string

A string that identifies the next page of stacks that you want to retrieve.

StackStatusFilter
Type: Array of strings

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Result Syntax

[
    'NextToken' => '<string>',
    'StackSummaries' => [
        [
            'CreationTime' => <DateTime>,
            'DeletionTime' => <DateTime>,
            'DriftInformation' => [
                'LastCheckTimestamp' => <DateTime>,
                'StackDriftStatus' => 'DRIFTED|IN_SYNC|UNKNOWN|NOT_CHECKED',
            ],
            'LastUpdatedTime' => <DateTime>,
            'ParentId' => '<string>',
            'RootId' => '<string>',
            'StackId' => '<string>',
            'StackName' => '<string>',
            'StackStatus' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATE_COMPLETE|ROLLBACK_IN_PROGRESS|ROLLBACK_FAILED|ROLLBACK_COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|UPDATE_IN_PROGRESS|UPDATE_COMPLETE_CLEANUP_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED|UPDATE_ROLLBACK_IN_PROGRESS|UPDATE_ROLLBACK_FAILED|UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS|UPDATE_ROLLBACK_COMPLETE|REVIEW_IN_PROGRESS|IMPORT_IN_PROGRESS|IMPORT_COMPLETE|IMPORT_ROLLBACK_IN_PROGRESS|IMPORT_ROLLBACK_FAILED|IMPORT_ROLLBACK_COMPLETE',
            'StackStatusReason' => '<string>',
            'TemplateDescription' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

StackSummaries
Type: Array of StackSummary structures

A list of StackSummary structures containing information about the specified stacks.

Errors

There are no errors described for this operation.

ListTypeRegistrations

$result = $client->listTypeRegistrations([/* ... */]);
$promise = $client->listTypeRegistrationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTypeRegistrations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegistrationStatusFilter' => 'COMPLETE|IN_PROGRESS|FAILED',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeArn' => '<string>',
    'TypeName' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

RegistrationStatusFilter
Type: string

The current status of the extension registration request.

The default is IN_PROGRESS.

Type
Type: string

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeArn
Type: string

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName
Type: string

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

Result Syntax

[
    'NextToken' => '<string>',
    'RegistrationTokenList' => ['<string>', ...],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

RegistrationTokenList
Type: Array of strings

A list of extension registration tokens.

Use DescribeTypeRegistration to return detailed information about a type registration request.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

ListTypeVersions

$result = $client->listTypeVersions([/* ... */]);
$promise = $client->listTypeVersionsAsync([/* ... */]);

Returns summary information about the versions of an extension.

Parameter Syntax

$result = $client->listTypeVersions([
    'Arn' => '<string>',
    'DeprecatedStatus' => 'LIVE|DEPRECATED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PublisherId' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

Conditional: You must specify either TypeName and Type, or Arn.

DeprecatedStatus
Type: string

The deprecation status of the extension versions that you want to get summary information about.

Valid values include:

  • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

PublisherId
Type: string

The publisher ID of the extension publisher.

Extensions published by Amazon aren't assigned a publisher ID.

Type
Type: string

The kind of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName
Type: string

The name of the extension for which you want version summary information.

Conditional: You must specify either TypeName and Type, or Arn.

Result Syntax

[
    'NextToken' => '<string>',
    'TypeVersionSummaries' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'IsDefaultVersion' => true || false,
            'PublicVersionNumber' => '<string>',
            'TimeCreated' => <DateTime>,
            'Type' => 'RESOURCE|MODULE|HOOK',
            'TypeName' => '<string>',
            'VersionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

TypeVersionSummaries
Type: Array of TypeVersionSummary structures

A list of TypeVersionSummary structures that contain information about the specified extension's versions.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

ListTypes

$result = $client->listTypes([/* ... */]);
$promise = $client->listTypesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTypes([
    'DeprecatedStatus' => 'LIVE|DEPRECATED',
    'Filters' => [
        'Category' => 'REGISTERED|ACTIVATED|THIRD_PARTY|AWS_TYPES',
        'PublisherId' => '<string>',
        'TypeNamePrefix' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProvisioningType' => 'NON_PROVISIONABLE|IMMUTABLE|FULLY_MUTABLE',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'Visibility' => 'PUBLIC|PRIVATE',
]);

Parameter Details

Members
DeprecatedStatus
Type: string

The deprecation status of the extension that you want to get summary information about.

Valid values include:

  • LIVE: The extension is registered for use in CloudFormation operations.

  • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

Filters
Type: TypeFilters structure

Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

MaxResults
Type: int

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

NextToken
Type: string

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

ProvisioningType
Type: string

For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

Type
Type: string

The type of extension.

Visibility
Type: string

The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

    • Private extensions you have registered in this account and Region.

    • Public extensions that you have activated in this account and Region.

  • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

Result Syntax

[
    'NextToken' => '<string>',
    'TypeSummaries' => [
        [
            'DefaultVersionId' => '<string>',
            'Description' => '<string>',
            'IsActivated' => true || false,
            'LastUpdated' => <DateTime>,
            'LatestPublicVersion' => '<string>',
            'OriginalTypeName' => '<string>',
            'PublicVersionNumber' => '<string>',
            'PublisherId' => '<string>',
            'PublisherIdentity' => 'AWS_Marketplace|GitHub|Bitbucket',
            'PublisherName' => '<string>',
            'Type' => 'RESOURCE|MODULE|HOOK',
            'TypeArn' => '<string>',
            'TypeName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

TypeSummaries
Type: Array of TypeSummary structures

A list of TypeSummary structures that contain information about the specified extensions.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

PublishType

$result = $client->publishType([/* ... */]);
$promise = $client->publishTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->publishType([
    'Arn' => '<string>',
    'PublicVersionNumber' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

PublicVersionNumber
Type: string

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

Type
Type: string

The type of the extension.

Conditional: You must specify Arn, or TypeName and Type.

TypeName
Type: string

The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

Result Syntax

[
    'PublicTypeArn' => '<string>',
]

Result Details

Members
PublicTypeArn
Type: string

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

RecordHandlerProgress

$result = $client->recordHandlerProgress([/* ... */]);
$promise = $client->recordHandlerProgressAsync([/* ... */]);

Reports progress of a resource handler to CloudFormation.

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

Parameter Syntax

$result = $client->recordHandlerProgress([
    'BearerToken' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'CurrentOperationStatus' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED',
    'ErrorCode' => 'NotUpdatable|InvalidRequest|AccessDenied|InvalidCredentials|AlreadyExists|NotFound|ResourceConflict|Throttling|ServiceLimitExceeded|NotStabilized|GeneralServiceException|ServiceInternalError|NetworkFailure|InternalFailure|InvalidTypeConfiguration|HandlerInternalFailure|NonCompliant|Unknown|UnsupportedTarget',
    'OperationStatus' => 'PENDING|IN_PROGRESS|SUCCESS|FAILED', // REQUIRED
    'ResourceModel' => '<string>',
    'StatusMessage' => '<string>',
]);

Parameter Details

Members
BearerToken
Required: Yes
Type: string

Reserved for use by the CloudFormation CLI.

ClientRequestToken
Type: string

Reserved for use by the CloudFormation CLI.

CurrentOperationStatus
Type: string

Reserved for use by the CloudFormation CLI.

ErrorCode
Type: string

Reserved for use by the CloudFormation CLI.

OperationStatus
Required: Yes
Type: string

Reserved for use by the CloudFormation CLI.

ResourceModel
Type: string

Reserved for use by the CloudFormation CLI.

StatusMessage
Type: string

Reserved for use by the CloudFormation CLI.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidStateTransitionException:

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

OperationStatusCheckFailedException:

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

RegisterPublisher

$result = $client->registerPublisher([/* ... */]);
$promise = $client->registerPublisherAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerPublisher([
    'AcceptTermsAndConditions' => true || false,
    'ConnectionArn' => '<string>',
]);

Parameter Details

Members
AcceptTermsAndConditions
Type: boolean

Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

The default is false.

ConnectionArn
Type: string

If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

Result Syntax

[
    'PublisherId' => '<string>',
]

Result Details

Members
PublisherId
Type: string

The ID assigned this account by CloudFormation for publishing extensions.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

RegisterType

$result = $client->registerType([/* ... */]);
$promise = $client->registerTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerType([
    'ClientRequestToken' => '<string>',
    'ExecutionRoleArn' => '<string>',
    'LoggingConfig' => [
        'LogGroupName' => '<string>', // REQUIRED
        'LogRoleArn' => '<string>', // REQUIRED
    ],
    'SchemaHandlerPackage' => '<string>', // REQUIRED
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.

ExecutionRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

LoggingConfig
Type: LoggingConfig structure

Specifies logging configuration information for an extension.

SchemaHandlerPackage
Required: Yes
Type: string

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Type
Type: string

The kind of extension.

TypeName
Required: Yes
Type: string

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.

  • For modules, company_or_organization::service::type::MODULE.

  • For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

  • Alexa

  • AMZN

  • Amazon

  • AWS

  • Custom

  • Dev

Result Syntax

[
    'RegistrationToken' => '<string>',
]

Result Details

Members
RegistrationToken
Type: string

The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration, which returns information about the status and IDs of the extension registration.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

RollbackStack

$result = $client->rollbackStack([/* ... */]);
$promise = $client->rollbackStackAsync([/* ... */]);

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

Parameter Syntax

$result = $client->rollbackStack([
    'ClientRequestToken' => '<string>',
    'RetainExceptOnCreate' => true || false,
    'RoleARN' => '<string>',
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier for this RollbackStack request.

RetainExceptOnCreate
Type: boolean

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

StackName
Required: Yes
Type: string

The name that's associated with the stack.

Result Syntax

[
    'StackId' => '<string>',
]

Result Details

Members
StackId
Type: string

Unique identifier of the stack.

Errors

TokenAlreadyExistsException:

A client request token already exists.

SetStackPolicy

$result = $client->setStackPolicy([/* ... */]);
$promise = $client->setStackPolicyAsync([/* ... */]);

Sets a stack policy for a specified stack.

Parameter Syntax

$result = $client->setStackPolicy([
    'StackName' => '<string>', // REQUIRED
    'StackPolicyBody' => '<string>',
    'StackPolicyURL' => '<string>',
]);

Parameter Details

Members
StackName
Required: Yes
Type: string

The name or unique stack ID that you want to associate a policy with.

StackPolicyBody
Type: string

Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

StackPolicyURL
Type: string

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

SetTypeConfiguration

$result = $client->setTypeConfiguration([/* ... */]);
$promise = $client->setTypeConfigurationAsync([/* ... */]);

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.

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 Using dynamic references to specify template values in the CloudFormation User Guide.

Parameter Syntax

$result = $client->setTypeConfiguration([
    'Configuration' => '<string>', // REQUIRED
    'ConfigurationAlias' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeArn' => '<string>',
    'TypeName' => '<string>',
]);

Parameter Details

Members
Configuration
Required: Yes
Type: string

The configuration data for the extension, in this account and Region.

The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

ConfigurationAlias
Type: string

An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

Type
Type: string

The type of extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

TypeArn
Type: string

The Amazon Resource Name (ARN) for the extension, in this account and Region.

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

TypeName
Type: string

The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

Result Syntax

[
    'ConfigurationArn' => '<string>',
]

Result Details

Members
ConfigurationArn
Type: string

The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

SetTypeDefaultVersion

$result = $client->setTypeDefaultVersion([/* ... */]);
$promise = $client->setTypeDefaultVersionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->setTypeDefaultVersion([
    'Arn' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

Conditional: You must specify either TypeName and Type, or Arn.

Type
Type: string

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName
Type: string

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

VersionId
Type: string

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

SignalResource

$result = $client->signalResource([/* ... */]);
$promise = $client->signalResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->signalResource([
    'LogicalResourceId' => '<string>', // REQUIRED
    'StackName' => '<string>', // REQUIRED
    'Status' => 'SUCCESS|FAILURE', // REQUIRED
    'UniqueId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LogicalResourceId
Required: Yes
Type: string

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

StackName
Required: Yes
Type: string

The stack name or unique stack ID that includes the resource that you want to signal.

Status
Required: Yes
Type: string

The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

UniqueId
Required: Yes
Type: string

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

StartResourceScan

$result = $client->startResourceScan([/* ... */]);
$promise = $client->startResourceScanAsync([/* ... */]);

Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.

Parameter Syntax

$result = $client->startResourceScan([
    'ClientRequestToken' => '<string>',
]);

Parameter Details

Members
ClientRequestToken
Type: string

A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.

Result Syntax

[
    'ResourceScanId' => '<string>',
]

Result Details

Members
ResourceScanId
Type: string

The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

Errors

ResourceScanInProgressException:

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

ResourceScanLimitExceededException:

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.

Examples

Example 1: To start a resource scan

This example shows how to start a new resource scan

$result = $client->startResourceScan([
]);

Result syntax:

[
    'ResourceScanId' => 'arn:aws:cloudformation:us-east-1:123456789012:resourceScan/88f09db1-d211-4cb7-964b-434e2b8469ca',
]

StopStackSetOperation

$result = $client->stopStackSetOperation([/* ... */]);
$promise = $client->stopStackSetOperationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopStackSetOperation([
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'OperationId' => '<string>', // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

OperationId
Required: Yes
Type: string

The ID of the stack operation.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to stop the operation for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationNotFoundException:

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

InvalidOperationException:

The specified operation isn't valid.

TestType

$result = $client->testType([/* ... */]);
$promise = $client->testTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->testType([
    'Arn' => '<string>',
    'LogDeliveryBucket' => '<string>',
    'Type' => 'RESOURCE|MODULE|HOOK',
    'TypeName' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

LogDeliveryBucket
Type: string

The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

  • GetObject

  • PutObject

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

Type
Type: string

The type of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

TypeName
Type: string

The name of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

VersionId
Type: string

The version of the extension to test.

You can specify the version id with either Arn, or with TypeName and Type.

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

Result Syntax

[
    'TypeVersionArn' => '<string>',
]

Result Details

Members
TypeVersionArn
Type: string

The Amazon Resource Name (ARN) of the extension.

Errors

CFNRegistryException:

An error occurred during a CloudFormation registry operation.

TypeNotFoundException:

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

UpdateGeneratedTemplate

$result = $client->updateGeneratedTemplate([/* ... */]);
$promise = $client->updateGeneratedTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateGeneratedTemplate([
    'AddResources' => [
        [
            'LogicalResourceId' => '<string>',
            'ResourceIdentifier' => ['<string>', ...], // REQUIRED
            'ResourceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'GeneratedTemplateName' => '<string>', // REQUIRED
    'NewGeneratedTemplateName' => '<string>',
    'RefreshAllResources' => true || false,
    'RemoveResources' => ['<string>', ...],
    'TemplateConfiguration' => [
        'DeletionPolicy' => 'DELETE|RETAIN',
        'UpdateReplacePolicy' => 'DELETE|RETAIN',
    ],
]);

Parameter Details

Members
AddResources
Type: Array of ResourceDefinition structures

An optional list of resources to be added to the generated template.

GeneratedTemplateName
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of a generated template.

NewGeneratedTemplateName
Type: string

An optional new name to assign to the generated template.

RefreshAllResources
Type: boolean

If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.

RemoveResources
Type: Array of strings

A list of logical ids for resources to remove from the generated template.

TemplateConfiguration
Type: TemplateConfiguration structure

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

Result Syntax

[
    'GeneratedTemplateId' => '<string>',
]

Result Details

Members
GeneratedTemplateId
Type: string

The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

Errors

AlreadyExistsException:

The resource with the name requested already exists.

GeneratedTemplateNotFoundException:

The generated template was not found.

LimitExceededException:

The quota for the resource has already been reached.

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

Examples

Example 1: To update a generated template's name

This example updates a generated template with a new name.

$result = $client->updateGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
    'NewGeneratedTemplateName' => 'JazzierTemplate',
]);

Result syntax:

[
    'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca',
]
Example 2: To remove resources from a generated template

This example removes resources from a generated template

$result = $client->updateGeneratedTemplate([
    'GeneratedTemplateName' => 'JazzyTemplate',
    'RemoveResources' => [
        'LogicalResourceId1',
        'LogicalResourceId2',
    ],
]);

Result syntax:

[
    'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca',
]
Example 3: To add resources to a generated template

This example adds resources to a generated template

$result = $client->updateGeneratedTemplate([
    'AddResources' => [
        [
            'ResourceIdentifier' => [
                'BucketName' => 'jazz-bucket',
            ],
            'ResourceType' => 'AWS::S3::Bucket',
        ],
        [
            'ResourceIdentifier' => [
                'DhcpOptionsId' => 'random-id123',
            ],
            'ResourceType' => 'AWS::EC2::DHCPOptions',
        ],
    ],
    'GeneratedTemplateName' => 'JazzyTemplate',
]);

Result syntax:

[
    'GeneratedTemplateId' => 'arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca',
]

UpdateStack

$result = $client->updateStack([/* ... */]);
$promise = $client->updateStackAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->updateStack([
    'Capabilities' => ['<string>', ...],
    'ClientRequestToken' => '<string>',
    'DisableRollback' => true || false,
    'NotificationARNs' => ['<string>', ...],
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'ResourceTypes' => ['<string>', ...],
    'RetainExceptOnCreate' => true || false,
    'RoleARN' => '<string>',
    'RollbackConfiguration' => [
        'MonitoringTimeInMinutes' => <integer>,
        'RollbackTriggers' => [
            [
                'Arn' => '<string>', // REQUIRED
                'Type' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'StackName' => '<string>', // REQUIRED
    'StackPolicyBody' => '<string>',
    'StackPolicyDuringUpdateBody' => '<string>',
    'StackPolicyDuringUpdateURL' => '<string>',
    'StackPolicyURL' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
    'UsePreviousTemplate' => true || false,
]);

Parameter Details

Members
Capabilities
Type: Array of strings

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Only one of the Capabilities and ResourceType parameters can be specified.

ClientRequestToken
Type: string

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

DisableRollback
Type: boolean

Preserve the state of previously provisioned resources when an operation fails.

Default: False

NotificationARNs
Type: Array of strings

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

Parameters
Type: Array of Parameter structures

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

ResourceTypes
Type: Array of strings

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Only one of the Capabilities and ResourceType parameters can be specified.

RetainExceptOnCreate
Type: boolean

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

RollbackConfiguration
Type: RollbackConfiguration structure

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

StackName
Required: Yes
Type: string

The name or unique stack ID of the stack to update.

StackPolicyBody
Type: string

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

StackPolicyDuringUpdateBody
Type: string

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

StackPolicyDuringUpdateURL
Type: string

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

StackPolicyURL
Type: string

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

Tags
Type: Array of Tag structures

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

TemplateBody
Type: string

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

TemplateURL
Type: string

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

UsePreviousTemplate
Type: boolean

Reuse the existing template that is associated with the stack that you are updating.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Result Syntax

[
    'StackId' => '<string>',
]

Result Details

Members
StackId
Type: string

Unique identifier of the stack.

Errors

InsufficientCapabilitiesException:

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

TokenAlreadyExistsException:

A client request token already exists.

UpdateStackInstances

$result = $client->updateStackInstances([/* ... */]);
$promise = $client->updateStackInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateStackInstances([
    'Accounts' => ['<string>', ...],
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'DeploymentTargets' => [
        'AccountFilterType' => 'NONE|INTERSECTION|DIFFERENCE|UNION',
        'Accounts' => ['<string>', ...],
        'AccountsUrl' => '<string>',
        'OrganizationalUnitIds' => ['<string>', ...],
    ],
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'ParameterOverrides' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'Regions' => ['<string>', ...], // REQUIRED
    'StackSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Accounts
Type: Array of strings

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

DeploymentTargets
Type: DeploymentTargets structure

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

OperationId
Type: string

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

ParameterOverrides
Type: Array of Parameter structures

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.

  • To leave all parameters set to their present values, don't specify this property at all.

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

You can only override 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.

Regions
Required: Yes
Type: Array of strings

The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set associated with the stack instances.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The unique identifier for this stack set operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

StackInstanceNotFoundException:

The specified stack instance doesn't exist.

OperationInProgressException:

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

OperationIdAlreadyExistsException:

The specified operation ID already exists.

StaleRequestException:

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

InvalidOperationException:

The specified operation isn't valid.

UpdateStackSet

$result = $client->updateStackSet([/* ... */]);
$promise = $client->updateStackSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateStackSet([
    'Accounts' => ['<string>', ...],
    'AdministrationRoleARN' => '<string>',
    'AutoDeployment' => [
        'Enabled' => true || false,
        'RetainStacksOnAccountRemoval' => true || false,
    ],
    'CallAs' => 'SELF|DELEGATED_ADMIN',
    'Capabilities' => ['<string>', ...],
    'DeploymentTargets' => [
        'AccountFilterType' => 'NONE|INTERSECTION|DIFFERENCE|UNION',
        'Accounts' => ['<string>', ...],
        'AccountsUrl' => '<string>',
        'OrganizationalUnitIds' => ['<string>', ...],
    ],
    'Description' => '<string>',
    'ExecutionRoleName' => '<string>',
    'ManagedExecution' => [
        'Active' => true || false,
    ],
    'OperationId' => '<string>',
    'OperationPreferences' => [
        'ConcurrencyMode' => 'STRICT_FAILURE_TOLERANCE|SOFT_FAILURE_TOLERANCE',
        'FailureToleranceCount' => <integer>,
        'FailureTolerancePercentage' => <integer>,
        'MaxConcurrentCount' => <integer>,
        'MaxConcurrentPercentage' => <integer>,
        'RegionConcurrencyType' => 'SEQUENTIAL|PARALLEL',
        'RegionOrder' => ['<string>', ...],
    ],
    'Parameters' => [
        [
            'ParameterKey' => '<string>',
            'ParameterValue' => '<string>',
            'ResolvedValue' => '<string>',
            'UsePreviousValue' => true || false,
        ],
        // ...
    ],
    'PermissionModel' => 'SERVICE_MANAGED|SELF_MANAGED',
    'Regions' => ['<string>', ...],
    'StackSetName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
    'UsePreviousTemplate' => true || false,
]);

Parameter Details

Members
Accounts
Type: Array of strings

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, don't specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.

AdministrationRoleARN
Type: string

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

AutoDeployment
Type: AutoDeployment structure

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

If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

CallAs
Type: string

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Capabilities
Type: Array of strings

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

DeploymentTargets
Type: DeploymentTargets structure

[Service-managed permissions] The Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Description
Type: string

A brief description of updates that you are making.

ExecutionRoleName
Type: string

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

ManagedExecution
Type: ManagedExecution structure

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

OperationId
Type: string

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

OperationPreferences

Preferences for how CloudFormation performs this stack set operation.

Parameters
Type: Array of Parameter structures

A list of input parameters for the stack set template.

PermissionModel
Type: string

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Regions
Type: Array of strings

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

StackSetName
Required: Yes
Type: string

The name or unique ID of the stack set that you want to update.

Tags
Type: Array of Tag structures

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

TemplateBody
Type: string

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

TemplateURL
Type: string

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

UsePreviousTemplate
Type: boolean

Use the existing template that's associated with the stack set that you're updating.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The unique ID for this stack set operation.

Errors

StackSetNotFoundException:

The specified stack set doesn't exist.

OperationInProgressException:

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

OperationIdAlreadyExistsException:

The specified operation ID already exists.

StaleRequestException:

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

InvalidOperationException:

The specified operation isn't valid.

StackInstanceNotFoundException:

The specified stack instance doesn't exist.

UpdateTerminationProtection

$result = $client->updateTerminationProtection([/* ... */]);
$promise = $client->updateTerminationProtectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateTerminationProtection([
    'EnableTerminationProtection' => true || false, // REQUIRED
    'StackName' => '<string>', // REQUIRED
]);

Parameter Details

Members
EnableTerminationProtection
Required: Yes
Type: boolean

Whether to enable termination protection on the specified stack.

StackName
Required: Yes
Type: string

The name or unique ID of the stack for which you want to set termination protection.

Result Syntax

[
    'StackId' => '<string>',
]

Result Details

Members
StackId
Type: string

The unique ID of the stack.

Errors

There are no errors described for this operation.

ValidateTemplate

$result = $client->validateTemplate([/* ... */]);
$promise = $client->validateTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->validateTemplate([
    'TemplateBody' => '<string>',
    'TemplateURL' => '<string>',
]);

Parameter Details

Members
TemplateBody
Type: string

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

TemplateURL
Type: string

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Result Syntax

[
    'Capabilities' => ['<string>', ...],
    'CapabilitiesReason' => '<string>',
    'DeclaredTransforms' => ['<string>', ...],
    'Description' => '<string>',
    'Parameters' => [
        [
            'DefaultValue' => '<string>',
            'Description' => '<string>',
            'NoEcho' => true || false,
            'ParameterKey' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Capabilities
Type: Array of strings

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

CapabilitiesReason
Type: string

The list of resources that generated the values in the Capabilities response element.

DeclaredTransforms
Type: Array of strings

A list of the transforms that are declared in the template.

Description
Type: string

The description found within the template.

Parameters
Type: Array of TemplateParameter structures

A list of TemplateParameter structures.

Errors

There are no errors described for this operation.

Shapes

AccountGateResult

Description

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.

Members
Status
Type: string

The status of the account gate function.

  • SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

  • FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED.

  • SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

    • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region.

    • The AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and Region.

    • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.

StatusReason
Type: string

The reason for the account gate status assigned to this account and Region for the stack set operation.

AccountLimit

Description

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.

Members
Name
Type: string

The name of the account limit.

Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit

Value
Type: int

The value that's associated with the account limit name.

ActivateOrganizationsAccessOutput

Members

ActivateTypeOutput

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the activated extension, in this account and Region.

AlreadyExistsException

Description

The resource with the name requested already exists.

Members

AutoDeployment

Description

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

Members
Enabled
Type: boolean

If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

RetainStacksOnAccountRemoval
Type: boolean

If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

BatchDescribeTypeConfigurationsError

Description

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

Members
ErrorCode
Type: string

The error code.

ErrorMessage
Type: string

The error message.

TypeConfigurationIdentifier
Type: TypeConfigurationIdentifier structure

Identifying information for the configuration of a CloudFormation extension.

BatchDescribeTypeConfigurationsOutput

Members
Errors
Type: Array of BatchDescribeTypeConfigurationsError structures

A list of information concerning any errors generated during the setting of the specified configurations.

TypeConfigurations
Type: Array of TypeConfigurationDetails structures

A list of any of the specified extension configurations from the CloudFormation registry.

UnprocessedTypeConfigurations
Type: Array of TypeConfigurationIdentifier structures

A list of any of the specified extension configurations that CloudFormation could not process for any reason.

CFNRegistryException

Description

An error occurred during a CloudFormation registry operation.

Members
Message
Type: string

An message with details about the error that occurred.

Change

Description

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

Members
HookInvocationCount
Type: int

Is either null, if no hooks invoke for the resource, or contains the number of hooks that will invoke for the resource.

ResourceChange
Type: ResourceChange structure

A ResourceChange structure that describes the resource and action that CloudFormation will perform.

Type
Type: string

The type of entity that CloudFormation changes.

  • Resource This change is for a resource.

ChangeSetHook

Description

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

Members
FailureMode
Type: string

Specify the hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

InvocationPoint
Type: string

Specifies the points in provisioning logic where a hook is invoked.

TargetDetails
Type: ChangeSetHookTargetDetails structure

Specifies details about the target that the hook will run against.

TypeConfigurationVersionId
Type: string

The version ID of the type configuration.

TypeName
Type: string

The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

TypeVersionId
Type: string

The version ID of the type specified.

ChangeSetHookResourceTargetDetails

Description

Specifies RESOURCE type target details for activated hooks.

Members
LogicalResourceId
Type: string

The resource's logical ID, which is defined in the stack's template.

ResourceAction
Type: string

Specifies the action of the resource.

ResourceType
Type: string

The type of CloudFormation resource, such as AWS::S3::Bucket.

ChangeSetHookTargetDetails

Description

Specifies target details for an activated hook.

Members
ResourceTargetDetails

Required if TargetType is RESOURCE.

TargetType
Type: string

The name of the type.

ChangeSetNotFoundException

Description

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

Members

ChangeSetSummary

Description

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

Members
ChangeSetId
Type: string

The ID of the change set.

ChangeSetName
Type: string

The name of the change set.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time when the change set was created, in UTC.

Description
Type: string

Descriptive information about the change set.

ExecutionStatus
Type: string

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

ImportExistingResources
Type: boolean

Indicates if the change set imports resources that already exist.

IncludeNestedStacks
Type: boolean

Specifies the current setting of IncludeNestedStacks for the change set.

ParentChangeSetId
Type: string

The parent change set ID.

RootChangeSetId
Type: string

The root change set ID.

StackId
Type: string

The ID of the stack with which the change set is associated.

StackName
Type: string

The name of the stack with which the change set is associated.

Status
Type: string

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

StatusReason
Type: string

A description of the change set's status. For example, if your change set is in the FAILED state, CloudFormation shows the error message.

ConcurrentResourcesLimitExceededException

Description

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.

Members

CreateChangeSetOutput

Description

The output for the CreateChangeSet action.

Members
Id
Type: string

The Amazon Resource Name (ARN) of the change set.

StackId
Type: string

The unique ID of the stack.

CreateGeneratedTemplateOutput

Members
GeneratedTemplateId
Type: string

The ID of the generated template.

CreateStackInstancesOutput

Members
OperationId
Type: string

The unique identifier for this stack set operation.

CreateStackOutput

Description

The output for a CreateStack action.

Members
StackId
Type: string

Unique identifier of the stack.

CreateStackSetOutput

Members
StackSetId
Type: string

The ID of the stack set that you're creating.

CreatedButModifiedException

Description

The specified resource exists, but has been changed.

Members

DeactivateOrganizationsAccessOutput

Members

DeactivateTypeOutput

Members

DeleteChangeSetOutput

Description

The output for the DeleteChangeSet action.

Members

DeleteStackInstancesOutput

Members
OperationId
Type: string

The unique identifier for this stack set operation.

DeleteStackSetOutput

Members

DeploymentTargets

Description

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

Members
AccountFilterType
Type: string

Limit deployment targets to individual accounts or include additional accounts with provided OUs.

The following is a list of possible values for the AccountFilterType operation.

  • INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.

  • DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.

  • UNION: StackSets includes additional accounts deployment targets.

    This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.

  • NONE: Deploys to all the accounts in specified organizational units (OU).

Accounts
Type: Array of strings

The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

AccountsUrl
Type: string

Returns the value of the AccountsUrl property.

OrganizationalUnitIds
Type: Array of strings

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

DeregisterTypeOutput

Members

DescribeAccountLimitsOutput

Description

The output for the DescribeAccountLimits action.

Members
AccountLimits
Type: Array of AccountLimit structures

An account limit structure that contain a list of CloudFormation account limits and their values.

NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

DescribeChangeSetHooksOutput

Members
ChangeSetId
Type: string

The change set identifier (stack ID).

ChangeSetName
Type: string

The change set name.

Hooks
Type: Array of ChangeSetHook structures

List of hook objects.

NextToken
Type: string

Pagination token, null or empty if no more results.

StackId
Type: string

The stack identifier (stack ID).

StackName
Type: string

The stack name.

Status
Type: string

Provides the status of the change set hook.

DescribeChangeSetOutput

Description

The output for the DescribeChangeSet action.

Members
Capabilities
Type: Array of strings

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

ChangeSetId
Type: string

The Amazon Resource Name (ARN) of the change set.

ChangeSetName
Type: string

The name of the change set.

Changes
Type: Array of Change structures

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time when the change set was created, in UTC.

Description
Type: string

Information about the change set.

ExecutionStatus
Type: string

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

ImportExistingResources
Type: boolean

Indicates if the change set imports resources that already exist.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

IncludeNestedStacks
Type: boolean

Verifies if IncludeNestedStacks is set to True.

NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

NotificationARNs
Type: Array of strings

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

OnStackFailure
Type: string

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

Parameters
Type: Array of Parameter structures

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

ParentChangeSetId
Type: string

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

RollbackConfiguration
Type: RollbackConfiguration structure

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

RootChangeSetId
Type: string

Specifies the change set ID of the root change set in the current nested change set hierarchy.

StackId
Type: string

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

StackName
Type: string

The name of the stack that's associated with the change set.

Status
Type: string

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

StatusReason
Type: string

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

Tags
Type: Array of Tag structures

If you execute the change set, the tags that will be associated with the stack.

DescribeGeneratedTemplateOutput

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was created.

GeneratedTemplateId
Type: string

The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

GeneratedTemplateName
Type: string

The name of the generated template.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was last updated.

Progress
Type: TemplateProgress structure

An object describing the progress of the template generation.

Resources
Type: Array of ResourceDetail structures

A list of objects describing the details of the resources in the template generation.

StackId
Type: string

The stack ARN of the base stack if a base stack was provided when generating the template.

Status
Type: string

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

StatusReason
Type: string

The reason for the current template generation status. This will provide more details if a failure happened.

TemplateConfiguration
Type: TemplateConfiguration structure

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

TotalWarnings
Type: int

The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

DescribeOrganizationsAccessOutput

Members
Status
Type: string

Presents the status of the OrganizationAccess.

DescribePublisherOutput

Members
IdentityProvider
Type: string

The type of account used as the identity provider when registering this publisher with CloudFormation.

PublisherId
Type: string

The ID of the extension publisher.

PublisherProfile
Type: string

The URL to the publisher's profile with the identity provider.

PublisherStatus
Type: string

Whether the publisher is verified. Currently, all registered publishers are verified.

DescribeResourceScanOutput

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was finished.

PercentageCompleted
Type: double

The percentage of the resource scan that has been completed.

ResourceScanId
Type: string

The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

ResourceTypes
Type: Array of strings

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

ResourcesRead
Type: int

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

ResourcesScanned
Type: int

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was started.

Status
Type: string

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

StatusReason
Type: string

The reason for the resource scan status, providing more information if a failure happened.

DescribeStackDriftDetectionStatusOutput

Members
DetectionStatus
Required: Yes
Type: string

The status of the stack drift detection operation.

  • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

    If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

  • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

  • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

DetectionStatusReason
Type: string

The reason the stack drift detection operation has its current status.

DriftedStackResourceCount
Type: int

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

StackDriftDetectionId
Required: Yes
Type: string

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

StackDriftStatus
Type: string

Status of the stack's actual configuration compared to its expected configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

StackId
Required: Yes
Type: string

The ID of the stack.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which the stack drift detection operation was initiated.

DescribeStackEventsOutput

Description

The output for a DescribeStackEvents action.

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

StackEvents
Type: Array of StackEvent structures

A list of StackEvents structures.

DescribeStackInstanceOutput

Members
StackInstance
Type: StackInstance structure

The stack instance that matches the specified request parameters.

DescribeStackResourceDriftsOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

StackResourceDrifts
Required: Yes
Type: Array of StackResourceDrift structures

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 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 do not 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.

DescribeStackResourceOutput

Description

The output for a DescribeStackResource action.

Members
StackResourceDetail
Type: StackResourceDetail structure

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

DescribeStackResourcesOutput

Description

The output for a DescribeStackResources action.

Members
StackResources
Type: Array of StackResource structures

A list of StackResource structures.

DescribeStackSetOperationOutput

Members
StackSetOperation
Type: StackSetOperation structure

The specified stack set operation.

DescribeStackSetOutput

Members
StackSet
Type: StackSet structure

The specified stack set.

DescribeStacksOutput

Description

The output for a DescribeStacks action.

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

Stacks
Type: Array of Stack structures

A list of stack structures.

DescribeTypeOutput

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the extension.

AutoUpdate
Type: boolean

Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

ConfigurationSchema
Type: string

A JSON string that represent the current configuration data for the extension in this account and Region.

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

DefaultVersionId
Type: string

The ID of the default version of the extension. The default version is used when the extension version isn't specified.

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

To set the default version of an extension, use SetTypeDefaultVersion.

DeprecatedStatus
Type: string

The deprecation status of the extension version.

Valid values include:

  • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

  • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

For public third-party extensions, CloudFormation returns null.

Description
Type: string

The description of the extension.

DocumentationUrl
Type: string

The URL of a page providing detailed documentation for this extension.

ExecutionRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

IsActivated
Type: boolean

Whether the extension is activated in the account and Region.

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

IsDefaultVersion
Type: boolean

Whether the specified extension version is set as the default version.

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the specified extension version was registered. This applies only to:

  • Private extensions you have registered in your account. For more information, see RegisterType.

  • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

LatestPublicVersion
Type: string

The latest version of a public extension that is available for use.

This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

LoggingConfig
Type: LoggingConfig structure

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

OriginalTypeArn
Type: string

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

OriginalTypeName
Type: string

For public extensions that have been activated for this account and Region, the type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

ProvisioningType
Type: string

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

    • create

    • read

    • delete

PublicVersionNumber
Type: string

The version number of a public third-party extension.

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

PublisherId
Type: string

The publisher ID of the extension publisher.

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

RequiredActivatedTypes
Type: Array of RequiredActivatedType structures

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

Schema
Type: string

The schema that defines the extension.

For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

SourceUrl
Type: string

The URL of the source code for the extension.

TimeCreated
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the specified private extension version was registered or activated in your account.

Type
Type: string

The kind of extension.

TypeName
Type: string

The name of the extension.

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

TypeTestsStatus
Type: string

The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

  • PASSED: The extension has passed all its contract tests.

    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 Command Line Interface User Guide.

  • FAILED: The extension has failed one or more contract tests.

  • IN_PROGRESS: Contract tests are currently being performed on the extension.

  • NOT_TESTED: Contract tests haven't been performed on the extension.

TypeTestsStatusDescription
Type: string

The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

Visibility
Type: string

The scope at which the extension is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

  • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

DescribeTypeRegistrationOutput

Members
Description
Type: string

The description of the extension registration request.

ProgressStatus
Type: string

The current status of the extension registration request.

TypeArn
Type: string

The Amazon Resource Name (ARN) of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

TypeVersionArn
Type: string

The Amazon Resource Name (ARN) of this specific version of the extension being registered.

For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

DetectStackDriftOutput

Members
StackDriftDetectionId
Required: Yes
Type: string

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

DetectStackResourceDriftOutput

Members
StackResourceDrift
Required: Yes
Type: StackResourceDrift structure

Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

DetectStackSetDriftOutput

Members
OperationId
Type: string

The ID of the drift detection stack set operation.

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

EstimateTemplateCostOutput

Description

The output for a EstimateTemplateCost action.

Members
Url
Type: string

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

ExecuteChangeSetOutput

Description

The output for the ExecuteChangeSet action.

Members

Export

Description

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

Members
ExportingStackId
Type: string

The stack that contains the exported output name and value.

Name
Type: string

The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

Value
Type: string

The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

GeneratedTemplateNotFoundException

Description

The generated template was not found.

Members

GetGeneratedTemplateOutput

Members
Status
Type: string

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

TemplateBody
Type: string

The template body of the generated template, in the language specified by the Language parameter.

GetStackPolicyOutput

Description

The output for the GetStackPolicy action.

Members
StackPolicyBody
Type: string

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide.)

GetTemplateOutput

Description

The output for GetTemplate action.

Members
StagesAvailable
Type: Array of strings

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

TemplateBody
Type: string

Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

CloudFormation returns the same template that was used when the stack was created.

GetTemplateSummaryOutput

Description

The output for the GetTemplateSummary action.

Members
Capabilities
Type: Array of strings

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

CapabilitiesReason
Type: string

The list of resources that generated the values in the Capabilities response element.

DeclaredTransforms
Type: Array of strings

A list of the transforms that are declared in the template.

Description
Type: string

The value that's defined in the Description property of the template.

Metadata
Type: string

The value that's defined for the Metadata property of the template.

Parameters
Type: Array of ParameterDeclaration structures

A list of parameter declarations that describe various properties for each parameter.

ResourceIdentifierSummaries
Type: Array of ResourceIdentifierSummary structures

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

ResourceTypes
Type: Array of strings

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

Version
Type: string

The Amazon Web Services template format version, which identifies the capabilities of the template.

Warnings
Type: Warnings structure

An object containing any warnings returned.

ImportStacksToStackSetOutput

Members
OperationId
Type: string

The unique identifier for the stack set operation.

InsufficientCapabilitiesException

Description

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

Members

InvalidChangeSetStatusException

Description

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.

Members

InvalidOperationException

Description

The specified operation isn't valid.

Members

InvalidStateTransitionException

Description

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

Members

LimitExceededException

Description

The quota for the resource has already been reached.

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

Members

ListChangeSetsOutput

Description

The output for the ListChangeSets action.

Members
NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

Summaries
Type: Array of ChangeSetSummary structures

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

ListExportsOutput

Members
Exports
Type: Array of Export structures

The output for the ListExports action.

NextToken
Type: string

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

ListGeneratedTemplatesOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Summaries
Type: Array of TemplateSummary structures

A list of summaries of the generated templates.

ListImportsOutput

Members
Imports
Type: Array of strings

A list of stack names that are importing the specified exported output value.

NextToken
Type: string

A string that identifies the next page of exports. If there is no additional page, this value is null.

ListResourceScanRelatedResourcesOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

RelatedResources
Type: Array of ScannedResource structures

List of up to MaxResults resources in the specified resource scan related to the specified resources.

ListResourceScanResourcesOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Resources
Type: Array of ScannedResource structures

List of up to MaxResults resources in the specified resource scan that match all of the specified filters.

ListResourceScansOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

ResourceScanSummaries
Type: Array of ResourceScanSummary structures

The list of scans returned.

ListStackInstanceResourceDriftsOutput

Members
NextToken
Type: string

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Summaries
Type: Array of StackInstanceResourceDriftsSummary structures

A list of StackInstanceResourceDriftsSummary structures that contain information about the specified stack instances.

ListStackInstancesOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Summaries
Type: Array of StackInstanceSummary structures

A list of StackInstanceSummary structures that contain information about the specified stack instances.

ListStackResourcesOutput

Description

The output for a ListStackResources action.

Members
NextToken
Type: string

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

StackResourceSummaries
Type: Array of StackResourceSummary structures

A list of StackResourceSummary structures.

ListStackSetAutoDeploymentTargetsOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Summaries
Type: Array of StackSetAutoDeploymentTargetSummary structures

An array of summaries of the deployment targets for the stack set.

ListStackSetOperationResultsOutput

Members
NextToken
Type: string

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Summaries
Type: Array of StackSetOperationResultSummary structures

A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

ListStackSetOperationsOutput

Members
NextToken
Type: string

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

Summaries
Type: Array of StackSetOperationSummary structures

A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

ListStackSetsOutput

Members
NextToken
Type: string

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

Summaries
Type: Array of StackSetSummary structures

A list of StackSetSummary structures that contain information about the user's stack sets.

ListStacksOutput

Description

The output for ListStacks action.

Members
NextToken
Type: string

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

StackSummaries
Type: Array of StackSummary structures

A list of StackSummary structures containing information about the specified stacks.

ListTypeRegistrationsOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

RegistrationTokenList
Type: Array of strings

A list of extension registration tokens.

Use DescribeTypeRegistration to return detailed information about a type registration request.

ListTypeVersionsOutput

Members
NextToken
Type: string

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

TypeVersionSummaries
Type: Array of TypeVersionSummary structures

A list of TypeVersionSummary structures that contain information about the specified extension's versions.

ListTypesOutput

Members
NextToken
Type: string

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

TypeSummaries
Type: Array of TypeSummary structures

A list of TypeSummary structures that contain information about the specified extensions.

LoggingConfig

Description

Contains logging configuration information for an extension.

Members
LogGroupName
Required: Yes
Type: string

The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.

LogRoleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

ManagedExecution

Description

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

Members
Active
Type: boolean

When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

When false (default), StackSets performs one operation at a time in request order.

ModuleInfo

Description

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.

Members
LogicalIdHierarchy
Type: string

A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed starting with the inner-most nested module, and separated by /.

In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.

moduleA/moduleB

For more information, see Referencing resources in a module in the CloudFormation User Guide.

TypeHierarchy
Type: string

A concatenated list of the module type or types containing the resource. Module types are listed starting with the inner-most nested module, and separated by /.

In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that's nested inside a parent module of type AWS::Second::Example::MODULE.

AWS::First::Example::MODULE/AWS::Second::Example::MODULE

NameAlreadyExistsException

Description

The specified name is already in use.

Members

OperationIdAlreadyExistsException

Description

The specified operation ID already exists.

Members

OperationInProgressException

Description

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

Members

OperationNotFoundException

Description

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

Members

OperationResultFilter

Description

The status that operation results are filtered by.

Members
Name
Type: string

The type of filter to apply.

Values
Type: string

The value to filter by.

OperationStatusCheckFailedException

Description

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

Members

Output

Description

The Output data type.

Members
Description
Type: string

User defined description associated with the output.

ExportName
Type: string

The name of the export associated with the output.

OutputKey
Type: string

The key associated with the output.

OutputValue
Type: string

The value associated with the output.

Parameter

Description

The Parameter data type.

Members
ParameterKey
Type: string

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

ParameterValue
Type: string

The input value associated with the parameter.

ResolvedValue
Type: string

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.

UsePreviousValue
Type: boolean

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

ParameterConstraints

Description

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.

Members
AllowedValues
Type: Array of strings

A list of values that are permitted for a parameter.

ParameterDeclaration

Description

The ParameterDeclaration data type.

Members
DefaultValue
Type: string

The default value of the parameter.

Description
Type: string

The description that's associate with the parameter.

NoEcho
Type: boolean

Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.

ParameterConstraints
Type: ParameterConstraints structure

The criteria that CloudFormation uses to validate parameter values.

ParameterKey
Type: string

The name that's associated with the parameter.

ParameterType
Type: string

The type of parameter.

PhysicalResourceIdContextKeyValuePair

Description

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.

Members
Key
Required: Yes
Type: string

The resource context key.

Value
Required: Yes
Type: string

The resource context value.

PropertyDifference

Description

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.

Members
ActualValue
Required: Yes
Type: string

The actual property value of the resource property.

DifferenceType
Required: Yes
Type: string

The type of property difference.

  • ADD: A value has been added to a resource property that's an array or list data type.

  • REMOVE: The property has been removed from the current resource configuration.

  • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

ExpectedValue
Required: Yes
Type: string

The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

PropertyPath
Required: Yes
Type: string

The fully-qualified path to the resource property.

PublishTypeOutput

Members
PublicTypeArn
Type: string

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

RecordHandlerProgressOutput

Members

RegisterPublisherOutput

Members
PublisherId
Type: string

The ID assigned this account by CloudFormation for publishing extensions.

RegisterTypeOutput

Members
RegistrationToken
Type: string

The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration, which returns information about the status and IDs of the extension registration.

RequiredActivatedType

Description

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.

Members
OriginalTypeName
Type: string

The type name of the public extension.

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

PublisherId
Type: string

The publisher ID of the extension publisher.

SupportedMajorVersions
Type: Array of ints

A list of the major versions of the extension type that the macro supports.

TypeNameAlias
Type: string

An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

ResourceChange

Description

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

Members
Action
Type: string

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

AfterContext
Type: string

An encoded JSON string containing the context of the resource after the change is executed.

BeforeContext
Type: string

An encoded JSON string containing the context of the resource before the change is executed.

ChangeSetId
Type: string

The change set ID of the nested change set.

Details
Type: Array of ResourceChangeDetail structures

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

LogicalResourceId
Type: string

The resource's logical ID, which is defined in the stack's template.

ModuleInfo
Type: ModuleInfo structure

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

PhysicalResourceId
Type: string

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

PolicyAction
Type: string

The action that will be taken on the physical resource when the change set is executed.

  • Delete The resource will be deleted.

  • Retain The resource will be retained.

  • Snapshot The resource will have a snapshot taken.

  • ReplaceAndDelete The resource will be replaced and then deleted.

  • ReplaceAndRetain The resource will be replaced and then retained.

  • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

Replacement
Type: string

For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

ResourceType
Type: string

The type of CloudFormation resource, such as AWS::S3::Bucket.

Scope
Type: Array of strings

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

ResourceChangeDetail

Description

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

Members
CausingEntity
Type: string

The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

ChangeSource
Type: string

The group to which the CausingEntity value belongs. There are five entity groups:

  • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.

  • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.

  • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.

  • DirectModification entities are changes that are made directly to the template.

  • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.

Evaluation
Type: string

Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

Target
Type: ResourceTargetDefinition structure

A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.

ResourceDefinition

Description

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

Members
LogicalResourceId
Type: string

The logical resource id for this resource in the generated template.

ResourceIdentifier
Required: Yes
Type: Associative array of custom strings keys (ResourceIdentifierPropertyKey) to strings

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

ResourceType
Required: Yes
Type: string

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide

ResourceDetail

Description

Details about a resource in a generated template

Members
LogicalResourceId
Type: string

The logical id for this resource in the final generated template.

ResourceIdentifier
Type: Associative array of custom strings keys (ResourceIdentifierPropertyKey) to strings

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

ResourceStatus
Type: string

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

ResourceStatusReason
Type: string

The reason for the resource detail, providing more information if a failure happened.

ResourceType
Type: string

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

Warnings
Type: Array of WarningDetail structures

The warnings generated for this resource.

ResourceIdentifierSummary

Description

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.

Members
LogicalResourceIds
Type: Array of strings

The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

ResourceIdentifiers
Type: Array of strings

The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

ResourceType
Type: string

The template resource type of the target resources, such as AWS::S3::Bucket.

ResourceScanInProgressException

Description

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

Members

ResourceScanLimitExceededException

Description

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.

Members

ResourceScanNotFoundException

Description

The resource scan was not found.

Members

ResourceScanSummary

Description

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

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was finished.

PercentageCompleted
Type: double

The percentage of the resource scan that has been completed.

ResourceScanId
Type: string

The Amazon Resource Name (ARN) of the resource scan.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the resource scan was started.

Status
Type: string

Status of the resource scan.

INPROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

StatusReason
Type: string

The reason for the resource scan status, providing more information if a failure happened.

ResourceTargetDefinition

Description

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

Members
AfterValue
Type: string

The value of the property after the change is executed. Large values can be truncated.

Attribute
Type: string

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

AttributeChangeType
Type: string

The type of change to be made to the property if the change is executed.

  • Add The item will be added.

  • Remove The item will be removed.

  • Modify The item will be modified.

BeforeValue
Type: string

The value of the property before the change is executed. Large values can be truncated.

Name
Type: string

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

Path
Type: string

The property path of the property.

RequiresRecreation
Type: string

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the CloudFormation User Guide.

ResourceToImport

Description

Describes the target resource of an import operation.

Members
LogicalResourceId
Required: Yes
Type: string

The logical ID of the target resource as specified in the template.

ResourceIdentifier
Required: Yes
Type: Associative array of custom strings keys (ResourceIdentifierPropertyKey) to strings

A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

ResourceType
Required: Yes
Type: string

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.

RollbackConfiguration

Description

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.

Members
MonitoringTimeInMinutes
Type: int

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

RollbackTriggers
Type: Array of RollbackTrigger structures

The triggers to monitor during stack creation or update actions.

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

  • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

  • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

  • To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

RollbackStackOutput

Members
StackId
Type: string

Unique identifier of the stack.

RollbackTrigger

Description

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.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the rollback trigger.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

Type
Required: Yes
Type: string

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

ScannedResource

Description

A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources.

Members
ManagedByStack
Type: boolean

If true, the resource is managed by a CloudFormation stack.

ResourceIdentifier
Type: Associative array of custom strings keys (JazzResourceIdentifierPropertyKey) to strings

A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

ResourceType
Type: string

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support In the CloudFormation User Guide

ScannedResourceIdentifier

Description

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

Members
ResourceIdentifier
Required: Yes
Type: Associative array of custom strings keys (JazzResourceIdentifierPropertyKey) to strings

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

ResourceType
Required: Yes
Type: string

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide.

SetTypeConfigurationOutput

Members
ConfigurationArn
Type: string

The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

SetTypeDefaultVersionOutput

Members

Stack

Description

The Stack data type.

Members
Capabilities
Type: Array of strings

The capabilities allowed in the stack.

ChangeSetId
Type: string

The unique ID of the change set.

CreationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the stack was created.

DeletionMode
Type: string

Specifies the deletion mode for the stack. Possible values are:

  • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

  • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

DeletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the stack was deleted.

Description
Type: string

A user-defined description associated with the stack.

DetailedStatus
Type: string

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

DisableRollback
Type: boolean

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.

  • false: enable rollback.

DriftInformation
Type: StackDriftInformation structure

Information about 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 more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

EnableTerminationProtection
Type: boolean

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

NotificationARNs
Type: Array of strings

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

Outputs
Type: Array of Output structures

A list of output structures.

Parameters
Type: Array of Parameter structures

A list of Parameter structures.

ParentId
Type: string

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

RetainExceptOnCreate
Type: boolean

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

RoleARN
Type: string

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

RollbackConfiguration
Type: RollbackConfiguration structure

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

RootId
Type: string

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

StackId
Type: string

Unique identifier of the stack.

StackName
Required: Yes
Type: string

The name associated with the stack.

StackStatus
Required: Yes
Type: string

Current status of the stack.

StackStatusReason
Type: string

Success/failure message associated with the stack status.

Tags
Type: Array of Tag structures

A list of Tags that specify information about the stack.

TimeoutInMinutes
Type: int

The amount of time within which stack creation should complete.

StackDriftInformation

Description

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.

Members
LastCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

StackDriftStatus
Required: Yes
Type: string

Status of the stack's actual configuration compared to its expected template configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

StackDriftInformationSummary

Description

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.

Members
LastCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

StackDriftStatus
Required: Yes
Type: string

Status of the stack's actual configuration compared to its expected template configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

StackEvent

Description

The StackEvent data type.

Members
ClientRequestToken
Type: string

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

DetailedStatus
Type: string

An optional field containing information about the detailed status of the stack event.

  • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

  • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.

EventId
Required: Yes
Type: string

The unique ID of this event.

HookFailureMode
Type: string

Specify the hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

HookInvocationPoint
Type: string

Invocation points are points in provisioning logic where hooks are initiated.

HookStatus
Type: string

Provides the status of the change set hook.

HookStatusReason
Type: string

Provides the reason for the hook status.

HookType
Type: string

The name of the hook.

LogicalResourceId
Type: string

The logical name of the resource specified in the template.

PhysicalResourceId
Type: string

The name or unique identifier associated with the physical instance of the resource.

ResourceProperties
Type: string

BLOB of the properties used to create the resource.

ResourceStatus
Type: string

Current status of the resource.

ResourceStatusReason
Type: string

Success/failure message associated with the resource.

ResourceType
Type: string

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

StackId
Required: Yes
Type: string

The unique ID name of the instance of the stack.

StackName
Required: Yes
Type: string

The name associated with a stack.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the status was updated.

StackInstance

Description

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.

Members
Account
Type: string

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

DriftStatus
Type: string

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.

  • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.

  • UNKNOWN: This value is reserved for future use.

LastDriftCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

LastOperationId
Type: string

The last unique ID of a StackSet operation performed on a stack instance.

OrganizationalUnitId
Type: string

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

ParameterOverrides
Type: Array of Parameter structures

A list of parameters from the stack set template whose values have been overridden in this stack instance.

Region
Type: string

The name of the Amazon Web Services Region that the stack instance is associated with.

StackId
Type: string

The ID of the stack instance.

StackInstanceStatus

The detailed status of the stack instance.

StackSetId
Type: string

The name or unique ID of the stack set that the stack instance is associated with.

Status
Type: string

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.

  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

StatusReason
Type: string

The explanation for the specific status code that's assigned to this stack instance.

StackInstanceComprehensiveStatus

Description

The detailed status of the stack instance.

Members
DetailedStatus
Type: string
  • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

  • FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • FAILED_IMPORT: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

  • PENDING: The operation in the specified account and Region has yet to start.

  • RUNNING: The operation in the specified account and Region is currently in progress.

  • SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.

  • SUCCEEDED: The operation in the specified account and Region completed successfully.

StackInstanceFilter

Description

The filter to apply to stack instances

Members
Name
Type: string

The type of filter to apply.

Values
Type: string

The status to filter by.

StackInstanceNotFoundException

Description

The specified stack instance doesn't exist.

Members

StackInstanceResourceDriftsSummary

Description

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

Members
LogicalResourceId
Required: Yes
Type: string

The logical name of the resource specified in the template.

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

PhysicalResourceIdContext
Type: Array of PhysicalResourceIdContextKeyValuePair structures

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 unique resource that contains the targeted resource.

PropertyDifferences
Type: Array of PropertyDifference structures

Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus is MODIFIED.

ResourceType
Required: Yes
Type: string

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

StackId
Required: Yes
Type: string

The ID of the stack instance.

StackResourceDriftStatus
Required: Yes
Type: string

The drift status of the resource in a stack instance.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected template values.

  • IN_SYNC: The resource's actual configuration matches its expected template configuration.

  • NOT_CHECKED: CloudFormation doesn't currently return this value.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which the stack instance drift detection operation was initiated.

StackInstanceSummary

Description

The structure that contains summary information about a stack instance.

Members
Account
Type: string

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

DriftStatus
Type: string

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.

  • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.

  • UNKNOWN: This value is reserved for future use.

LastDriftCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

LastOperationId
Type: string

The last unique ID of a StackSet operation performed on a stack instance.

OrganizationalUnitId
Type: string

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Region
Type: string

The name of the Amazon Web Services Region that the stack instance is associated with.

StackId
Type: string

The ID of the stack instance.

StackInstanceStatus

The detailed status of the stack instance.

StackSetId
Type: string

The name or unique ID of the stack set that the stack instance is associated with.

Status
Type: string

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.

  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

StatusReason
Type: string

The explanation for the specific status code assigned to this stack instance.

StackNotFoundException

Description

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

Members

StackResource

Description

The StackResource data type.

Members
Description
Type: string

User defined description associated with the resource.

DriftInformation

Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

LogicalResourceId
Required: Yes
Type: string

The logical name of the resource specified in the template.

ModuleInfo
Type: ModuleInfo structure

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

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

ResourceStatus
Required: Yes
Type: string

Current status of the resource.

ResourceStatusReason
Type: string

Success/failure message associated with the resource.

ResourceType
Required: Yes
Type: string

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

StackId
Type: string

Unique identifier of the stack.

StackName
Type: string

The name associated with the stack.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the status was updated.

StackResourceDetail

Description

Contains detailed information about the specified stack resource.

Members
Description
Type: string

User defined description associated with the resource.

DriftInformation

Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

LastUpdatedTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the status was updated.

LogicalResourceId
Required: Yes
Type: string

The logical name of the resource specified in the template.

Metadata
Type: string

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.

ModuleInfo
Type: ModuleInfo structure

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

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

ResourceStatus
Required: Yes
Type: string

Current status of the resource.

ResourceStatusReason
Type: string

Success/failure message associated with the resource.

ResourceType
Required: Yes
Type: string

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

StackId
Type: string

Unique identifier of the stack.

StackName
Type: string

The name associated with the stack.

StackResourceDrift

Description

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.

Members
ActualProperties
Type: string

A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

ExpectedProperties
Type: string

A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

LogicalResourceId
Required: Yes
Type: string

The logical name of the resource specified in the template.

ModuleInfo
Type: ModuleInfo structure

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

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

PhysicalResourceIdContext
Type: Array of PhysicalResourceIdContextKeyValuePair structures

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 unique resource that contains the targeted resource.

PropertyDifferences
Type: Array of PropertyDifference structures

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

ResourceType
Required: Yes
Type: string

The type of the resource.

StackId
Required: Yes
Type: string

The ID of the stack.

StackResourceDriftStatus
Required: Yes
Type: string

Status of the resource's actual configuration compared to its expected configuration.

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

  • IN_SYNC: The resource's actual configuration matches its expected template configuration.

  • NOT_CHECKED: CloudFormation does not currently return this value.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time at which CloudFormation performed drift detection on the stack resource.

StackResourceDriftInformation

Description

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

Members
LastCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

When CloudFormation last checked if the resource had drifted from its expected configuration.

StackResourceDriftStatus
Required: Yes
Type: string

Status of the resource's actual configuration compared to its expected configuration

  • DELETED: The resource differs from its expected configuration in that it has been deleted.

  • MODIFIED: The resource differs from its expected configuration.

  • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

    Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.

  • IN_SYNC: The resource's actual configuration matches its expected configuration.

StackResourceDriftInformationSummary

Description

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

Members
LastCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

When CloudFormation last checked if the resource had drifted from its expected configuration.

StackResourceDriftStatus
Required: Yes
Type: string

Status of the resource's actual configuration compared to its expected configuration.

  • DELETED: The resource differs from its expected configuration in that it has been deleted.

  • MODIFIED: The resource differs from its expected configuration.

  • NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.

    Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.

  • IN_SYNC: The resource's actual configuration matches its expected configuration.

StackResourceSummary

Description

Contains high-level information about the specified stack resource.

Members
DriftInformation

Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

LastUpdatedTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time the status was updated.

LogicalResourceId
Required: Yes
Type: string

The logical name of the resource specified in the template.

ModuleInfo
Type: ModuleInfo structure

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

PhysicalResourceId
Type: string

The name or unique identifier that corresponds to a physical instance ID of the resource.

ResourceStatus
Required: Yes
Type: string

Current status of the resource.

ResourceStatusReason
Type: string

Success/failure message associated with the resource.

ResourceType
Required: Yes
Type: string

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)

StackSet

Description

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.

Members
AdministrationRoleARN
Type: string

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

AutoDeployment
Type: AutoDeployment structure

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

Capabilities
Type: Array of strings

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

Description
Type: string

A description of the stack set that you specify when the stack set is created or updated.

ExecutionRoleName
Type: string

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

ManagedExecution
Type: ManagedExecution structure

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

OrganizationalUnitIds
Type: Array of strings

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Parameters
Type: Array of Parameter structures

A list of input parameters for a stack set.

PermissionModel
Type: string

Describes how the IAM roles required for stack set operations are created.

Regions
Type: Array of strings

Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

StackSetARN
Type: string

The Amazon Resource Name (ARN) of the stack set.

StackSetDriftDetectionDetails

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 currently in progress isn't included.

StackSetId
Type: string

The ID of the stack set.

StackSetName
Type: string

The name that's associated with the stack set.

Status
Type: string

The status of the stack set.

Tags
Type: Array of Tag structures

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

TemplateBody
Type: string

The structure that contains the body of the template that was used to create or update the stack set.

StackSetAutoDeploymentTargetSummary

Description

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

Members
OrganizationalUnitId
Type: string

The organization root ID or organizational unit (OU) IDs where the stack set is targeted.

Regions
Type: Array of strings

The list of Regions targeted for this organization or OU.

StackSetDriftDetectionDetails

Description

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.

Members
DriftDetectionStatus
Type: string

The status of the stack set drift detection operation.

  • COMPLETED: The drift detection operation completed without failing on any stack instances.

  • FAILED: The drift detection operation exceeded the specified failure tolerance.

  • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

  • IN_PROGRESS: The drift detection operation is currently being performed.

  • STOPPED: The user has canceled the drift detection operation.

DriftStatus
Type: string

Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

  • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.

  • IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

DriftedStackInstancesCount
Type: int

The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

FailedStackInstancesCount
Type: int

The number of stack instances for which the drift detection operation failed.

InProgressStackInstancesCount
Type: int

The number of stack instances that are currently being checked for drift.

InSyncStackInstancesCount
Type: int

The number of stack instances which match the expected template and parameter configuration of the stack set.

LastDriftCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.

TotalStackInstancesCount
Type: int

The total number of stack instances belonging to this stack set.

The total number of stack instances is equal to the total of:

  • Stack instances that match the stack set configuration.

  • Stack instances that have drifted from the stack set configuration.

  • Stack instances where the drift detection operation has failed.

  • Stack instances currently being checked for drift.

StackSetNotEmptyException

Description

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.

Members

StackSetNotFoundException

Description

The specified stack set doesn't exist.

Members

StackSetOperation

Description

The structure that contains information about a stack set operation.

Members
Action
Type: string

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to all associated stack set instances.

AdministrationRoleARN
Type: string

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

CreationTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

DeploymentTargets
Type: DeploymentTargets structure

[Service-managed permissions] The Organizations accounts affected by the stack operation.

EndTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

ExecutionRoleName
Type: string

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

OperationId
Type: string

The unique ID of a stack set operation.

OperationPreferences

The preferences for how CloudFormation performs this stack set operation.

RetainStacks
Type: boolean

For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

StackSetDriftDetectionDetails

Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.

StackSetId
Type: string

The ID of the stack set.

Status
Type: string

The status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

  • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has canceled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

StatusDetails

Detailed information about the StackSet operation.

StatusReason
Type: string

The status of the operation in details.

StackSetOperationPreferences

Description

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.

Members
ConcurrencyMode
Type: string

Specifies how the concurrency level behaves during the operation execution.

  • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

    If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

  • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

FailureToleranceCount
Type: int

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

FailureTolerancePercentage
Type: int

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

MaxConcurrentCount
Type: int

The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

MaxConcurrentPercentage
Type: int

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

RegionConcurrencyType
Type: string

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

RegionOrder
Type: Array of strings

The order of the Regions where you want to perform the stack operation.

RegionOrder isn't followed if AutoDeployment is enabled.

StackSetOperationResultSummary

Description

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

Members
Account
Type: string

[Self-managed permissions] The name of the Amazon Web Services account for this operation result.

AccountGateResult
Type: AccountGateResult structure

The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

OrganizationalUnitId
Type: string

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

Region
Type: string

The name of the Amazon Web Services Region for this operation result.

Status
Type: string

The result status of the stack set operation for the given account in the given Region.

  • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

  • FAILED: The operation in the specified account and Region failed.

    If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • RUNNING: The operation in the specified account and Region is currently in progress.

  • PENDING: The operation in the specified account and Region has yet to start.

  • SUCCEEDED: The operation in the specified account and Region completed successfully.

StatusReason
Type: string

The reason for the assigned result status.

StackSetOperationStatusDetails

Description

Detailed information about the StackSet operation.

Members
FailedStackInstancesCount
Type: int

The number of stack instances for which the StackSet operation failed.

StackSetOperationSummary

Description

The structures that contain summary information about the specified operation.

Members
Action
Type: string

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

CreationTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

EndTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

OperationId
Type: string

The unique ID of the stack set operation.

OperationPreferences

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.

Status
Type: string

The overall status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

  • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has canceled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

StatusDetails

Detailed information about the stack set operation.

StatusReason
Type: string

The status of the operation in details.

StackSetSummary

Description

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

Members
AutoDeployment
Type: AutoDeployment structure

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

Description
Type: string

A description of the stack set that you specify when the stack set is created or updated.

DriftStatus
Type: string

Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

  • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.

  • IN_SYNC: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

  • UNKNOWN: This value is reserved for future use.

LastDriftCheckTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.

ManagedExecution
Type: ManagedExecution structure

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

PermissionModel
Type: string

Describes how the IAM roles required for stack set operations are created.

StackSetId
Type: string

The ID of the stack set.

StackSetName
Type: string

The name of the stack set.

Status
Type: string

The status of the stack set.

StackSummary

Description

The StackSummary Data Type

Members
CreationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the stack was created.

DeletionTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the stack was deleted.

DriftInformation

Summarizes information about 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 more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

ParentId
Type: string

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

RootId
Type: string

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

StackId
Type: string

Unique stack identifier.

StackName
Required: Yes
Type: string

The name associated with the stack.

StackStatus
Required: Yes
Type: string

The current status of the stack.

StackStatusReason
Type: string

Success/Failure message associated with the stack status.

TemplateDescription
Type: string

The template description of the template used to create the stack.

StaleRequestException

Description

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

Members

StartResourceScanOutput

Members
ResourceScanId
Type: string

The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

StopStackSetOperationOutput

Members

Tag

Description

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

Members
Key
Required: Yes
Type: string

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

Value
Required: Yes
Type: string

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

TemplateConfiguration

Description

The configuration details of a generated template.

Members
DeletionPolicy
Type: string

The DeletionPolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the stack is deleted.

  • RETAIN - retain all resources when the stack is deleted.

For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

UpdateReplacePolicy
Type: string

The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the resource is replaced during an update operation.

  • RETAIN - retain all resources when the resource is replaced during an update operation.

For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

TemplateParameter

Description

The TemplateParameter data type.

Members
DefaultValue
Type: string

The default value associated with the parameter.

Description
Type: string

User defined description associated with the parameter.

NoEcho
Type: boolean

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

ParameterKey
Type: string

The name associated with the parameter.

TemplateProgress

Description

A summary of the progress of the template generation.

Members
ResourcesFailed
Type: int

The number of resources that failed the template generation.

ResourcesPending
Type: int

The number of resources that are still pending the template generation.

ResourcesProcessing
Type: int

The number of resources that are in-process for the template generation.

ResourcesSucceeded
Type: int

The number of resources that succeeded the template generation.

TemplateSummary

Description

The summary of a generated template.

Members
CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was created.

GeneratedTemplateId
Type: string

The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

GeneratedTemplateName
Type: string

The name of the generated template.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the generated template was last updated.

NumberOfResources
Type: int

The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.

Status
Type: string

The status of the template generation. Supported values are:

  • CreatePending - the creation of the template is pending.

  • CreateInProgress - the creation of the template is in progress.

  • DeletePending - the deletion of the template is pending.

  • DeleteInProgress - the deletion of the template is in progress.

  • UpdatePending - the update of the template is pending.

  • UpdateInProgress - the update of the template is in progress.

  • Failed - the template operation failed.

  • Complete - the template operation is complete.

StatusReason
Type: string

The reason for the current template generation status. This will provide more details if a failure happened.

TemplateSummaryConfig

Description

Options for the GetTemplateSummary API action.

Members
TreatUnrecognizedResourceTypesAsWarnings
Type: boolean

If set to True, any unrecognized resource types generate warnings and not an error. Any unrecognized resource types are returned in the Warnings output parameter.

TestTypeOutput

Members
TypeVersionArn
Type: string

The Amazon Resource Name (ARN) of the extension.

TokenAlreadyExistsException

Description

A client request token already exists.

Members

TypeConfigurationDetails

Description

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.

Members
Alias
Type: string

The alias specified for this configuration, if one was specified when the configuration was set.

Arn
Type: string

The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

Configuration
Type: string

A JSON string specifying the configuration data for the extension, in this account and Region.

If a configuration hasn't been set for a specified extension, CloudFormation returns {}.

IsDefaultConfiguration
Type: boolean

Whether this configuration data is the default configuration for the extension.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the configuration data was last updated for this extension.

If a configuration hasn't been set for a specified extension, CloudFormation returns null.

TypeArn
Type: string

The Amazon Resource Name (ARN) for the extension, in this account and Region.

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

TypeName
Type: string

The name of the extension.

TypeConfigurationIdentifier

Description

Identifying information for the configuration of a CloudFormation extension.

Members
Type
Type: string

The type of extension.

TypeArn
Type: string

The Amazon Resource Name (ARN) for the extension, in this account and Region.

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

TypeConfigurationAlias
Type: string

The alias specified for this configuration, if one was specified when the configuration was set.

TypeConfigurationArn
Type: string

The Amazon Resource Name (ARN) for the configuration, in this account and Region.

TypeName
Type: string

The name of the extension type to which this configuration applies.

TypeConfigurationNotFoundException

Description

The specified extension configuration can't be found.

Members

TypeFilters

Description

Filter criteria to use in determining which extensions to return.

Members
Category
Type: string

The category of extensions to return.

  • REGISTERED: Private extensions that have been registered for this account and Region.

  • ACTIVATED: Public extensions that have been activated for this account and Region.

  • THIRD_PARTY: Extensions available for use from publishers other than Amazon. This includes:

    • Private extensions registered in the account.

    • Public extensions from publishers other than Amazon, whether activated or not.

  • AWS_TYPES: Extensions available for use from Amazon.

PublisherId
Type: string

The id of the publisher of the extension.

Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to specify a list of types published by Amazon.

TypeNamePrefix
Type: string

A prefix to use as a filter for results.

TypeNotFoundException

Description

The specified extension doesn't exist in