Table of Contents
CloudFormation.Client¶A low-level client representing AWS CloudFormation
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page .
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at ` docs.aws.amazon.com https://docs.aws.amazon.com/`__ .
import boto3
client = boto3.client('cloudformation')
These are the available methods:
activate_type()batch_describe_type_configurations()can_paginate()cancel_update_stack()close()continue_update_rollback()create_change_set()create_stack()create_stack_instances()create_stack_set()deactivate_type()delete_change_set()delete_stack()delete_stack_instances()delete_stack_set()deregister_type()describe_account_limits()describe_change_set()describe_change_set_hooks()describe_publisher()describe_stack_drift_detection_status()describe_stack_events()describe_stack_instance()describe_stack_resource()describe_stack_resource_drifts()describe_stack_resources()describe_stack_set()describe_stack_set_operation()describe_stacks()describe_type()describe_type_registration()detect_stack_drift()detect_stack_resource_drift()detect_stack_set_drift()estimate_template_cost()execute_change_set()get_paginator()get_stack_policy()get_template()get_template_summary()get_waiter()import_stacks_to_stack_set()list_change_sets()list_exports()list_imports()list_stack_instances()list_stack_resources()list_stack_set_operation_results()list_stack_set_operations()list_stack_sets()list_stacks()list_type_registrations()list_type_versions()list_types()publish_type()record_handler_progress()register_publisher()register_type()rollback_stack()set_stack_policy()set_type_configuration()set_type_default_version()signal_resource()stop_stack_set_operation()test_type()update_stack()update_stack_instances()update_stack_set()update_termination_protection()validate_template()activate_type(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.activate_type(
Type='RESOURCE'|'MODULE'|'HOOK',
PublicTypeArn='string',
PublisherId='string',
TypeName='string',
TypeNameAlias='string',
AutoUpdate=True|False,
LoggingConfig={
'LogRoleArn': 'string',
'LogGroupName': 'string'
},
ExecutionRoleArn='string',
VersionBump='MAJOR'|'MINOR',
MajorVersion=123
)
The extension type.
Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .
The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .
The ID of the extension publisher.
Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .
The name of the extension.
Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .
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.
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 .
Contains logging configuration information for an extension.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
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.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.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the activated extension, in this account and region.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptionbatch_describe_type_configurations(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.batch_describe_type_configurations(
TypeConfigurationIdentifiers=[
{
'TypeArn': 'string',
'TypeConfigurationAlias': 'string',
'TypeConfigurationArn': 'string',
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string'
},
]
)
[REQUIRED]
The list of identifiers for the desired extension configurations.
Identifying information for the configuration of a CloudFormation extension.
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
The alias specified for this configuration, if one was specified when the configuration was set.
The Amazon Resource Name (ARN) for the configuration, in this account and region.
The type of extension.
The name of the extension type to which this configuration applies.
{
'Errors': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string',
'TypeConfigurationIdentifier': {
'TypeArn': 'string',
'TypeConfigurationAlias': 'string',
'TypeConfigurationArn': 'string',
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string'
}
},
],
'UnprocessedTypeConfigurations': [
{
'TypeArn': 'string',
'TypeConfigurationAlias': 'string',
'TypeConfigurationArn': 'string',
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string'
},
],
'TypeConfigurations': [
{
'Arn': 'string',
'Alias': 'string',
'Configuration': 'string',
'LastUpdated': datetime(2015, 1, 1),
'TypeArn': 'string',
'TypeName': 'string',
'IsDefaultConfiguration': True|False
},
]
}
Response Structure
A list of information concerning any errors generated during the setting of the specified configurations.
Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
The error code.
The error message.
Identifying information for the configuration of a CloudFormation extension.
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
The alias specified for this configuration, if one was specified when the configuration was set.
The Amazon Resource Name (ARN) for the configuration, in this account and region.
The type of extension.
The name of the extension type to which this configuration applies.
A list of any of the specified extension configurations that CloudFormation could not process for any reason.
Identifying information for the configuration of a CloudFormation extension.
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
The alias specified for this configuration, if one was specified when the configuration was set.
The Amazon Resource Name (ARN) for the configuration, in this account and region.
The type of extension.
The name of the extension type to which this configuration applies.
A list of any of the specified extension configurations from the CloudFormation registry.
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 .
The Amazon Resource Name (ARN) for the configuration data, in this account and region.
The alias specified for this configuration, if one was specified when the configuration was set.
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 {} .
When the configuration data was last updated for this extension.
If a configuration hasn't been set for a specified extension, CloudFormation returns null .
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.
The name of the extension.
Whether this configuration data is the default configuration for the extension.
Exceptions
CloudFormation.Client.exceptions.TypeConfigurationNotFoundExceptionCloudFormation.Client.exceptions.CFNRegistryExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_update_stack(**kwargs)¶Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
Note
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
See also: AWS API Documentation
Request Syntax
response = client.cancel_update_stack(
StackName='string',
ClientRequestToken='string'
)
[REQUIRED]
The name or the unique stack ID that's associated with the stack.
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.None
Exceptions
CloudFormation.Client.exceptions.TokenAlreadyExistsExceptionclose()¶Closes underlying endpoint connections.
continue_update_rollback(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.continue_update_rollback(
StackName='string',
RoleARN='string',
ResourcesToSkip=[
'string',
],
ClientRequestToken='string'
)
[REQUIRED]
The name or the unique ID of the stack that you want to continue rolling back.
Note
Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).
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.
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.
Warning
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 .
Note
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy .
ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormationknows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received them.dict
Response Syntax
{}
Response Structure
(dict) --
The output for a ContinueUpdateRollback operation.
Exceptions
CloudFormation.Client.exceptions.TokenAlreadyExistsExceptioncreate_change_set(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_change_set(
StackName='string',
TemplateBody='string',
TemplateURL='string',
UsePreviousTemplate=True|False,
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
ResourceTypes=[
'string',
],
RoleARN='string',
RollbackConfiguration={
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
NotificationARNs=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ChangeSetName='string',
ClientToken='string',
Description='string',
ChangeSetType='CREATE'|'UPDATE'|'IMPORT',
ResourcesToImport=[
{
'ResourceType': 'string',
'LogicalResourceId': 'string',
'ResourceIdentifier': {
'string': 'string'
}
},
],
IncludeNestedStacks=True|False
)
[REQUIRED]
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.
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 .
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL .
A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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.CAPABILITY_NAMED_IAM .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.Note
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 .
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.
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.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
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.
The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
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.
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.
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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
[REQUIRED]
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.
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.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 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995`__ 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.
The resources to import into your stack.
Describes the target resource of an import operation.
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.
The logical ID of the target resource as specified in the template.
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 ).
False . To include nested sets in a change set, specify True .dict
Response Syntax
{
'Id': 'string',
'StackId': 'string'
}
Response Structure
(dict) --
The output for the CreateChangeSet action.
Id (string) --
The Amazon Resource Name (ARN) of the change set.
StackId (string) --
The unique ID of the stack.
Exceptions
CloudFormation.Client.exceptions.AlreadyExistsExceptionCloudFormation.Client.exceptions.InsufficientCapabilitiesExceptionCloudFormation.Client.exceptions.LimitExceededExceptioncreate_stack(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_stack(
StackName='string',
TemplateBody='string',
TemplateURL='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
DisableRollback=True|False,
RollbackConfiguration={
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
TimeoutInMinutes=123,
NotificationARNs=[
'string',
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
ResourceTypes=[
'string',
],
RoleARN='string',
OnFailure='DO_NOTHING'|'ROLLBACK'|'DELETE',
StackPolicyBody='string',
StackPolicyURL='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string',
EnableTerminationProtection=True|False
)
[REQUIRED]
The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
Note
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.
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.
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.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
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.
The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
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.
DisableRollback is not set or is set to false , the stack will be rolled back.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).
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.CAPABILITY_NAMED_IAM .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.Warning
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 .
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 .
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.
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
StackPolicyBody or the StackPolicyURL parameter, but not both.StackPolicyBody or the StackPolicyURL parameter, but not both.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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
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 .
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.
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
The output for a CreateStack action.
StackId (string) --
Unique identifier of the stack.
Exceptions
CloudFormation.Client.exceptions.LimitExceededExceptionCloudFormation.Client.exceptions.AlreadyExistsExceptionCloudFormation.Client.exceptions.TokenAlreadyExistsExceptionCloudFormation.Client.exceptions.InsufficientCapabilitiesExceptioncreate_stack_instances(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you want to create stack instances from.
[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.
[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.
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
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).[REQUIRED]
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
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:
UsePreviousValue as true . (You can't specify both a value and set UsePreviousValue to true .)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.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
Preferences for how CloudFormation performs this stack set operation.
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
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 .
This field is autopopulated if not provided.
[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.
SELF .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 .dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.OperationIdAlreadyExistsExceptionCloudFormation.Client.exceptions.StaleRequestExceptionCloudFormation.Client.exceptions.InvalidOperationExceptionCloudFormation.Client.exceptions.LimitExceededExceptioncreate_stack_set(**kwargs)¶Creates a stack set.
See also: AWS API Documentation
Request Syntax
response = client.create_stack_set(
StackSetName='string',
Description='string',
TemplateBody='string',
TemplateURL='string',
StackId='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AdministrationRoleARN='string',
ExecutionRoleName='string',
PermissionModel='SERVICE_MANAGED'|'SELF_MANAGED',
AutoDeployment={
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
CallAs='SELF'|'DELEGATED_ADMIN',
ClientRequestToken='string',
ManagedExecution={
'Active': True|False
}
)
[REQUIRED]
The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
Note
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.
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.
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.
The input parameters for the stack set template.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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.CAPABILITY_NAMED_IAM .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 .Warning
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.
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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
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 .
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.
Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions .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 .
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.
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 .
[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.
SELF .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.
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.
This field is autopopulated if not provided.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
Note
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.
dict
Response Syntax
{
'StackSetId': 'string'
}
Response Structure
(dict) --
StackSetId (string) --
The ID of the stack set that you're creating.
Exceptions
CloudFormation.Client.exceptions.NameAlreadyExistsExceptionCloudFormation.Client.exceptions.CreatedButModifiedExceptionCloudFormation.Client.exceptions.LimitExceededExceptiondeactivate_type(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.deactivate_type(
TypeName='string',
Type='RESOURCE'|'MODULE'|'HOOK',
Arn='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 .
The extension type.
Conditional: You must specify either Arn , or TypeName and Type .
The Amazon Resource Name (ARN) for the extension, in this account and region.
Conditional: You must specify either Arn , or TypeName and Type .
dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptiondelete_change_set(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_change_set(
ChangeSetName='string',
StackName='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
The output for the DeleteChangeSet action.
Exceptions
CloudFormation.Client.exceptions.InvalidChangeSetStatusExceptiondelete_stack(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_stack(
StackName='string',
RetainResources=[
'string',
],
RoleARN='string',
ClientRequestToken='string'
)
[REQUIRED]
The name or the unique stack ID that's associated with the stack.
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.
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.
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 .
None
Exceptions
CloudFormation.Client.exceptions.TokenAlreadyExistsExceptiondelete_stack_instances(**kwargs)¶Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
See also: AWS API Documentation
Request Syntax
response = client.delete_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
RetainStacks=True|False,
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you want to delete stack instances for.
[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.
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
You can specify Accounts or DeploymentTargets , but not both.
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
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).[REQUIRED]
The Amazon Web Services Regions where you want to delete stack set instances.
Preferences for how CloudFormation performs this stack set operation.
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
[REQUIRED]
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 .
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 .
This field is autopopulated if not provided.
[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.
SELF .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 .dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.OperationIdAlreadyExistsExceptionCloudFormation.Client.exceptions.StaleRequestExceptionCloudFormation.Client.exceptions.InvalidOperationExceptiondelete_stack_set(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_stack_set(
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets .
[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.
SELF .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 .dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.StackSetNotEmptyExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionderegister_type(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.deregister_type(
Arn='string',
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
VersionId='string'
)
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
The kind of extension.
Conditional: You must specify either TypeName and Type , or Arn .
The name of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptiondescribe_account_limits(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_account_limits(
NextToken='string'
)
{
'AccountLimits': [
{
'Name': 'string',
'Value': 123
},
],
'NextToken': 'string'
}
Response Structure
The output for the DescribeAccountLimits action.
An account limit structure that contain a list of CloudFormation account limits and their values.
The AccountLimit data type.
CloudFormation has the following limits per account:
For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide .
The name of the account limit.
Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
The value that's associated with the account limit name.
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.
describe_change_set(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_change_set(
ChangeSetName='string',
StackName='string',
NextToken='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
dict
Response Syntax
{
'ChangeSetName': 'string',
'ChangeSetId': 'string',
'StackId': 'string',
'StackName': 'string',
'Description': 'string',
'Parameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'OBSOLETE',
'Status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'FAILED',
'StatusReason': 'string',
'NotificationARNs': [
'string',
],
'RollbackConfiguration': {
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Changes': [
{
'Type': 'Resource',
'HookInvocationCount': 123,
'ResourceChange': {
'Action': 'Add'|'Modify'|'Remove'|'Import'|'Dynamic',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Replacement': 'True'|'False'|'Conditional',
'Scope': [
'Properties'|'Metadata'|'CreationPolicy'|'UpdatePolicy'|'DeletionPolicy'|'Tags',
],
'Details': [
{
'Target': {
'Attribute': 'Properties'|'Metadata'|'CreationPolicy'|'UpdatePolicy'|'DeletionPolicy'|'Tags',
'Name': 'string',
'RequiresRecreation': 'Never'|'Conditionally'|'Always'
},
'Evaluation': 'Static'|'Dynamic',
'ChangeSource': 'ResourceReference'|'ParameterReference'|'ResourceAttribute'|'DirectModification'|'Automatic',
'CausingEntity': 'string'
},
],
'ChangeSetId': 'string',
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
}
},
],
'NextToken': 'string',
'IncludeNestedStacks': True|False,
'ParentChangeSetId': 'string',
'RootChangeSetId': 'string'
}
Response Structure
(dict) --
The output for the DescribeChangeSet action.
ChangeSetName (string) --
The name of the change set.
ChangeSetId (string) --
The Amazon Resource Name (ARN) of the change set.
StackId (string) --
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
StackName (string) --
The name of the stack that's associated with the change set.
Description (string) --
Information about the change set.
Parameters (list) --
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.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
CreationTime (datetime) --
The start time when the change set was created, in UTC.
ExecutionStatus (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.
Status (string) --
The current status of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .
StatusReason (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.
NotificationARNs (list) --
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
RollbackConfiguration (dict) --
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
RollbackTriggers (list) --
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
(dict) --
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.
Arn (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 (string) --
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
MonitoringTimeInMinutes (integer) --
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.
Capabilities (list) --
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
Tags (list) --
If you execute the change set, the tags that will be associated with the stack.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
Changes (list) --
A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
(dict) --
The Change structure describes the changes CloudFormation will perform if you execute the change set.
Type (string) --
The type of entity that CloudFormation changes. Currently, the only entity type is Resource .
HookInvocationCount (integer) --
Is either null , if no hooks invoke for the resource, or contains the number of hooks that will invoke for the resource.
ResourceChange (dict) --
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
Action (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).
LogicalResourceId (string) --
The resource's logical ID, which is defined in the stack's template.
PhysicalResourceId (string) --
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
ResourceType (string) --
The type of CloudFormation resource, such as AWS::S3::Bucket .
Replacement (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 .
Scope (list) --
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 .
Details (list) --
For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.
(dict) --
For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.
Target (dict) --
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.
Attribute (string) --
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata , Properties , or Tags .
Name (string) --
If the Attribute value is Properties , the name of the property. For all other attributes, the value is null.
RequiresRecreation (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.
Evaluation (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.
ChangeSource (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.CausingEntity (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 .
ChangeSetId (string) --
The change set ID of the nested change set.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
NextToken (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.
IncludeNestedStacks (boolean) --
Verifies if IncludeNestedStacks is set to True .
ParentChangeSetId (string) --
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
RootChangeSetId (string) --
Specifies the change set ID of the root change set in the current nested change set hierarchy.
Exceptions
CloudFormation.Client.exceptions.ChangeSetNotFoundExceptiondescribe_change_set_hooks(**kwargs)¶Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
See also: AWS API Documentation
Request Syntax
response = client.describe_change_set_hooks(
ChangeSetName='string',
StackName='string',
NextToken='string',
LogicalResourceId='string'
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.LogicalResourceId .dict
Response Syntax
{
'ChangeSetId': 'string',
'ChangeSetName': 'string',
'Hooks': [
{
'InvocationPoint': 'PRE_PROVISION',
'FailureMode': 'FAIL'|'WARN',
'TypeName': 'string',
'TypeVersionId': 'string',
'TypeConfigurationVersionId': 'string',
'TargetDetails': {
'TargetType': 'RESOURCE',
'ResourceTargetDetails': {
'LogicalResourceId': 'string',
'ResourceType': 'string',
'ResourceAction': 'Add'|'Modify'|'Remove'|'Import'|'Dynamic'
}
}
},
],
'Status': 'PLANNING'|'PLANNED'|'UNAVAILABLE',
'NextToken': 'string',
'StackId': 'string',
'StackName': 'string'
}
Response Structure
(dict) --
ChangeSetId (string) --
The change set identifier (stack ID).
ChangeSetName (string) --
The change set name.
Hooks (list) --
List of hook objects.
(dict) --
Specifies the resource, the hook, and the hook version to be invoked.
InvocationPoint (string) --
Specifies the points in provisioning logic where a hook is invoked.
FailureMode (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.TypeName (string) --
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook .
Note
The following organization namespaces are reserved and can't be used in your hook type names:
AlexaAMZNAmazonASKAWSCustomDevTypeVersionId (string) --
The version ID of the type specified.
TypeConfigurationVersionId (string) --
The version ID of the type configuration.
TargetDetails (dict) --
Specifies details about the target that the hook will run against.
TargetType (string) --
The name of the type.
ResourceTargetDetails (dict) --
Required if TargetType is RESOURCE .
LogicalResourceId (string) --
The resource's logical ID, which is defined in the stack's template.
ResourceType (string) --
The type of CloudFormation resource, such as AWS::S3::Bucket .
ResourceAction (string) --
Specifies the action of the resource.
Status (string) --
Provides the status of the change set hook.
NextToken (string) --
Pagination token, null or empty if no more results.
StackId (string) --
The stack identifier (stack ID).
StackName (string) --
The stack name.
Exceptions
CloudFormation.Client.exceptions.ChangeSetNotFoundExceptiondescribe_publisher(**kwargs)¶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:
See also: AWS API Documentation
Request Syntax
response = client.describe_publisher(
PublisherId='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.
{
'PublisherId': 'string',
'PublisherStatus': 'VERIFIED'|'UNVERIFIED',
'IdentityProvider': 'AWS_Marketplace'|'GitHub'|'Bitbucket',
'PublisherProfile': 'string'
}
Response Structure
The ID of the extension publisher.
Whether the publisher is verified. Currently, all registered publishers are verified.
The type of account used as the identity provider when registering this publisher with CloudFormation.
The URL to the publisher's profile with the identity provider.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptiondescribe_stack_drift_detection_status(**kwargs)¶Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_drift_detection_status(
StackDriftDetectionId='string'
)
[REQUIRED]
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.
{
'StackId': 'string',
'StackDriftDetectionId': 'string',
'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'DetectionStatus': 'DETECTION_IN_PROGRESS'|'DETECTION_FAILED'|'DETECTION_COMPLETE',
'DetectionStatusReason': 'string',
'DriftedStackResourceCount': 123,
'Timestamp': datetime(2015, 1, 1)
}
Response Structure
The ID of the stack.
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.
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.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.The reason the stack drift detection operation has its current status.
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 .
Time at which the stack drift detection operation was initiated.
describe_stack_events(**kwargs)¶Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the CloudFormation User Guide.
Note
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_events(
StackName='string',
NextToken='string'
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
dict
Response Syntax
{
'StackEvents': [
{
'StackId': 'string',
'EventId': 'string',
'StackName': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Timestamp': datetime(2015, 1, 1),
'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',
'ResourceProperties': 'string',
'ClientRequestToken': 'string',
'HookType': 'string',
'HookStatus': 'HOOK_IN_PROGRESS'|'HOOK_COMPLETE_SUCCEEDED'|'HOOK_COMPLETE_FAILED'|'HOOK_FAILED',
'HookStatusReason': 'string',
'HookInvocationPoint': 'PRE_PROVISION',
'HookFailureMode': 'FAIL'|'WARN'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for a DescribeStackEvents action.
StackEvents (list) --
A list of StackEvents structures.
(dict) --
The StackEvent data type.
StackId (string) --
The unique ID name of the instance of the stack.
EventId (string) --
The unique ID of this event.
StackName (string) --
The name associated with a stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier associated with the physical instance of the resource.
ResourceType (string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
Timestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
ResourceProperties (string) --
BLOB of the properties used to create the resource.
ClientRequestToken (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 .
HookType (string) --
The name of the hook.
HookStatus (string) --
Provides the status of the change set hook.
HookStatusReason (string) --
Provides the reason for the hook status.
HookInvocationPoint (string) --
Invocation points are points in provisioning logic where hooks are initiated.
HookFailureMode (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.NextToken (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.
describe_stack_instance(**kwargs)¶Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances .
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_instance(
StackSetName='string',
StackInstanceAccount='string',
StackInstanceRegion='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or the unique stack ID of the stack set that you want to get stack instance information for.
[REQUIRED]
The ID of an Amazon Web Services account that's associated with this stack instance.
[REQUIRED]
The name of a Region that's associated with this stack instance.
[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.
SELF .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 .dict
Response Syntax
{
'StackInstance': {
'StackSetId': 'string',
'Region': 'string',
'Account': 'string',
'StackId': 'string',
'ParameterOverrides': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'Status': 'CURRENT'|'OUTDATED'|'INOPERABLE',
'StackInstanceStatus': {
'DetailedStatus': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'|'INOPERABLE'
},
'StatusReason': 'string',
'OrganizationalUnitId': 'string',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'LastOperationId': 'string'
}
}
Response Structure
(dict) --
StackInstance (dict) --
The stack instance that matches the specified request parameters.
StackSetId (string) --
The name or unique ID of the stack set that the stack instance is associated with.
Region (string) --
The name of the Amazon Web Services Region that the stack instance is associated with.
Account (string) --
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
StackId (string) --
The ID of the stack instance.
ParameterOverrides (list) --
A list of parameters from the stack set template whose values have been overridden in this stack instance.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
Status (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.OUTDATED : The stack isn't currently up to date with the stack set because:CreateStackSet or UpdateStackSet operation.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.StackInstanceStatus (dict) --
The detailed status of the stack instance.
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.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.SUCCEEDED : The operation in the specified account and Region completed successfully.StatusReason (string) --
The explanation for the specific status code that's assigned to this stack instance.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
DriftStatus (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 (datetime) --
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 (string) --
The last unique ID of a StackSet operation performed on a stack instance.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.StackInstanceNotFoundExceptiondescribe_stack_resource(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_resource(
StackName='string',
LogicalResourceId='string'
)
[REQUIRED]
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
[REQUIRED]
The logical name of the resource as specified in the template.
Default: There is no default value.
dict
Response Syntax
{
'StackResourceDetail': {
'StackName': 'string',
'StackId': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'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',
'Description': 'string',
'Metadata': 'string',
'DriftInformation': {
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
},
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
}
}
Response Structure
(dict) --
The output for a DescribeStackResource action.
StackResourceDetail (dict) --
A StackResourceDetail structure containing the description of the specified resource in the specified stack.
StackName (string) --
The name associated with the stack.
StackId (string) --
Unique identifier of the stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
ResourceType (string) --
Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
LastUpdatedTimestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
Description (string) --
User defined description associated with the resource.
Metadata (string) --
The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.
DriftInformation (dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
describe_stack_resource_drifts(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_resource_drifts(
StackName='string',
StackResourceDriftStatusFilters=[
'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the stack for which you want drift information.
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.NextToken value that you can assign to the NextToken request parameter to get the next set of results.dict
Response Syntax
{
'StackResourceDrifts': [
{
'StackId': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'PhysicalResourceIdContext': [
{
'Key': 'string',
'Value': 'string'
},
],
'ResourceType': 'string',
'ExpectedProperties': 'string',
'ActualProperties': 'string',
'PropertyDifferences': [
{
'PropertyPath': 'string',
'ExpectedValue': 'string',
'ActualValue': 'string',
'DifferenceType': 'ADD'|'REMOVE'|'NOT_EQUAL'
},
],
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'Timestamp': datetime(2015, 1, 1),
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StackResourceDrifts (list) --
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 .
(dict) --
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.
StackId (string) --
The ID of the stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
PhysicalResourceIdContext (list) --
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.
(dict) --
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.
Key (string) --
The resource context key.
Value (string) --
The resource context value.
ResourceType (string) --
The type of the resource.
ExpectedProperties (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.
ActualProperties (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.
PropertyDifferences (list) --
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 .
(dict) --
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 .
PropertyPath (string) --
The fully-qualified path to the resource property.
ExpectedValue (string) --
The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.
ActualValue (string) --
The actual property value of the resource property.
DifferenceType (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).StackResourceDriftStatus (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 (datetime) --
Time at which CloudFormation performed drift detection on the stack resource.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
NextToken (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 .
describe_stack_resources(**kwargs)¶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.
Note
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 .
Note
A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_resources(
StackName='string',
LogicalResourceId='string',
PhysicalResourceId='string'
)
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Default: There is no default value.
Required: Conditional. If you don't specify StackName , you must specify PhysicalResourceId .
The logical name of the resource as specified in the template.
Default: There is no default value.
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.
dict
Response Syntax
{
'StackResources': [
{
'StackName': 'string',
'StackId': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Timestamp': datetime(2015, 1, 1),
'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',
'Description': 'string',
'DriftInformation': {
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
},
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
},
]
}
Response Structure
(dict) --
The output for a DescribeStackResources action.
StackResources (list) --
A list of StackResource structures.
(dict) --
The StackResource data type.
StackName (string) --
The name associated with the stack.
StackId (string) --
Unique identifier of the stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
ResourceType (string) --
Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
Timestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
Description (string) --
User defined description associated with the resource.
DriftInformation (dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
describe_stack_set(**kwargs)¶Returns the description of the specified stack set.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_set(
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set whose description you want.
[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.
SELF .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 .dict
Response Syntax
{
'StackSet': {
'StackSetName': 'string',
'StackSetId': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'DELETED',
'TemplateBody': 'string',
'Parameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'StackSetARN': 'string',
'AdministrationRoleARN': 'string',
'ExecutionRoleName': 'string',
'StackSetDriftDetectionDetails': {
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'NOT_CHECKED',
'DriftDetectionStatus': 'COMPLETED'|'FAILED'|'PARTIAL_SUCCESS'|'IN_PROGRESS'|'STOPPED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'TotalStackInstancesCount': 123,
'DriftedStackInstancesCount': 123,
'InSyncStackInstancesCount': 123,
'InProgressStackInstancesCount': 123,
'FailedStackInstancesCount': 123
},
'AutoDeployment': {
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
'PermissionModel': 'SERVICE_MANAGED'|'SELF_MANAGED',
'OrganizationalUnitIds': [
'string',
],
'ManagedExecution': {
'Active': True|False
}
}
}
Response Structure
(dict) --
StackSet (dict) --
The specified stack set.
StackSetName (string) --
The name that's associated with the stack set.
StackSetId (string) --
The ID of the stack set.
Description (string) --
A description of the stack set that you specify when the stack set is created or updated.
Status (string) --
The status of the stack set.
TemplateBody (string) --
The structure that contains the body of the template that was used to create or update the stack set.
Parameters (list) --
A list of input parameters for a stack set.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
Capabilities (list) --
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.
Tags (list) --
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
StackSetARN (string) --
The Amazon Resource Name (ARN) of the stack set.
AdministrationRoleARN (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 .
ExecutionRoleName (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.
StackSetDriftDetectionDetails (dict) --
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.
DriftStatus (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.DriftDetectionStatus (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.LastDriftCheckTimestamp (datetime) --
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 (integer) --
The total number of stack instances belonging to this stack set.
The total number of stack instances is equal to the total of:
DriftedStackInstancesCount (integer) --
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.
InSyncStackInstancesCount (integer) --
The number of stack instances which match the expected template and parameter configuration of the stack set.
InProgressStackInstancesCount (integer) --
The number of stack instances that are currently being checked for drift.
FailedStackInstancesCount (integer) --
The number of stack instances for which the drift detection operation failed.
AutoDeployment (dict) --
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
Enabled (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 (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 .
PermissionModel (string) --
Describes how the IAM roles required for stack set operations are created.
self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions .OrganizationalUnitIds (list) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
ManagedExecution (dict) --
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Active (boolean) --
When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
Note
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.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptiondescribe_stack_set_operation(**kwargs)¶Returns the description of the specified stack set operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_stack_set_operation(
StackSetName='string',
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or the unique stack ID of the stack set for the stack operation.
[REQUIRED]
The unique ID of the stack set operation.
[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.
SELF .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 .dict
Response Syntax
{
'StackSetOperation': {
'OperationId': 'string',
'StackSetId': 'string',
'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED',
'OperationPreferences': {
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
'RetainStacks': True|False,
'AdministrationRoleARN': 'string',
'ExecutionRoleName': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'DeploymentTargets': {
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
'StackSetDriftDetectionDetails': {
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'NOT_CHECKED',
'DriftDetectionStatus': 'COMPLETED'|'FAILED'|'PARTIAL_SUCCESS'|'IN_PROGRESS'|'STOPPED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'TotalStackInstancesCount': 123,
'DriftedStackInstancesCount': 123,
'InSyncStackInstancesCount': 123,
'InProgressStackInstancesCount': 123,
'FailedStackInstancesCount': 123
},
'StatusReason': 'string',
'StatusDetails': {
'FailedStackInstancesCount': 123
}
}
}
Response Structure
(dict) --
StackSetOperation (dict) --
The specified stack set operation.
OperationId (string) --
The unique ID of a stack set operation.
StackSetId (string) --
The ID of the stack set.
Action (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.
Status (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.OperationPreferences (dict) --
The preferences for how CloudFormation performs this stack set operation.
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions in where you want to perform the stack operation.
FailureToleranceCount (integer) --
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 (integer) --
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 (integer) --
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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 (integer) --
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.
RetainStacks (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.
AdministrationRoleARN (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 .
ExecutionRoleName (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.
CreationTimestamp (datetime) --
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 (datetime) --
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.
DeploymentTargets (dict) --
[Service-managed permissions] The Organizations accounts affected by the stack operation.
Accounts (list) --
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
AccountsUrl (string) --
Returns the value of the AccountsUrl property.
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
AccountFilterType (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).StackSetDriftDetectionDetails (dict) --
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.
DriftStatus (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.DriftDetectionStatus (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.LastDriftCheckTimestamp (datetime) --
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 (integer) --
The total number of stack instances belonging to this stack set.
The total number of stack instances is equal to the total of:
DriftedStackInstancesCount (integer) --
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.
InSyncStackInstancesCount (integer) --
The number of stack instances which match the expected template and parameter configuration of the stack set.
InProgressStackInstancesCount (integer) --
The number of stack instances that are currently being checked for drift.
FailedStackInstancesCount (integer) --
The number of stack instances for which the drift detection operation failed.
StatusReason (string) --
The status of the operation in details.
StatusDetails (dict) --
Detailed information about the StackSet operation.
FailedStackInstancesCount (integer) --
The number of stack instances for which the StackSet operation failed.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationNotFoundExceptiondescribe_stacks(**kwargs)¶Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
Note
If the stack doesn't exist, an ValidationError is returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_stacks(
StackName='string',
NextToken='string'
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
dict
Response Syntax
{
'Stacks': [
{
'StackId': 'string',
'StackName': 'string',
'ChangeSetId': 'string',
'Description': 'string',
'Parameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'RollbackConfiguration': {
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
'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',
'DisableRollback': True|False,
'NotificationARNs': [
'string',
],
'TimeoutInMinutes': 123,
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'Outputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string',
'ExportName': 'string'
},
],
'RoleARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EnableTerminationProtection': True|False,
'ParentId': 'string',
'RootId': 'string',
'DriftInformation': {
'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for a DescribeStacks action.
Stacks (list) --
A list of stack structures.
(dict) --
The Stack data type.
StackId (string) --
Unique identifier of the stack.
StackName (string) --
The name associated with the stack.
ChangeSetId (string) --
The unique ID of the change set.
Description (string) --
A user-defined description associated with the stack.
Parameters (list) --
A list of Parameter structures.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
CreationTime (datetime) --
The time at which the stack was created.
DeletionTime (datetime) --
The time the stack was deleted.
LastUpdatedTime (datetime) --
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
RollbackConfiguration (dict) --
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
RollbackTriggers (list) --
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
(dict) --
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.
Arn (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 (string) --
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
MonitoringTimeInMinutes (integer) --
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.
StackStatus (string) --
Current status of the stack.
StackStatusReason (string) --
Success/failure message associated with the stack status.
DisableRollback (boolean) --
Boolean to enable or disable rollback on stack creation failures:
true : disable rollback.false : enable rollback.NotificationARNs (list) --
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
TimeoutInMinutes (integer) --
The amount of time within which stack creation should complete.
Capabilities (list) --
The capabilities allowed in the stack.
Outputs (list) --
A list of output structures.
(dict) --
The Output data type.
OutputKey (string) --
The key associated with the output.
OutputValue (string) --
The value associated with the output.
Description (string) --
User defined description associated with the output.
ExportName (string) --
The name of the export associated with the output.
RoleARN (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.
Tags (list) --
A list of Tag s that specify information about the stack.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
EnableTerminationProtection (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 .
ParentId (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 (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 .
DriftInformation (dict) --
Information about whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources .
StackDriftStatus (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.LastCheckTimestamp (datetime) --
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
NextToken (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.
describe_type(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_type(
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
Arn='string',
VersionId='string',
PublisherId='string',
PublicVersionNumber='string'
)
The kind of extension.
Conditional: You must specify either TypeName and Type , or Arn .
The name of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
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.
The publisher ID of the extension publisher.
Extensions provided by Amazon Web Services are not assigned a publisher ID.
dict
Response Syntax
{
'Arn': 'string',
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string',
'DefaultVersionId': 'string',
'IsDefaultVersion': True|False,
'TypeTestsStatus': 'PASSED'|'FAILED'|'IN_PROGRESS'|'NOT_TESTED',
'TypeTestsStatusDescription': 'string',
'Description': 'string',
'Schema': 'string',
'ProvisioningType': 'NON_PROVISIONABLE'|'IMMUTABLE'|'FULLY_MUTABLE',
'DeprecatedStatus': 'LIVE'|'DEPRECATED',
'LoggingConfig': {
'LogRoleArn': 'string',
'LogGroupName': 'string'
},
'RequiredActivatedTypes': [
{
'TypeNameAlias': 'string',
'OriginalTypeName': 'string',
'PublisherId': 'string',
'SupportedMajorVersions': [
123,
]
},
],
'ExecutionRoleArn': 'string',
'Visibility': 'PUBLIC'|'PRIVATE',
'SourceUrl': 'string',
'DocumentationUrl': 'string',
'LastUpdated': datetime(2015, 1, 1),
'TimeCreated': datetime(2015, 1, 1),
'ConfigurationSchema': 'string',
'PublisherId': 'string',
'OriginalTypeName': 'string',
'OriginalTypeArn': 'string',
'PublicVersionNumber': 'string',
'LatestPublicVersion': 'string',
'IsActivated': True|False,
'AutoUpdate': True|False
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the extension.
Type (string) --
The kind of extension.
TypeName (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 .
DefaultVersionId (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 `` .
IsDefaultVersion (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 .
TypeTestsStatus (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 (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.
Description (string) --
The description of the extension.
Schema (string) --
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide .
ProvisioningType (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.DeprecatedStatus (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 .
LoggingConfig (dict) --
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 .
LogRoleArn (string) --
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
LogGroupName (string) --
The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
RequiredActivatedTypes (list) --
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.
(dict) --
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 .
TypeNameAlias (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.
OriginalTypeName (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 (string) --
The publisher ID of the extension publisher.
SupportedMajorVersions (list) --
A list of the major versions of the extension type that the macro supports.
ExecutionRoleArn (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.
Visibility (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.SourceUrl (string) --
The URL of the source code for the extension.
DocumentationUrl (string) --
The URL of a page providing detailed documentation for this extension.
LastUpdated (datetime) --
When the specified extension version was registered. This applies only to:
TimeCreated (datetime) --
When the specified private extension version was registered or activated in your account.
ConfigurationSchema (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 .
PublisherId (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 .
OriginalTypeName (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 .
OriginalTypeArn (string) --
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.
PublicVersionNumber (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 .
LatestPublicVersion (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 .
IsActivated (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 .
AutoUpdate (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 .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptiondescribe_type_registration(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_type_registration(
RegistrationToken='string'
)
[REQUIRED]
The identifier for this registration request.
This registration token is generated by CloudFormation when you initiate a registration request using `` RegisterType `` .
{
'ProgressStatus': 'COMPLETE'|'IN_PROGRESS'|'FAILED',
'Description': 'string',
'TypeArn': 'string',
'TypeVersionArn': 'string'
}
Response Structure
The current status of the extension registration request.
The description of the extension registration request.
The Amazon Resource Name (ARN) of the extension being registered.
For registration requests with a ProgressStatus of other than COMPLETE , this will be null .
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 .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptiondetect_stack_drift(**kwargs)¶Detects whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see 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 .
DetectStackDriftcan 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.
See also: AWS API Documentation
Request Syntax
response = client.detect_stack_drift(
StackName='string',
LogicalResourceIds=[
'string',
]
)
[REQUIRED]
The name of the stack for which you want to detect drift.
The logical names of any resources you want to use as filters.
dict
Response Syntax
{
'StackDriftDetectionId': 'string'
}
Response Structure
(dict) --
StackDriftDetectionId (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.
detect_stack_resource_drift(**kwargs)¶Returns information about whether a resource's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see 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 .
See also: AWS API Documentation
Request Syntax
response = client.detect_stack_resource_drift(
StackName='string',
LogicalResourceId='string'
)
[REQUIRED]
The name of the stack to which the resource belongs.
[REQUIRED]
The logical name of the resource for which to return drift information.
dict
Response Syntax
{
'StackResourceDrift': {
'StackId': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'PhysicalResourceIdContext': [
{
'Key': 'string',
'Value': 'string'
},
],
'ResourceType': 'string',
'ExpectedProperties': 'string',
'ActualProperties': 'string',
'PropertyDifferences': [
{
'PropertyPath': 'string',
'ExpectedValue': 'string',
'ActualValue': 'string',
'DifferenceType': 'ADD'|'REMOVE'|'NOT_EQUAL'
},
],
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'Timestamp': datetime(2015, 1, 1),
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
}
}
Response Structure
(dict) --
StackResourceDrift (dict) --
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.
StackId (string) --
The ID of the stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
PhysicalResourceIdContext (list) --
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.
(dict) --
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.
Key (string) --
The resource context key.
Value (string) --
The resource context value.
ResourceType (string) --
The type of the resource.
ExpectedProperties (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.
ActualProperties (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.
PropertyDifferences (list) --
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 .
(dict) --
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 .
PropertyPath (string) --
The fully-qualified path to the resource property.
ExpectedValue (string) --
The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.
ActualValue (string) --
The actual property value of the resource property.
DifferenceType (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).StackResourceDriftStatus (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 (datetime) --
Time at which CloudFormation performed drift detection on the stack resource.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
detect_stack_set_drift(**kwargs)¶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 .
DetectStackSetDriftreturns theOperationIdof 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:
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 `` .
See also: AWS API Documentation
Request Syntax
response = client.detect_stack_set_drift(
StackSetName='string',
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name of the stack set on which to perform the drift detection operation.
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options .
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
The ID of the stack set operation.
This field is autopopulated if not provided.
[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.
SELF .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 .dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (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.
Exceptions
CloudFormation.Client.exceptions.InvalidOperationExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.StackSetNotFoundExceptionestimate_template_cost(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.estimate_template_cost(
TemplateBody='string',
TemplateURL='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': '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.
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.
Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.
A list of Parameter structures that specify input parameters.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
dict
Response Syntax
{
'Url': 'string'
}
Response Structure
(dict) --
The output for a EstimateTemplateCost action.
Url (string) --
An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
execute_change_set(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.execute_change_set(
ChangeSetName='string',
StackName='string',
ClientRequestToken='string',
DisableRollback=True|False
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
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.Preserves the state of previously provisioned resources when an operation fails.
Default: True
dict
Response Syntax
{}
Response Structure
(dict) --
The output for the ExecuteChangeSet action.
Exceptions
CloudFormation.Client.exceptions.InvalidChangeSetStatusExceptionCloudFormation.Client.exceptions.ChangeSetNotFoundExceptionCloudFormation.Client.exceptions.InsufficientCapabilitiesExceptionCloudFormation.Client.exceptions.TokenAlreadyExistsExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_stack_policy(**kwargs)¶Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
See also: AWS API Documentation
Request Syntax
response = client.get_stack_policy(
StackName='string'
)
[REQUIRED]
The name or unique stack ID that's associated with the stack whose policy you want to get.
{
'StackPolicyBody': 'string'
}
Response Structure
The output for the GetStackPolicy action.
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide.)
get_template(**kwargs)¶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.
Note
If the template doesn't exist, a ValidationError is returned.
See also: AWS API Documentation
Request Syntax
response = client.get_template(
StackName='string',
ChangeSetName='string',
TemplateStage='Original'|'Processed'
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
StackName .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 .
dict
Response Syntax
{
'TemplateBody': {},
'StagesAvailable': [
'Original'|'Processed',
]
}
Response Structure
(dict) --
The output for GetTemplate action.
TemplateBody (dict) --
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.
StagesAvailable (list) --
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.
Exceptions
CloudFormation.Client.exceptions.ChangeSetNotFoundExceptionget_template_summary(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_template_summary(
TemplateBody='string',
TemplateURL='string',
StackName='string',
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
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 .
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.
Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .
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 .
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 .
[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.
SELF .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 .dict
Response Syntax
{
'Parameters': [
{
'ParameterKey': 'string',
'DefaultValue': 'string',
'ParameterType': 'string',
'NoEcho': True|False,
'Description': 'string',
'ParameterConstraints': {
'AllowedValues': [
'string',
]
}
},
],
'Description': 'string',
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'CapabilitiesReason': 'string',
'ResourceTypes': [
'string',
],
'Version': 'string',
'Metadata': 'string',
'DeclaredTransforms': [
'string',
],
'ResourceIdentifierSummaries': [
{
'ResourceType': 'string',
'LogicalResourceIds': [
'string',
],
'ResourceIdentifiers': [
'string',
]
},
]
}
Response Structure
(dict) --
The output for the GetTemplateSummary action.
Parameters (list) --
A list of parameter declarations that describe various properties for each parameter.
(dict) --
The ParameterDeclaration data type.
ParameterKey (string) --
The name that's associated with the parameter.
DefaultValue (string) --
The default value of the parameter.
ParameterType (string) --
The type of parameter.
NoEcho (boolean) --
Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.
Description (string) --
The description that's associate with the parameter.
ParameterConstraints (dict) --
The criteria that CloudFormation uses to validate parameter values.
AllowedValues (list) --
A list of values that are permitted for a parameter.
Description (string) --
The value that's defined in the Description property of the template.
Capabilities (list) --
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 (string) --
The list of resources that generated the values in the Capabilities response element.
ResourceTypes (list) --
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 (string) --
The Amazon Web Services template format version, which identifies the capabilities of the template.
Metadata (string) --
The value that's defined for the Metadata property of the template.
DeclaredTransforms (list) --
A list of the transforms that are declared in the template.
ResourceIdentifierSummaries (list) --
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.
(dict) --
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.
ResourceType (string) --
The template resource type of the target resources, such as AWS::S3::Bucket .
LogicalResourceIds (list) --
The logical IDs of the target resources of the specified ResourceType , as defined in the import template.
ResourceIdentifiers (list) --
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.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_stacks_to_stack_set(**kwargs)¶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.
Note
ImportStacksToStackSet is only supported by self-managed permissions.
See also: AWS API Documentation
Request Syntax
response = client.import_stacks_to_stack_set(
StackSetName='string',
StackIds=[
'string',
],
StackIdsUrl='string',
OrganizationalUnitIds=[
'string',
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name of the stack set. The name must be unique in the Region where you create your stack set.
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 .
The Amazon S3 URL which contains list of stack ids to be inputted.
Specify either StackIds or StackIdsUrl .
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options .
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
A unique, user defined, identifier for the stack set operation.
This field is autopopulated if not provided.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
SELF .DELEGATED_ADMIN .dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for the stack set operation.
Exceptions
CloudFormation.Client.exceptions.LimitExceededExceptionCloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.InvalidOperationExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.OperationIdAlreadyExistsExceptionCloudFormation.Client.exceptions.StackNotFoundExceptionCloudFormation.Client.exceptions.StaleRequestExceptionlist_change_sets(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_change_sets(
StackName='string',
NextToken='string'
)
[REQUIRED]
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
dict
Response Syntax
{
'Summaries': [
{
'StackId': 'string',
'StackName': 'string',
'ChangeSetId': 'string',
'ChangeSetName': 'string',
'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'OBSOLETE',
'Status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'FAILED',
'StatusReason': 'string',
'CreationTime': datetime(2015, 1, 1),
'Description': 'string',
'IncludeNestedStacks': True|False,
'ParentChangeSetId': 'string',
'RootChangeSetId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for the ListChangeSets action.
Summaries (list) --
A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
(dict) --
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.
StackId (string) --
The ID of the stack with which the change set is associated.
StackName (string) --
The name of the stack with which the change set is associated.
ChangeSetId (string) --
The ID of the change set.
ChangeSetName (string) --
The name of the change set.
ExecutionStatus (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.
Status (string) --
The state of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .
StatusReason (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.
CreationTime (datetime) --
The start time when the change set was created, in UTC.
Description (string) --
Descriptive information about the change set.
IncludeNestedStacks (boolean) --
Specifies the current setting of IncludeNestedStacks for the change set.
ParentChangeSetId (string) --
The parent change set ID.
RootChangeSetId (string) --
The root change set ID.
NextToken (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 .
list_exports(**kwargs)¶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 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html`__ function.
For more information, see CloudFormation export stack output values .
See also: AWS API Documentation
Request Syntax
response = client.list_exports(
NextToken='string'
)
{
'Exports': [
{
'ExportingStackId': 'string',
'Name': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
The output for the ListExports action.
The Export structure describes the exported output values for a stack.
The stack that contains the exported output name and value.
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.
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.
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.
list_imports(**kwargs)¶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 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html`__ function.
See also: AWS API Documentation
Request Syntax
response = client.list_imports(
ExportName='string',
NextToken='string'
)
[REQUIRED]
The name of the exported output value. CloudFormation returns the stack names that are importing this value.
dict
Response Syntax
{
'Imports': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Imports (list) --
A list of stack names that are importing the specified exported output value.
NextToken (string) --
A string that identifies the next page of exports. If there is no additional page, this value is null.
list_stack_instances(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_stack_instances(
StackSetName='string',
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'DETAILED_STATUS'|'LAST_OPERATION_ID',
'Values': 'string'
},
],
StackInstanceAccount='string',
StackInstanceRegion='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you want to list stack instances for.
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 .NextToken value that you can assign to the NextToken request parameter to get the next set of results.The filter to apply to stack instances
The filter to apply to stack instances
The type of filter to apply.
The status to filter by.
[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.
SELF .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 .dict
Response Syntax
{
'Summaries': [
{
'StackSetId': 'string',
'Region': 'string',
'Account': 'string',
'StackId': 'string',
'Status': 'CURRENT'|'OUTDATED'|'INOPERABLE',
'StatusReason': 'string',
'StackInstanceStatus': {
'DetailedStatus': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'|'INOPERABLE'
},
'OrganizationalUnitId': 'string',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'LastOperationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackInstanceSummary structures that contain information about the specified stack instances.
(dict) --
The structure that contains summary information about a stack instance.
StackSetId (string) --
The name or unique ID of the stack set that the stack instance is associated with.
Region (string) --
The name of the Amazon Web Services Region that the stack instance is associated with.
Account (string) --
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
StackId (string) --
The ID of the stack instance.
Status (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.OUTDATED : The stack isn't currently up to date with the stack set because:CreateStackSet or UpdateStackSet operation.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 (string) --
The explanation for the specific status code assigned to this stack instance.
StackInstanceStatus (dict) --
The detailed status of the stack instance.
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.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.SUCCEEDED : The operation in the specified account and Region completed successfully.OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
DriftStatus (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 (datetime) --
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 (string) --
The last unique ID of a StackSet operation performed on a stack instance.
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionlist_stack_resources(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_stack_resources(
StackName='string',
NextToken='string'
)
[REQUIRED]
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Default: There is no default value.
dict
Response Syntax
{
'StackResourceSummaries': [
{
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'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',
'DriftInformation': {
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
},
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for a ListStackResources action.
StackResourceSummaries (list) --
A list of StackResourceSummary structures.
(dict) --
Contains high-level information about the specified stack resource.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of the resource.
ResourceType (string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
LastUpdatedTimestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
DriftInformation (dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
NextToken (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.
list_stack_set_operation_results(**kwargs)¶Returns summary information about the results of a stack set operation.
See also: AWS API Documentation
Request Syntax
response = client.list_stack_set_operation_results(
StackSetName='string',
OperationId='string',
NextToken='string',
MaxResults=123,
CallAs='SELF'|'DELEGATED_ADMIN',
Filters=[
{
'Name': 'OPERATION_RESULT_STATUS',
'Values': 'string'
},
]
)
[REQUIRED]
The name or unique ID of the stack set that you want to get operation results for.
[REQUIRED]
The ID of the stack set operation.
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 .NextToken value that you can assign to the NextToken request parameter to get the next set of results.[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.
SELF .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 .The filter to apply to operation results.
The status that operation results are filtered by.
The type of filter to apply.
The value to filter by.
dict
Response Syntax
{
'Summaries': [
{
'Account': 'string',
'Region': 'string',
'Status': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
'StatusReason': 'string',
'AccountGateResult': {
'Status': 'SUCCEEDED'|'FAILED'|'SKIPPED',
'StatusReason': 'string'
},
'OrganizationalUnitId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
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.
(dict) --
The structure that contains information about a specified operation's results for a given account in a given Region.
Account (string) --
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
Region (string) --
The name of the Amazon Web Services Region for this operation result.
Status (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 (string) --
The reason for the assigned result status.
AccountGateResult (dict) --
The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.
Status (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: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.StatusReason (string) --
The reason for the account gate status assigned to this account and Region for the stack set operation.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationNotFoundExceptionlist_stack_set_operations(**kwargs)¶Returns summary information about operations performed on a stack set.
See also: AWS API Documentation
Request Syntax
response = client.list_stack_set_operations(
StackSetName='string',
NextToken='string',
MaxResults=123,
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you want to get operation summaries for.
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 .NextToken value that you can assign to the NextToken request parameter to get the next set of results.[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.
SELF .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 .dict
Response Syntax
{
'Summaries': [
{
'OperationId': 'string',
'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'StatusReason': 'string',
'StatusDetails': {
'FailedStackInstancesCount': 123
},
'OperationPreferences': {
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
(dict) --
The structures that contain summary information about the specified operation.
OperationId (string) --
The unique ID of the stack set operation.
Action (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.
Status (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.CreationTimestamp (datetime) --
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 (datetime) --
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.
StatusReason (string) --
The status of the operation in details.
StatusDetails (dict) --
Detailed information about the stack set operation.
FailedStackInstancesCount (integer) --
The number of stack instances for which the StackSet operation failed.
OperationPreferences (dict) --
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 .
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions in where you want to perform the stack operation.
FailureToleranceCount (integer) --
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 (integer) --
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 (integer) --
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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 (integer) --
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.
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionlist_stack_sets(**kwargs)¶Returns summary information about stack sets that are associated with the user.
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.CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.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.See also: AWS API Documentation
Request Syntax
response = client.list_stack_sets(
NextToken='string',
MaxResults=123,
Status='ACTIVE'|'DELETED',
CallAs='SELF'|'DELEGATED_ADMIN'
)
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 .NextToken value that you can assign to the NextToken request parameter to get the next set of results.[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.
SELF .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 .dict
Response Syntax
{
'Summaries': [
{
'StackSetName': 'string',
'StackSetId': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'DELETED',
'AutoDeployment': {
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
'PermissionModel': 'SERVICE_MANAGED'|'SELF_MANAGED',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'ManagedExecution': {
'Active': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetSummary structures that contain information about the user's stack sets.
(dict) --
The structures that contain summary information about the specified stack set.
StackSetName (string) --
The name of the stack set.
StackSetId (string) --
The ID of the stack set.
Description (string) --
A description of the stack set that you specify when the stack set is created or updated.
Status (string) --
The status of the stack set.
AutoDeployment (dict) --
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
Enabled (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 (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 .
PermissionModel (string) --
Describes how the IAM roles required for stack set operations are created.
self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions .DriftStatus (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 (datetime) --
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 (dict) --
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Active (boolean) --
When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
Note
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.
NextToken (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 .
list_stacks(**kwargs)¶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).
See also: AWS API Documentation
Request Syntax
response = client.list_stacks(
NextToken='string',
StackStatusFilter=[
'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',
]
)
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.
dict
Response Syntax
{
'StackSummaries': [
{
'StackId': 'string',
'StackName': 'string',
'TemplateDescription': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1),
'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',
'ParentId': 'string',
'RootId': 'string',
'DriftInformation': {
'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for ListStacks action.
StackSummaries (list) --
A list of StackSummary structures containing information about the specified stacks.
(dict) --
The StackSummary Data Type
StackId (string) --
Unique stack identifier.
StackName (string) --
The name associated with the stack.
TemplateDescription (string) --
The template description of the template used to create the stack.
CreationTime (datetime) --
The time the stack was created.
LastUpdatedTime (datetime) --
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
DeletionTime (datetime) --
The time the stack was deleted.
StackStatus (string) --
The current status of the stack.
StackStatusReason (string) --
Success/Failure message associated with the stack status.
ParentId (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 (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 .
DriftInformation (dict) --
Summarizes information about whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources .
StackDriftStatus (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.LastCheckTimestamp (datetime) --
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
NextToken (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.
list_type_registrations(**kwargs)¶Returns a list of registration tokens for the specified extension(s).
See also: AWS API Documentation
Request Syntax
response = client.list_type_registrations(
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
TypeArn='string',
RegistrationStatusFilter='COMPLETE'|'IN_PROGRESS'|'FAILED',
MaxResults=123,
NextToken='string'
)
The kind of extension.
Conditional: You must specify either TypeName and Type , or Arn .
The name of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
The current status of the extension registration request.
The default is IN_PROGRESS .
NextToken value that you can assign to the NextToken request parameter to get the next set of results.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 .dict
Response Syntax
{
'RegistrationTokenList': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationTokenList (list) --
A list of extension registration tokens.
Use `` DescribeTypeRegistration `` to return detailed information about a type registration request.
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionlist_type_versions(**kwargs)¶Returns summary information about the versions of an extension.
See also: AWS API Documentation
Request Syntax
response = client.list_type_versions(
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
Arn='string',
MaxResults=123,
NextToken='string',
DeprecatedStatus='LIVE'|'DEPRECATED',
PublisherId='string'
)
The kind of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
The name of the extension for which you want version summary information.
Conditional: You must specify either TypeName and Type , or Arn .
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 .
NextToken value that you can assign to the NextToken request parameter to get the next set of results.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 .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 .
The publisher ID of the extension publisher.
Extensions published by Amazon aren't assigned a publisher ID.
dict
Response Syntax
{
'TypeVersionSummaries': [
{
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string',
'VersionId': 'string',
'IsDefaultVersion': True|False,
'Arn': 'string',
'TimeCreated': datetime(2015, 1, 1),
'Description': 'string',
'PublicVersionNumber': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TypeVersionSummaries (list) --
A list of TypeVersionSummary structures that contain information about the specified extension's versions.
(dict) --
Contains summary information about a specific version of a CloudFormation extension.
Type (string) --
The kind of extension.
TypeName (string) --
The name of the extension.
VersionId (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's registered.
IsDefaultVersion (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. For public third-party extensions, CloudFormation returns null .
Arn (string) --
The Amazon Resource Name (ARN) of the extension version.
TimeCreated (datetime) --
When the version was registered.
Description (string) --
The description of the extension version.
PublicVersionNumber (string) --
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region. For any extensions other than activated third-arty extensions, CloudFormation returns null .
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide .
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionlist_types(**kwargs)¶Returns summary information about extension that have been registered with CloudFormation.
See also: AWS API Documentation
Request Syntax
response = client.list_types(
Visibility='PUBLIC'|'PRIVATE',
ProvisioningType='NON_PROVISIONABLE'|'IMMUTABLE'|'FULLY_MUTABLE',
DeprecatedStatus='LIVE'|'DEPRECATED',
Type='RESOURCE'|'MODULE'|'HOOK',
Filters={
'Category': 'REGISTERED'|'ACTIVATED'|'THIRD_PARTY'|'AWS_TYPES',
'PublisherId': 'string',
'TypeNamePrefix': 'string'
},
MaxResults=123,
NextToken='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: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 .
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 .
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.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.
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:AWS_TYPES : Extensions available for use from Amazon.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.
A prefix to use as a filter for results.
NextToken value that you can assign to the NextToken request parameter to get the next set of results.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 .dict
Response Syntax
{
'TypeSummaries': [
{
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string',
'DefaultVersionId': 'string',
'TypeArn': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Description': 'string',
'PublisherId': 'string',
'OriginalTypeName': 'string',
'PublicVersionNumber': 'string',
'LatestPublicVersion': 'string',
'PublisherIdentity': 'AWS_Marketplace'|'GitHub'|'Bitbucket',
'PublisherName': 'string',
'IsActivated': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TypeSummaries (list) --
A list of TypeSummary structures that contain information about the specified extensions.
(dict) --
Contains summary information about the specified CloudFormation extension.
Type (string) --
The kind of extension.
TypeName (string) --
The name of the extension.
If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.
DefaultVersionId (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 and published by third parties, CloudFormation returns null . For more information, see RegisterType .
To set the default version of an extension, use `` SetTypeDefaultVersion `` .
TypeArn (string) --
The Amazon Resource Name (ARN) of the extension.
LastUpdated (datetime) --
When the specified extension version was registered. This applies only to:
For all other extension types, CloudFormation returns null .
Description (string) --
The description of the extension.
PublisherId (string) --
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
OriginalTypeName (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 .
PublicVersionNumber (string) --
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide .
LatestPublicVersion (string) --
For public extensions that have been activated for this account and region, the latest version of the public extension that is available . For any extensions other than activated third-arty extensions, CloudFormation returns null .
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide .
PublisherIdentity (string) --
The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development .
PublisherName (string) --
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
IsActivated (boolean) --
Whether the extension is activated for this account and region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
NextToken (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 .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionpublish_type(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.publish_type(
Type='RESOURCE'|'MODULE'|'HOOK',
Arn='string',
TypeName='string',
PublicVersionNumber='string'
)
The type of the extension.
Conditional: You must specify Arn , or TypeName and Type .
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn , or TypeName and Type .
The name of the extension.
Conditional: You must specify Arn , or TypeName and Type .
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 .
dict
Response Syntax
{
'PublicTypeArn': 'string'
}
Response Structure
(dict) --
PublicTypeArn (string) --
The Amazon Resource Name (ARN) assigned to the public extension upon publication.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptionrecord_handler_progress(**kwargs)¶Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI . Don't use this API in your code.
See also: AWS API Documentation
Request Syntax
response = client.record_handler_progress(
BearerToken='string',
OperationStatus='PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED',
CurrentOperationStatus='PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED',
StatusMessage='string',
ErrorCode='NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'NetworkFailure'|'InternalFailure'|'InvalidTypeConfiguration'|'HandlerInternalFailure'|'NonCompliant'|'Unknown',
ResourceModel='string',
ClientRequestToken='string'
)
[REQUIRED]
Reserved for use by the CloudFormation CLI .
[REQUIRED]
Reserved for use by the CloudFormation CLI .
dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.InvalidStateTransitionExceptionCloudFormation.Client.exceptions.OperationStatusCheckFailedExceptionregister_publisher(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.register_publisher(
AcceptTermsAndConditions=True|False,
ConnectionArn='string'
)
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 .
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 .
dict
Response Syntax
{
'PublisherId': 'string'
}
Response Structure
(dict) --
PublisherId (string) --
The ID assigned this account by CloudFormation for publishing extensions.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionregister_type(**kwargs)¶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:
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 .
See also: AWS API Documentation
Request Syntax
response = client.register_type(
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
SchemaHandlerPackage='string',
LoggingConfig={
'LogRoleArn': 'string',
'LogGroupName': 'string'
},
ExecutionRoleArn='string',
ClientRequestToken='string'
)
[REQUIRED]
The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
Note
The following organization namespaces are reserved and can't be used in your extension names:
AlexaAMZNAmazonAWSCustomDev[REQUIRED]
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 .
Note
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 .
Specifies logging configuration information for an extension.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
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 principle (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.
dict
Response Syntax
{
'RegistrationToken': 'string'
}
Response Structure
(dict) --
RegistrationToken (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.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionrollback_stack(**kwargs)¶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_COMPLETEUPDATE_COMPLETEUPDATE_ROLLBACK_COMPLETEIMPORT_COMPLETEIMPORT_ROLLBACK_COMPLETESee also: AWS API Documentation
Request Syntax
response = client.rollback_stack(
StackName='string',
RoleARN='string',
ClientRequestToken='string'
)
[REQUIRED]
The name that's associated with the stack.
RollbackStack request.dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
StackId (string) --
Unique identifier of the stack.
Exceptions
CloudFormation.Client.exceptions.TokenAlreadyExistsExceptionset_stack_policy(**kwargs)¶Sets a stack policy for a specified stack.
See also: AWS API Documentation
Request Syntax
response = client.set_stack_policy(
StackName='string',
StackPolicyBody='string',
StackPolicyURL='string'
)
[REQUIRED]
The name or unique stack ID that you want to associate a policy with.
StackPolicyBody or the StackPolicyURL parameter, but not both.StackPolicyBody or the StackPolicyURL parameter, but not both.None
set_type_configuration(**kwargs)¶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 .
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.set_type_configuration(
TypeArn='string',
Configuration='string',
ConfigurationAlias='string',
TypeName='string',
Type='RESOURCE'|'MODULE'|'HOOK'
)
The Amazon Resource Name (ARN) for the extension, in this account and region.
For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type 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.
[REQUIRED]
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 API_DescribeType . For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide .
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.
The name of the extension.
Conditional: You must specify ConfigurationArn , or Type and TypeName .
The type of extension.
Conditional: You must specify ConfigurationArn , or Type and TypeName .
dict
Response Syntax
{
'ConfigurationArn': 'string'
}
Response Structure
(dict) --
ConfigurationArn (string) --
The Amazon Resource Name (ARN) for the configuration data, in this account and region.
Conditional: You must specify ConfigurationArn , or Type and TypeName .
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptionset_type_default_version(**kwargs)¶Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
See also: AWS API Documentation
Request Syntax
response = client.set_type_default_version(
Arn='string',
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
VersionId='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 .
The kind of extension.
Conditional: You must specify either TypeName and Type , or Arn .
The name of the extension.
Conditional: You must specify either TypeName and Type , or Arn .
dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptionsignal_resource(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.signal_resource(
StackName='string',
LogicalResourceId='string',
UniqueId='string',
Status='SUCCESS'|'FAILURE'
)
[REQUIRED]
The stack name or unique stack ID that includes the resource that you want to signal.
[REQUIRED]
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.
[REQUIRED]
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.
[REQUIRED]
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.
None
stop_stack_set_operation(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.stop_stack_set_operation(
StackSetName='string',
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set that you want to stop the operation for.
[REQUIRED]
The ID of the stack operation.
[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.
SELF .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 .dict
Response Syntax
{}
Response Structure
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationNotFoundExceptionCloudFormation.Client.exceptions.InvalidOperationExceptiontest_type(**kwargs)¶Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
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 .
See also: AWS API Documentation
Request Syntax
response = client.test_type(
Arn='string',
Type='RESOURCE'|'MODULE'|'HOOK',
TypeName='string',
VersionId='string',
LogDeliveryBucket='string'
)
The Amazon Resource Name (ARN) of the extension.
Conditional: You must specify Arn , or TypeName and Type .
The type of the extension to test.
Conditional: You must specify Arn , or TypeName and Type .
The name of the extension to test.
Conditional: You must specify Arn , or TypeName and Type .
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.
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:
GetObjectPutObjectFor more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide .
dict
Response Syntax
{
'TypeVersionArn': 'string'
}
Response Structure
(dict) --
TypeVersionArn (string) --
The Amazon Resource Name (ARN) of the extension.
Exceptions
CloudFormation.Client.exceptions.CFNRegistryExceptionCloudFormation.Client.exceptions.TypeNotFoundExceptionupdate_stack(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_stack(
StackName='string',
TemplateBody='string',
TemplateURL='string',
UsePreviousTemplate=True|False,
StackPolicyDuringUpdateBody='string',
StackPolicyDuringUpdateURL='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
ResourceTypes=[
'string',
],
RoleARN='string',
RollbackConfiguration={
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
StackPolicyBody='string',
StackPolicyURL='string',
NotificationARNs=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DisableRollback=True|False,
ClientRequestToken='string'
)
[REQUIRED]
The name or unique stack ID of the stack to update.
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 .
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.
Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .
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 .
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.
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. 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.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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.CAPABILITY_NAMED_IAM .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.Warning
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 .
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 .
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.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
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.
The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
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.
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.
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. 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.
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
Preserve the state of previously provisioned resources when an operation fails.
Default: False
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 .
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
The output for an UpdateStack action.
StackId (string) --
Unique identifier of the stack.
Exceptions
CloudFormation.Client.exceptions.InsufficientCapabilitiesExceptionCloudFormation.Client.exceptions.TokenAlreadyExistsExceptionupdate_stack_instances(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
[REQUIRED]
The name or unique ID of the stack set associated with the stack instances.
[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.
[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.
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
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).[REQUIRED]
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.
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:
UsePreviousValue as true . (You can't specify both a value and set UsePreviousValue to true .)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 .
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
Preferences for how CloudFormation performs this stack set operation.
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
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.
This field is autopopulated if not provided.
[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.
SELF .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 .dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.StackInstanceNotFoundExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.OperationIdAlreadyExistsExceptionCloudFormation.Client.exceptions.StaleRequestExceptionCloudFormation.Client.exceptions.InvalidOperationExceptionupdate_stack_set(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_stack_set(
StackSetName='string',
Description='string',
TemplateBody='string',
TemplateURL='string',
UsePreviousTemplate=True|False,
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
AdministrationRoleARN='string',
ExecutionRoleName='string',
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
PermissionModel='SERVICE_MANAGED'|'SELF_MANAGED',
AutoDeployment={
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
OperationId='string',
Accounts=[
'string',
],
Regions=[
'string',
],
CallAs='SELF'|'DELEGATED_ADMIN',
ManagedExecution={
'Active': True|False
}
)
[REQUIRED]
The name or unique ID of the stack set that you want to update.
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.
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.
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.
A list of input parameters for the stack set template.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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.CAPABILITY_NAMED_IAM .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 .Warning
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.
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 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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
Preferences for how CloudFormation performs this stack set operation.
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
The order of the Regions in where you want to perform the stack operation.
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.
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.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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.
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.
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.
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.
[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.
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
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).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.
self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions .[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 .
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.
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 .
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 .
This field is autopopulated if not provided.
[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.
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.
[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.
SELF .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 .Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
Note
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.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique ID for this stack set operation.
Exceptions
CloudFormation.Client.exceptions.StackSetNotFoundExceptionCloudFormation.Client.exceptions.OperationInProgressExceptionCloudFormation.Client.exceptions.OperationIdAlreadyExistsExceptionCloudFormation.Client.exceptions.StaleRequestExceptionCloudFormation.Client.exceptions.InvalidOperationExceptionCloudFormation.Client.exceptions.StackInstanceNotFoundExceptionupdate_termination_protection(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_termination_protection(
EnableTerminationProtection=True|False,
StackName='string'
)
[REQUIRED]
Whether to enable termination protection on the specified stack.
[REQUIRED]
The name or unique ID of the stack for which you want to set termination protection.
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
StackId (string) --
The unique ID of the stack.
validate_template(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.validate_template(
TemplateBody='string',
TemplateURL='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.
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.
Conditional: You must pass TemplateURL or TemplateBody . If both are passed, only TemplateBody is used.
dict
Response Syntax
{
'Parameters': [
{
'ParameterKey': 'string',
'DefaultValue': 'string',
'NoEcho': True|False,
'Description': 'string'
},
],
'Description': 'string',
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'CapabilitiesReason': 'string',
'DeclaredTransforms': [
'string',
]
}
Response Structure
(dict) --
The output for ValidateTemplate action.
Parameters (list) --
A list of TemplateParameter structures.
(dict) --
The TemplateParameter data type.
ParameterKey (string) --
The name associated with the parameter.
DefaultValue (string) --
The default value associated with the parameter.
NoEcho (boolean) --
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
Description (string) --
User defined description associated with the parameter.
Description (string) --
The description found within the template.
Capabilities (list) --
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 (string) --
The list of resources that generated the values in the Capabilities response element.
DeclaredTransforms (list) --
A list of the transforms that are declared in the template.
The available paginators are:
CloudFormation.Paginator.DescribeAccountLimitsCloudFormation.Paginator.DescribeChangeSetCloudFormation.Paginator.DescribeStackEventsCloudFormation.Paginator.DescribeStacksCloudFormation.Paginator.ListChangeSetsCloudFormation.Paginator.ListExportsCloudFormation.Paginator.ListImportsCloudFormation.Paginator.ListStackInstancesCloudFormation.Paginator.ListStackResourcesCloudFormation.Paginator.ListStackSetOperationResultsCloudFormation.Paginator.ListStackSetOperationsCloudFormation.Paginator.ListStackSetsCloudFormation.Paginator.ListStacksCloudFormation.Paginator.ListTypesCloudFormation.Paginator.DescribeAccountLimits¶paginator = client.get_paginator('describe_account_limits')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.describe_account_limits().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'AccountLimits': [
{
'Name': 'string',
'Value': 123
},
],
}
Response Structure
The output for the DescribeAccountLimits action.
An account limit structure that contain a list of CloudFormation account limits and their values.
The AccountLimit data type.
CloudFormation has the following limits per account:
For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the CloudFormation User Guide .
The name of the account limit.
Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
The value that's associated with the account limit name.
CloudFormation.Paginator.DescribeChangeSet¶paginator = client.get_paginator('describe_change_set')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.describe_change_set().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ChangeSetName='string',
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ChangeSetName': 'string',
'ChangeSetId': 'string',
'StackId': 'string',
'StackName': 'string',
'Description': 'string',
'Parameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'OBSOLETE',
'Status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'FAILED',
'StatusReason': 'string',
'NotificationARNs': [
'string',
],
'RollbackConfiguration': {
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Changes': [
{
'Type': 'Resource',
'HookInvocationCount': 123,
'ResourceChange': {
'Action': 'Add'|'Modify'|'Remove'|'Import'|'Dynamic',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Replacement': 'True'|'False'|'Conditional',
'Scope': [
'Properties'|'Metadata'|'CreationPolicy'|'UpdatePolicy'|'DeletionPolicy'|'Tags',
],
'Details': [
{
'Target': {
'Attribute': 'Properties'|'Metadata'|'CreationPolicy'|'UpdatePolicy'|'DeletionPolicy'|'Tags',
'Name': 'string',
'RequiresRecreation': 'Never'|'Conditionally'|'Always'
},
'Evaluation': 'Static'|'Dynamic',
'ChangeSource': 'ResourceReference'|'ParameterReference'|'ResourceAttribute'|'DirectModification'|'Automatic',
'CausingEntity': 'string'
},
],
'ChangeSetId': 'string',
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
}
},
],
'IncludeNestedStacks': True|False,
'ParentChangeSetId': 'string',
'RootChangeSetId': 'string'
}
Response Structure
(dict) --
The output for the DescribeChangeSet action.
ChangeSetName (string) --
The name of the change set.
ChangeSetId (string) --
The Amazon Resource Name (ARN) of the change set.
StackId (string) --
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
StackName (string) --
The name of the stack that's associated with the change set.
Description (string) --
Information about the change set.
Parameters (list) --
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.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
CreationTime (datetime) --
The start time when the change set was created, in UTC.
ExecutionStatus (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.
Status (string) --
The current status of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .
StatusReason (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.
NotificationARNs (list) --
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
RollbackConfiguration (dict) --
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
RollbackTriggers (list) --
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
(dict) --
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.
Arn (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 (string) --
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
MonitoringTimeInMinutes (integer) --
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.
Capabilities (list) --
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
Tags (list) --
If you execute the change set, the tags that will be associated with the stack.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
Changes (list) --
A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
(dict) --
The Change structure describes the changes CloudFormation will perform if you execute the change set.
Type (string) --
The type of entity that CloudFormation changes. Currently, the only entity type is Resource .
HookInvocationCount (integer) --
Is either null , if no hooks invoke for the resource, or contains the number of hooks that will invoke for the resource.
ResourceChange (dict) --
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
Action (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).
LogicalResourceId (string) --
The resource's logical ID, which is defined in the stack's template.
PhysicalResourceId (string) --
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
ResourceType (string) --
The type of CloudFormation resource, such as AWS::S3::Bucket .
Replacement (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 .
Scope (list) --
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 .
Details (list) --
For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.
(dict) --
For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.
Target (dict) --
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.
Attribute (string) --
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata , Properties , or Tags .
Name (string) --
If the Attribute value is Properties , the name of the property. For all other attributes, the value is null.
RequiresRecreation (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.
Evaluation (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.
ChangeSource (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.CausingEntity (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 .
ChangeSetId (string) --
The change set ID of the nested change set.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
IncludeNestedStacks (boolean) --
Verifies if IncludeNestedStacks is set to True .
ParentChangeSetId (string) --
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
RootChangeSetId (string) --
Specifies the change set ID of the root change set in the current nested change set hierarchy.
CloudFormation.Paginator.DescribeStackEvents¶paginator = client.get_paginator('describe_stack_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.describe_stack_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StackEvents': [
{
'StackId': 'string',
'EventId': 'string',
'StackName': 'string',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Timestamp': datetime(2015, 1, 1),
'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',
'ResourceProperties': 'string',
'ClientRequestToken': 'string',
'HookType': 'string',
'HookStatus': 'HOOK_IN_PROGRESS'|'HOOK_COMPLETE_SUCCEEDED'|'HOOK_COMPLETE_FAILED'|'HOOK_FAILED',
'HookStatusReason': 'string',
'HookInvocationPoint': 'PRE_PROVISION',
'HookFailureMode': 'FAIL'|'WARN'
},
],
}
Response Structure
(dict) --
The output for a DescribeStackEvents action.
StackEvents (list) --
A list of StackEvents structures.
(dict) --
The StackEvent data type.
StackId (string) --
The unique ID name of the instance of the stack.
EventId (string) --
The unique ID of this event.
StackName (string) --
The name associated with a stack.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier associated with the physical instance of the resource.
ResourceType (string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
Timestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
ResourceProperties (string) --
BLOB of the properties used to create the resource.
ClientRequestToken (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 .
HookType (string) --
The name of the hook.
HookStatus (string) --
Provides the status of the change set hook.
HookStatusReason (string) --
Provides the reason for the hook status.
HookInvocationPoint (string) --
Invocation points are points in provisioning logic where hooks are initiated.
HookFailureMode (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.CloudFormation.Paginator.DescribeStacks¶paginator = client.get_paginator('describe_stacks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.describe_stacks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Stacks': [
{
'StackId': 'string',
'StackName': 'string',
'ChangeSetId': 'string',
'Description': 'string',
'Parameters': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'RollbackConfiguration': {
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
'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',
'DisableRollback': True|False,
'NotificationARNs': [
'string',
],
'TimeoutInMinutes': 123,
'Capabilities': [
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
'Outputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string',
'ExportName': 'string'
},
],
'RoleARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EnableTerminationProtection': True|False,
'ParentId': 'string',
'RootId': 'string',
'DriftInformation': {
'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
}
},
],
}
Response Structure
(dict) --
The output for a DescribeStacks action.
Stacks (list) --
A list of stack structures.
(dict) --
The Stack data type.
StackId (string) --
Unique identifier of the stack.
StackName (string) --
The name associated with the stack.
ChangeSetId (string) --
The unique ID of the change set.
Description (string) --
A user-defined description associated with the stack.
Parameters (list) --
A list of Parameter structures.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
CreationTime (datetime) --
The time at which the stack was created.
DeletionTime (datetime) --
The time the stack was deleted.
LastUpdatedTime (datetime) --
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
RollbackConfiguration (dict) --
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
RollbackTriggers (list) --
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
(dict) --
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.
Arn (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 (string) --
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
MonitoringTimeInMinutes (integer) --
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.
StackStatus (string) --
Current status of the stack.
StackStatusReason (string) --
Success/failure message associated with the stack status.
DisableRollback (boolean) --
Boolean to enable or disable rollback on stack creation failures:
true : disable rollback.false : enable rollback.NotificationARNs (list) --
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
TimeoutInMinutes (integer) --
The amount of time within which stack creation should complete.
Capabilities (list) --
The capabilities allowed in the stack.
Outputs (list) --
A list of output structures.
(dict) --
The Output data type.
OutputKey (string) --
The key associated with the output.
OutputValue (string) --
The value associated with the output.
Description (string) --
User defined description associated with the output.
ExportName (string) --
The name of the export associated with the output.
RoleARN (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.
Tags (list) --
A list of Tag s that specify information about the stack.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
EnableTerminationProtection (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 .
ParentId (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 (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 .
DriftInformation (dict) --
Information about whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources .
StackDriftStatus (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.LastCheckTimestamp (datetime) --
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
CloudFormation.Paginator.ListChangeSets¶paginator = client.get_paginator('list_change_sets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_change_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Summaries': [
{
'StackId': 'string',
'StackName': 'string',
'ChangeSetId': 'string',
'ChangeSetName': 'string',
'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'OBSOLETE',
'Status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'FAILED',
'StatusReason': 'string',
'CreationTime': datetime(2015, 1, 1),
'Description': 'string',
'IncludeNestedStacks': True|False,
'ParentChangeSetId': 'string',
'RootChangeSetId': 'string'
},
],
}
Response Structure
(dict) --
The output for the ListChangeSets action.
Summaries (list) --
A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
(dict) --
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.
StackId (string) --
The ID of the stack with which the change set is associated.
StackName (string) --
The name of the stack with which the change set is associated.
ChangeSetId (string) --
The ID of the change set.
ChangeSetName (string) --
The name of the change set.
ExecutionStatus (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.
Status (string) --
The state of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or FAILED .
StatusReason (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.
CreationTime (datetime) --
The start time when the change set was created, in UTC.
Description (string) --
Descriptive information about the change set.
IncludeNestedStacks (boolean) --
Specifies the current setting of IncludeNestedStacks for the change set.
ParentChangeSetId (string) --
The parent change set ID.
RootChangeSetId (string) --
The root change set ID.
CloudFormation.Paginator.ListExports¶paginator = client.get_paginator('list_exports')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_exports().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Exports': [
{
'ExportingStackId': 'string',
'Name': 'string',
'Value': 'string'
},
],
}
Response Structure
The output for the ListExports action.
The Export structure describes the exported output values for a stack.
The stack that contains the exported output name and value.
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.
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.
CloudFormation.Paginator.ListImports¶paginator = client.get_paginator('list_imports')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_imports().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ExportName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the exported output value. CloudFormation returns the stack names that are importing this value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Imports': [
'string',
],
}
Response Structure
(dict) --
Imports (list) --
A list of stack names that are importing the specified exported output value.
CloudFormation.Paginator.ListStackInstances¶paginator = client.get_paginator('list_stack_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stack_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackSetName='string',
Filters=[
{
'Name': 'DETAILED_STATUS'|'LAST_OPERATION_ID',
'Values': 'string'
},
],
StackInstanceAccount='string',
StackInstanceRegion='string',
CallAs='SELF'|'DELEGATED_ADMIN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or unique ID of the stack set that you want to list stack instances for.
The filter to apply to stack instances
The filter to apply to stack instances
The type of filter to apply.
The status to filter by.
[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.
SELF .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 .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Summaries': [
{
'StackSetId': 'string',
'Region': 'string',
'Account': 'string',
'StackId': 'string',
'Status': 'CURRENT'|'OUTDATED'|'INOPERABLE',
'StatusReason': 'string',
'StackInstanceStatus': {
'DetailedStatus': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'|'INOPERABLE'
},
'OrganizationalUnitId': 'string',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'LastOperationId': 'string'
},
],
}
Response Structure
(dict) --
Summaries (list) --
A list of StackInstanceSummary structures that contain information about the specified stack instances.
(dict) --
The structure that contains summary information about a stack instance.
StackSetId (string) --
The name or unique ID of the stack set that the stack instance is associated with.
Region (string) --
The name of the Amazon Web Services Region that the stack instance is associated with.
Account (string) --
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
StackId (string) --
The ID of the stack instance.
Status (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.OUTDATED : The stack isn't currently up to date with the stack set because:CreateStackSet or UpdateStackSet operation.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 (string) --
The explanation for the specific status code assigned to this stack instance.
StackInstanceStatus (dict) --
The detailed status of the stack instance.
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.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.SUCCEEDED : The operation in the specified account and Region completed successfully.OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
DriftStatus (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 (datetime) --
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 (string) --
The last unique ID of a StackSet operation performed on a stack instance.
CloudFormation.Paginator.ListStackResources¶paginator = client.get_paginator('list_stack_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stack_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StackResourceSummaries': [
{
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'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',
'DriftInformation': {
'StackResourceDriftStatus': 'IN_SYNC'|'MODIFIED'|'DELETED'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
},
'ModuleInfo': {
'TypeHierarchy': 'string',
'LogicalIdHierarchy': 'string'
}
},
],
}
Response Structure
(dict) --
The output for a ListStackResources action.
StackResourceSummaries (list) --
A list of StackResourceSummary structures.
(dict) --
Contains high-level information about the specified stack resource.
LogicalResourceId (string) --
The logical name of the resource specified in the template.
PhysicalResourceId (string) --
The name or unique identifier that corresponds to a physical instance ID of the resource.
ResourceType (string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
LastUpdatedTimestamp (datetime) --
Time the status was updated.
ResourceStatus (string) --
Current status of the resource.
ResourceStatusReason (string) --
Success/failure message associated with the resource.
DriftInformation (dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
ModuleInfo (dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
CloudFormation.Paginator.ListStackSetOperationResults¶paginator = client.get_paginator('list_stack_set_operation_results')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stack_set_operation_results().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackSetName='string',
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN',
Filters=[
{
'Name': 'OPERATION_RESULT_STATUS',
'Values': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or unique ID of the stack set that you want to get operation results for.
[REQUIRED]
The ID of the stack set operation.
[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.
SELF .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 .The filter to apply to operation results.
The status that operation results are filtered by.
The type of filter to apply.
The value to filter by.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Summaries': [
{
'Account': 'string',
'Region': 'string',
'Status': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
'StatusReason': 'string',
'AccountGateResult': {
'Status': 'SUCCEEDED'|'FAILED'|'SKIPPED',
'StatusReason': 'string'
},
'OrganizationalUnitId': 'string'
},
],
}
Response Structure
(dict) --
Summaries (list) --
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.
(dict) --
The structure that contains information about a specified operation's results for a given account in a given Region.
Account (string) --
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
Region (string) --
The name of the Amazon Web Services Region for this operation result.
Status (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 (string) --
The reason for the assigned result status.
AccountGateResult (dict) --
The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.
Status (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: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.StatusReason (string) --
The reason for the account gate status assigned to this account and Region for the stack set operation.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets .
CloudFormation.Paginator.ListStackSetOperations¶paginator = client.get_paginator('list_stack_set_operations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stack_set_operations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or unique ID of the stack set that you want to get operation summaries for.
[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.
SELF .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 .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Summaries': [
{
'OperationId': 'string',
'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'StatusReason': 'string',
'StatusDetails': {
'FailedStackInstancesCount': 123
},
'OperationPreferences': {
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
}
},
],
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
(dict) --
The structures that contain summary information about the specified operation.
OperationId (string) --
The unique ID of the stack set operation.
Action (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.
Status (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.CreationTimestamp (datetime) --
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 (datetime) --
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.
StatusReason (string) --
The status of the operation in details.
StatusDetails (dict) --
Detailed information about the stack set operation.
FailedStackInstancesCount (integer) --
The number of stack instances for which the StackSet operation failed.
OperationPreferences (dict) --
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 .
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions in where you want to perform the stack operation.
FailureToleranceCount (integer) --
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 (integer) --
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 (integer) --
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount .``MaxConcurrentCount`` is at most one more than the FailureToleranceCount .
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 (integer) --
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.
CloudFormation.Paginator.ListStackSets¶paginator = client.get_paginator('list_stack_sets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stack_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Status='ACTIVE'|'DELETED',
CallAs='SELF'|'DELEGATED_ADMIN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': '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.
SELF .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 .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Summaries': [
{
'StackSetName': 'string',
'StackSetId': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'DELETED',
'AutoDeployment': {
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
'PermissionModel': 'SERVICE_MANAGED'|'SELF_MANAGED',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'ManagedExecution': {
'Active': True|False
}
},
],
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetSummary structures that contain information about the user's stack sets.
(dict) --
The structures that contain summary information about the specified stack set.
StackSetName (string) --
The name of the stack set.
StackSetId (string) --
The ID of the stack set.
Description (string) --
A description of the stack set that you specify when the stack set is created or updated.
Status (string) --
The status of the stack set.
AutoDeployment (dict) --
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
Enabled (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 (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 .
PermissionModel (string) --
Describes how the IAM roles required for stack set operations are created.
self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions .service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions .DriftStatus (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 (datetime) --
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 (dict) --
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Active (boolean) --
When true , StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
Note
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.
CloudFormation.Paginator.ListStacks¶paginator = client.get_paginator('list_stacks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_stacks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
StackStatusFilter=[
'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',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StackSummaries': [
{
'StackId': 'string',
'StackName': 'string',
'TemplateDescription': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1),
'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',
'ParentId': 'string',
'RootId': 'string',
'DriftInformation': {
'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastCheckTimestamp': datetime(2015, 1, 1)
}
},
],
}
Response Structure
(dict) --
The output for ListStacks action.
StackSummaries (list) --
A list of StackSummary structures containing information about the specified stacks.
(dict) --
The StackSummary Data Type
StackId (string) --
Unique stack identifier.
StackName (string) --
The name associated with the stack.
TemplateDescription (string) --
The template description of the template used to create the stack.
CreationTime (datetime) --
The time the stack was created.
LastUpdatedTime (datetime) --
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
DeletionTime (datetime) --
The time the stack was deleted.
StackStatus (string) --
The current status of the stack.
StackStatusReason (string) --
Success/Failure message associated with the stack status.
ParentId (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 (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 .
DriftInformation (dict) --
Summarizes information about whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources .
StackDriftStatus (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.LastCheckTimestamp (datetime) --
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
CloudFormation.Paginator.ListTypes¶paginator = client.get_paginator('list_types')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudFormation.Client.list_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Visibility='PUBLIC'|'PRIVATE',
ProvisioningType='NON_PROVISIONABLE'|'IMMUTABLE'|'FULLY_MUTABLE',
DeprecatedStatus='LIVE'|'DEPRECATED',
Type='RESOURCE'|'MODULE'|'HOOK',
Filters={
'Category': 'REGISTERED'|'ACTIVATED'|'THIRD_PARTY'|'AWS_TYPES',
'PublisherId': 'string',
'TypeNamePrefix': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': '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: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 .
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 .
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.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.
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:AWS_TYPES : Extensions available for use from Amazon.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.
A prefix to use as a filter for results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TypeSummaries': [
{
'Type': 'RESOURCE'|'MODULE'|'HOOK',
'TypeName': 'string',
'DefaultVersionId': 'string',
'TypeArn': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Description': 'string',
'PublisherId': 'string',
'OriginalTypeName': 'string',
'PublicVersionNumber': 'string',
'LatestPublicVersion': 'string',
'PublisherIdentity': 'AWS_Marketplace'|'GitHub'|'Bitbucket',
'PublisherName': 'string',
'IsActivated': True|False
},
],
}
Response Structure
(dict) --
TypeSummaries (list) --
A list of TypeSummary structures that contain information about the specified extensions.
(dict) --
Contains summary information about the specified CloudFormation extension.
Type (string) --
The kind of extension.
TypeName (string) --
The name of the extension.
If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.
DefaultVersionId (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 and published by third parties, CloudFormation returns null . For more information, see RegisterType .
To set the default version of an extension, use `` SetTypeDefaultVersion `` .
TypeArn (string) --
The Amazon Resource Name (ARN) of the extension.
LastUpdated (datetime) --
When the specified extension version was registered. This applies only to:
For all other extension types, CloudFormation returns null .
Description (string) --
The description of the extension.
PublisherId (string) --
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
OriginalTypeName (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 .
PublicVersionNumber (string) --
For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide .
LatestPublicVersion (string) --
For public extensions that have been activated for this account and region, the latest version of the public extension that is available . For any extensions other than activated third-arty extensions, CloudFormation returns null .
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide .
PublisherIdentity (string) --
The service used to verify the publisher identity.
For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development .
PublisherName (string) --
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
IsActivated (boolean) --
Whether the extension is activated for this account and region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
The available waiters are:
CloudFormation.Waiter.ChangeSetCreateCompleteCloudFormation.Waiter.StackCreateCompleteCloudFormation.Waiter.StackDeleteCompleteCloudFormation.Waiter.StackExistsCloudFormation.Waiter.StackImportCompleteCloudFormation.Waiter.StackRollbackCompleteCloudFormation.Waiter.StackUpdateCompleteCloudFormation.Waiter.TypeRegistrationCompleteCloudFormation.Waiter.ChangeSetCreateComplete¶waiter = client.get_waiter('change_set_create_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_change_set() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ChangeSetName='string',
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.StackCreateComplete¶waiter = client.get_waiter('stack_create_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.StackDeleteComplete¶waiter = client.get_waiter('stack_delete_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.StackExists¶waiter = client.get_waiter('stack_exists')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 20
None
CloudFormation.Waiter.StackImportComplete¶waiter = client.get_waiter('stack_import_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.StackRollbackComplete¶waiter = client.get_waiter('stack_rollback_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.StackUpdateComplete¶waiter = client.get_waiter('stack_update_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_stacks() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
StackName='string',
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.Waiter.TypeRegistrationComplete¶waiter = client.get_waiter('type_registration_complete')
wait(**kwargs)¶Polls CloudFormation.Client.describe_type_registration() every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
RegistrationToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The identifier for this registration request.
This registration token is generated by CloudFormation when you initiate a registration request using `` RegisterType `` .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 120
None
CloudFormation.ServiceResource¶A resource representing AWS CloudFormation:
import boto3
cloudformation = boto3.resource('cloudformation')
These are the resource's available actions:
These are the resource's available sub-resources:
These are the resource's available collections:
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
create_stack(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
stack = cloudformation.create_stack(
StackName='string',
TemplateBody='string',
TemplateURL='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
DisableRollback=True|False,
RollbackConfiguration={
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
TimeoutInMinutes=123,
NotificationARNs=[
'string',
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
ResourceTypes=[
'string',
],
RoleARN='string',
OnFailure='DO_NOTHING'|'ROLLBACK'|'DELETE',
StackPolicyBody='string',
StackPolicyURL='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string',
EnableTerminationProtection=True|False
)
[REQUIRED]
The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
Note
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.
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.
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.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
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.
The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
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.
DisableRollback is not set or is set to false , the stack will be rolled back.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).
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.CAPABILITY_NAMED_IAM .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.Warning
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 .
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 .
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.
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
StackPolicyBody or the StackPolicyURL parameter, but not both.StackPolicyBody or the StackPolicyURL parameter, but not both.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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
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 .
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.
cloudformation.Stack
Stack resource
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Event(id)¶Creates a Event resource.:
event = cloudformation.Event('id')
CloudFormation.EventStack(name)¶Creates a Stack resource.:
stack = cloudformation.Stack('name')
CloudFormation.StackStackResource(stack_name, logical_id)¶Creates a StackResource resource.:
stack_resource = cloudformation.StackResource('stack_name','logical_id')
A StackResource resource
StackResourceSummary(stack_name, logical_id)¶Creates a StackResourceSummary resource.:
stack_resource_summary = cloudformation.StackResourceSummary('stack_name','logical_id')
A StackResourceSummary resource
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
stacks¶A collection of Stack resources.A Stack Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all()¶Creates an iterable of all Stack resources in the collection.
See also: AWS API Documentation
Request Syntax
stack_iterator = cloudformation.stacks.all()
cloudformation.Stack)filter(**kwargs)¶Creates an iterable of all Stack resources in the collection filtered by kwargs passed to method. A Stack collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
stack_iterator = cloudformation.stacks.filter(
StackName='string',
NextToken='string'
)
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
Default: There is no default value.
list(cloudformation.Stack)
A list of Stack resources
limit(**kwargs)¶Creates an iterable up to a specified amount of Stack resources in the collection.
See also: AWS API Documentation
Request Syntax
stack_iterator = cloudformation.stacks.limit(
count=123
)
cloudformation.Stack)page_size(**kwargs)¶Creates an iterable of all Stack resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
stack_iterator = cloudformation.stacks.page_size(
count=123
)
cloudformation.Stack)CloudFormation.Event(id)¶A resource representing an AWS CloudFormation Event:
import boto3
cloudformation = boto3.resource('cloudformation')
event = cloudformation.Event('id')
These are the resource's available identifiers:
These are the resource's available attributes:
client_request_tokenevent_idhook_failure_modehook_invocation_pointhook_statushook_status_reasonhook_typelogical_resource_idphysical_resource_idresource_propertiesresource_statusresource_status_reasonresource_typestack_idstack_nametimestampIdentifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
id¶(string) The Event's id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
client_request_token¶(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 .
event_id¶(string) --
The unique ID of this event.
hook_failure_mode¶(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.hook_invocation_point¶(string) --
Invocation points are points in provisioning logic where hooks are initiated.
hook_status¶(string) --
Provides the status of the change set hook.
hook_status_reason¶(string) --
Provides the reason for the hook status.
hook_type¶(string) --
The name of the hook.
logical_resource_id¶(string) --
The logical name of the resource specified in the template.
physical_resource_id¶(string) --
The name or unique identifier associated with the physical instance of the resource.
resource_properties¶(string) --
BLOB of the properties used to create the resource.
resource_status¶(string) --
Current status of the resource.
resource_status_reason¶(string) --
Success/failure message associated with the resource.
resource_type¶(string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
stack_id¶(string) --
The unique ID name of the instance of the stack.
stack_name¶(string) --
The name associated with a stack.
timestamp¶(datetime) --
Time the status was updated.
CloudFormation.Stack(name)¶A resource representing an AWS CloudFormation Stack:
import boto3
cloudformation = boto3.resource('cloudformation')
stack = cloudformation.Stack('name')
These are the resource's available identifiers:
These are the resource's available attributes:
capabilitieschange_set_idcreation_timedeletion_timedescriptiondisable_rollbackdrift_informationenable_termination_protectionlast_updated_timenotification_arnsoutputsparametersparent_idrole_arnrollback_configurationroot_idstack_idstack_namestack_statusstack_status_reasontagstimeout_in_minutesThese are the resource's available actions:
These are the resource's available sub-resources:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
name¶(string) The Stack's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
capabilities¶(list) --
The capabilities allowed in the stack.
change_set_id¶(string) --
The unique ID of the change set.
creation_time¶(datetime) --
The time at which the stack was created.
deletion_time¶(datetime) --
The time the stack was deleted.
description¶(string) --
A user-defined description associated with the stack.
disable_rollback¶(boolean) --
Boolean to enable or disable rollback on stack creation failures:
true : disable rollback.false : enable rollback.drift_information¶(dict) --
Information about whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources .
StackDriftStatus (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.LastCheckTimestamp (datetime) --
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
enable_termination_protection¶(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 .
last_updated_time¶(datetime) --
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
notification_arns¶(list) --
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
outputs¶(list) --
A list of output structures.
(dict) --
The Output data type.
OutputKey (string) --
The key associated with the output.
OutputValue (string) --
The value associated with the output.
Description (string) --
User defined description associated with the output.
ExportName (string) --
The name of the export associated with the output.
parameters¶(list) --
A list of Parameter structures.
(dict) --
The Parameter data type.
ParameterKey (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 (string) --
The input value associated with the parameter.
UsePreviousValue (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.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
parent_id¶(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 .
role_arn¶(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.
rollback_configuration¶(dict) --
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
RollbackTriggers (list) --
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
(dict) --
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.
Arn (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 (string) --
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
MonitoringTimeInMinutes (integer) --
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.
root_id¶(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 .
stack_id¶(string) --
Unique identifier of the stack.
stack_name¶(string) --
The name associated with the stack.
stack_status¶(string) --
Current status of the stack.
stack_status_reason¶(string) --
Success/failure message associated with the stack status.
(list) --
A list of Tag s that specify information about the stack.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
Key (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 (string) --
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
timeout_in_minutes¶(integer) --
The amount of time within which stack creation should complete.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
cancel_update(**kwargs)¶Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
Note
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
See also: AWS API Documentation
Request Syntax
response = stack.cancel_update(
ClientRequestToken='string'
)
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.delete(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = stack.delete(
RetainResources=[
'string',
],
RoleARN='string',
ClientRequestToken='string'
)
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.
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.
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 .
None
get_available_subresources()¶Returns a list of all the available sub-resources for this Resource.
load()¶Calls CloudFormation.Client.describe_stacks() to update the attributes of the Stack resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
stack.load()
reload()¶Calls CloudFormation.Client.describe_stacks() to update the attributes of the Stack resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
stack.reload()
update(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = stack.update(
TemplateBody='string',
TemplateURL='string',
UsePreviousTemplate=True|False,
StackPolicyDuringUpdateBody='string',
StackPolicyDuringUpdateURL='string',
Parameters=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
Capabilities=[
'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
],
ResourceTypes=[
'string',
],
RoleARN='string',
RollbackConfiguration={
'RollbackTriggers': [
{
'Arn': 'string',
'Type': 'string'
},
],
'MonitoringTimeInMinutes': 123
},
StackPolicyBody='string',
StackPolicyURL='string',
NotificationARNs=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DisableRollback=True|False,
ClientRequestToken='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 .
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.
Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .
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 .
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.
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. 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.
A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
The Parameter data type.
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.
The input value associated with the parameter.
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.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for ` SSM https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types`__ parameter types in the template.
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.CAPABILITY_NAMED_IAM .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.Warning
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 .
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 .
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.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
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:
If a specified trigger is missing, the entire stack operation fails and is rolled back.
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.
The Amazon Resource Name (ARN) of the rollback trigger.
If a specified trigger is missing, the entire stack operation fails and is rolled back.
The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
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.
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.
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. 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.
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
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.
The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
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:.
Required . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
Preserve the state of previously provisioned resources when an operation fails.
Default: False
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 .
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
The output for an UpdateStack action.
StackId (string) --
Unique identifier of the stack.
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Resource(logical_id)¶Creates a StackResource resource.:
stack_resource = stack.Resource('logical_id')
CloudFormation.StackResourceCollections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
events¶A collection of Event resources.A Event Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all()¶Creates an iterable of all Event resources in the collection.
See also: AWS API Documentation
Request Syntax
event_iterator = stack.events.all()
cloudformation.Event)filter(**kwargs)¶Creates an iterable of all Event resources in the collection filtered by kwargs passed to method. A Event collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
event_iterator = stack.events.filter(
NextToken='string'
)
cloudformation.Event)limit(**kwargs)¶Creates an iterable up to a specified amount of Event resources in the collection.
See also: AWS API Documentation
Request Syntax
event_iterator = stack.events.limit(
count=123
)
cloudformation.Event)page_size(**kwargs)¶Creates an iterable of all Event resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
event_iterator = stack.events.page_size(
count=123
)
cloudformation.Event)resource_summaries¶A collection of StackResourceSummary resources.A StackResourceSummary Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all()Creates an iterable of all StackResourceSummary resources in the collection.
See also: AWS API Documentation
Request Syntax
stack_resource_summary_iterator = stack.resource_summaries.all()
cloudformation.StackResourceSummary)filter(**kwargs)Creates an iterable of all StackResourceSummary resources in the collection filtered by kwargs passed to method. A StackResourceSummary collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
stack_resource_summary_iterator = stack.resource_summaries.filter(
NextToken='string'
)
cloudformation.StackResourceSummary)limit(**kwargs)Creates an iterable up to a specified amount of StackResourceSummary resources in the collection.
See also: AWS API Documentation
Request Syntax
stack_resource_summary_iterator = stack.resource_summaries.limit(
count=123
)
cloudformation.StackResourceSummary)page_size(**kwargs)Creates an iterable of all StackResourceSummary resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
stack_resource_summary_iterator = stack.resource_summaries.page_size(
count=123
)
cloudformation.StackResourceSummary)CloudFormation.StackResource(stack_name, logical_id)¶A resource representing an AWS CloudFormation StackResource:
import boto3
cloudformation = boto3.resource('cloudformation')
stack_resource = cloudformation.StackResource('stack_name','logical_id')
These are the resource's available identifiers:
These are the resource's available attributes:
descriptiondrift_informationlast_updated_timestamplogical_resource_idmetadatamodule_infophysical_resource_idresource_statusresource_status_reasonresource_typestack_idThese are the resource's available sub-resources:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
stack_name¶(string) The StackResource's stack_name identifier. This must be set.
logical_id¶(string) The StackResource's logical_id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
description¶(string) --
User defined description associated with the resource.
drift_information¶(dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
last_updated_timestamp¶(datetime) --
Time the status was updated.
logical_resource_id¶(string) --
The logical name of the resource specified in the template.
metadata¶(string) --
The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the CloudFormation User Guide.
module_info¶(dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
physical_resource_id¶(string) --
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
resource_status¶(string) --
Current status of the resource.
resource_status_reason¶(string) --
Success/failure message associated with the resource.
resource_type¶(string) --
Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.
stack_id¶(string) --
Unique identifier of the stack.
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Stack()¶Creates a Stack resource.:
stack = stack_resource.Stack()
CloudFormation.StackCloudFormation.StackResourceSummary(stack_name, logical_id)¶A resource representing an AWS CloudFormation StackResourceSummary:
import boto3
cloudformation = boto3.resource('cloudformation')
stack_resource_summary = cloudformation.StackResourceSummary('stack_name','logical_id')
These are the resource's available identifiers:
These are the resource's available attributes:
drift_informationlast_updated_timestamplogical_resource_idmodule_infophysical_resource_idresource_statusresource_status_reasonresource_typeThese are the resource's available sub-resources:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
stack_name¶(string) The StackResourceSummary's stack_name identifier. This must be set.
logical_id¶(string) The StackResourceSummary's logical_id identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load() method.
For more information about attributes refer to the Resources Introduction Guide.
drift_information¶(dict) --
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 .
StackResourceDriftStatus (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.LastCheckTimestamp (datetime) --
When CloudFormation last checked if the resource had drifted from its expected configuration.
last_updated_timestamp¶(datetime) --
Time the status was updated.
logical_resource_id¶(string) --
The logical name of the resource specified in the template.
module_info¶(dict) --
Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
TypeHierarchy (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
LogicalIdHierarchy (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 .
physical_resource_id¶(string) --
The name or unique identifier that corresponds to a physical instance ID of the resource.
resource_status¶(string) --
Current status of the resource.
resource_status_reason¶(string) --
Success/failure message associated with the resource.
resource_type¶(string) --
Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.)
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Resource()¶Creates a StackResource resource.:
stack_resource = stack_resource_summary.Resource()
CloudFormation.StackResource