String status
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. AWS CloudFormation proceeds with the stack operation in that
account and region.
FAILED: The account gate function has determined that the account and region does not meet the
requirements for a stack set operation to occur. AWS 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: AWS CloudFormation has skipped calling the account gate function for this account and
region, for one of the following reasons:
An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions
to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
String statusReason
The reason for the account gate status assigned to this account and region for the stack set operation.
String stackName
The name or the unique stack ID that is associated with the stack.
String clientRequestToken
A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
requests so that AWS 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 AWS CloudFormation successfully
received them.
String type
The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
ResourceChange resourceChange
A ResourceChange structure that describes the resource and action that AWS CloudFormation will
perform.
String stackId
The ID of the stack with which the change set is associated.
String stackName
The name of the stack with which the change set is associated.
String changeSetId
The ID of the change set.
String changeSetName
The name of the change set.
String executionStatus
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 AWS CloudFormation is still creating it or in an OBSOLETE
state because the stack was already updated.
String status
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
FAILED.
String statusReason
A description of the change set's status. For example, if your change set is in the FAILED state,
AWS CloudFormation shows the error message.
Date creationTime
The start time when the change set was created, in UTC.
String description
Descriptive information about the change set.
String stackName
The name or the unique ID of the stack that you want to continue rolling back.
Don't specify the name of a nested stack (a stack that was created by using the
AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
that contains the AWS::CloudFormation::Stack resource).
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
SdkInternalList<T> resourcesToSkip
A list of the logical IDs of the resources that AWS 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 cancelled. To check why a resource update failed, use the
DescribeStackResources action, and view the resource status reason.
Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
performing another stack update, you must update the stack or resources to be consistent with each other. If you
don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.
To skip resources that are part of nested stacks, use the following format:
NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (
Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding
embedded stack must be in one of the following states: DELETE_IN_PROGRESS,
DELETE_COMPLETE, or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
String clientRequestToken
A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the
same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation
successfully received them.
String stackName
The name or the unique ID of the stack for which you are creating a change set. AWS 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.
String templateBody
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. AWS 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.
String templateURL
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
Boolean usePreviousTemplate
Whether to reuse the template that is associated with the stack to create the change set.
SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data
type.
SdkInternalList<T> capabilities
A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review
all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> resourceTypes
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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
RollbackConfiguration rollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
SdkInternalList<T> notificationARNs
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
String changeSetName
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 alphabetic character and cannot exceed 128 characters.
String clientToken
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same
name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully
received them.
String description
A description to help you identify this change set.
String changeSetType
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.
If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no
template or resources. The stack will be in the
REVIEW_IN_PROGRESS state until you execute the change set.
By default, AWS 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.
String stackSetName
The name or unique ID of the stack set that you want to create stack instances from.
SdkInternalList<T> accounts
The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
SdkInternalList<T> regions
The names of one or more regions where you want to create stack instances using the specified AWS account(s).
StackSetOperationPreferences operationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
String operationId
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS 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.
String operationId
The unique identifier for this stack set operation.
String stackName
The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
String templateBody
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 AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
not both.
String templateURL
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. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
not both.
SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters for the stack. For more information,
see the Parameter data
type.
Boolean disableRollback
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
RollbackConfiguration rollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Integer timeoutInMinutes
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
is not set or is set to false, the stack will be rolled back.
SdkInternalList<T> notificationARNs
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
SdkInternalList<T> capabilities
A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review
all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> resourceTypes
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 AWS resource),
Custom::* (for all custom resources), Custom::logical_ID (for a specific custom
resource), AWS::service_name::* (for all resources of a particular AWS service), and
AWS::service_name::resource_logical_ID (for a specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
String onFailure
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
String stackPolicyBody
Structure containing the stack policy body. For more information, go to Prevent
Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
String clientRequestToken
A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
CreateStack requests to ensure that AWS 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.
String stackId
Unique identifier of the stack.
String stackSetName
The name to associate with the stack set. The name must be unique in the region where you create your stack set.
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
String description
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
String templateBody
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 AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
String templateURL
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. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
SdkInternalList<T> parameters
The input parameters for the stack set template.
SdkInternalList<T> capabilities
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> tags
The key-value pairs to associate with this stack set and the stacks created from it. AWS 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, AWS 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.
String clientRequestToken
A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same
name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully
received them.
If you don't specify an operation ID, the SDK generates one automatically.
String stackSetId
The ID of the stack set that you're creating.
String stackSetName
The name or unique ID of the stack set that you want to delete stack instances for.
SdkInternalList<T> accounts
The names of the AWS accounts that you want to delete stack instances for.
SdkInternalList<T> regions
The regions where you want to delete stack set instances.
StackSetOperationPreferences operationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
Boolean retainStacks
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.
String operationId
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 AWS 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 AWS CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is
OUTDATED.
String operationId
The unique identifier for this stack set operation.
String stackName
The name or the unique stack ID that is associated with the stack.
SdkInternalList<T> retainResources
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, AWS CloudFormation deletes the stack but does not delete the
retained resources.
Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
String clientRequestToken
A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry
DeleteStack requests to ensure that AWS 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.
String stackSetName
The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
String nextToken
A string that identifies the next page of limits that you want to retrieve.
SdkInternalList<T> accountLimits
An account limit structure that contain a list of AWS CloudFormation account limits and their values.
String nextToken
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.
String changeSetName
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
String stackName
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
String nextToken
A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
String changeSetName
The name of the change set.
String changeSetId
The ARN of the change set.
String stackId
The ARN of the stack that is associated with the change set.
String stackName
The name of the stack that is associated with the change set.
String description
Information about the change set.
SdkInternalList<T> parameters
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.
Date creationTime
The start time when the change set was created, in UTC.
String executionStatus
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 AWS CloudFormation is still creating it or in an OBSOLETE
state because the stack was already updated.
String status
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
FAILED.
String statusReason
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
SdkInternalList<T> notificationARNs
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 rollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
SdkInternalList<T> capabilities
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
SdkInternalList<T> tags
If you execute the change set, the tags that will be associated with the stack.
SdkInternalList<T> changes
A list of Change structures that describes the resources AWS CloudFormation changes if you execute
the change set.
String nextToken
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.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
String nextToken
A string that identifies the next page of events that you want to retrieve.
SdkInternalList<T> stackEvents
A list of StackEvents structures.
String nextToken
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.
String stackSetName
The name or the unique stack ID of the stack set that you want to get stack instance information for.
String stackInstanceAccount
The ID of an AWS account that's associated with this stack instance.
String stackInstanceRegion
The name of a region that's associated with this stack instance.
StackInstance stackInstance
The stack instance that matches the specified request parameters.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
StackResourceDetail stackResourceDetail
A StackResourceDetail structure containing the description of the specified resource in the
specified stack.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
Required: Conditional. If you do not specify StackName, you must specify
PhysicalResourceId.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS 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 do not specify PhysicalResourceId, you must specify
StackName.
Default: There is no default value.
SdkInternalList<T> stackResources
A list of StackResource structures.
StackSetOperation stackSetOperation
The specified stack set operation.
String stackSetName
The name or unique ID of the stack set whose description you want.
StackSet stackSet
The specified stack set.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
String nextToken
A string that identifies the next page of stacks that you want to retrieve.
SdkInternalList<T> stacks
A list of stack structures.
String nextToken
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.
String templateBody
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 AWS CloudFormation User Guide.)
Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only
TemplateBody is used.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
TemplateBody is used.
SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters.
String url
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
String changeSetName
The name or ARN of the change set that you want use to update the specified stack.
String stackName
If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.
String clientRequestToken
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry
requests so that AWS 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 AWS CloudFormation
successfully received them.
String exportingStackId
The stack that contains the exported output name and value.
String name
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.
String value
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.
String stackName
The name or unique stack ID that is associated with the stack whose policy you want to get.
String stackPolicyBody
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
String changeSetName
The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated
template. If you specify a name, you must also specify the StackName.
String templateStage
For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the
user-submitted template, specify Original. To get the template after AWS CloudFormation has
processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same
template. By default, AWS CloudFormation specifies Original.
String templateBody
Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
AWS CloudFormation returns the same template that was used when the stack was created.
SdkInternalList<T> stagesAvailable
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
AWS CloudFormation finishes creating the change set, the Processed template becomes available.
String templateBody
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 AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName,
StackSetName, TemplateBody, or TemplateURL.
String templateURL
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. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName,
StackSetName, TemplateBody, or TemplateURL.
String stackName
The name or the stack ID that is associated with the stack, which are not 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.
String stackSetName
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.
SdkInternalList<T> parameters
A list of parameter declarations that describe various properties for each parameter.
String description
The value that is defined in the Description property of the template.
SdkInternalList<T> capabilities
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 AWS CloudFormation Templates.
String capabilitiesReason
The list of resources that generated the values in the Capabilities response element.
SdkInternalList<T> resourceTypes
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.
String version
The AWS template format version, which identifies the capabilities of the template.
String metadata
The value that is defined for the Metadata property of the template.
SdkInternalList<T> declaredTransforms
A list of the transforms that are declared in the template.
String stackName
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
String nextToken
A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
SdkInternalList<T> summaries
A list of ChangeSetSummary structures that provides the ID and status of each change set for the
specified stack.
String nextToken
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.
String nextToken
A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.
SdkInternalList<T> exports
The output for the ListExports action.
String nextToken
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.
String exportName
The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.
String nextToken
A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
SdkInternalList<T> imports
A list of stack names that are importing the specified exported output value.
String nextToken
A string that identifies the next page of exports. If there is no additional page, this value is null.
String stackSetName
The name or unique ID of the stack set that you want to list stack instances for.
String nextToken
If the previous request didn't return all of the remaining results, the response's NextToken
parameter value is set to a token. To retrieve the next set of results, call ListStackInstances
again and assign that token to the request object's NextToken parameter. If there are no remaining
results, the previous response object's NextToken parameter is set to null.
Integer maxResults
The maximum number of results to be returned with a single call. If the number of available results exceeds this
maximum, the response includes a NextToken value that you can assign to the NextToken
request parameter to get the next set of results.
String stackInstanceAccount
The name of the AWS account that you want to list stack instances for.
String stackInstanceRegion
The name of the region where you want to list stack instances.
SdkInternalList<T> summaries
A list of StackInstanceSummary structures that contain information about the specified stack
instances.
String nextToken
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.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Running stacks: You can specify either the stack's name or its unique stack ID.
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
String nextToken
A string that identifies the next page of stack resources that you want to retrieve.
SdkInternalList<T> stackResourceSummaries
A list of StackResourceSummary structures.
String nextToken
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.
String stackSetName
The name or unique ID of the stack set that you want to get operation results for.
String operationId
The ID of the stack set operation.
String nextToken
If the previous request didn't return all of the remaining results, the response object's NextToken
parameter value is set to a token. To retrieve the next set of results, call
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.
Integer maxResults
The maximum number of results to be returned with a single call. If the number of available results exceeds this
maximum, the response includes a NextToken value that you can assign to the NextToken
request parameter to get the next set of results.
SdkInternalList<T> summaries
A list of StackSetOperationResultSummary structures that contain information about the specified
operation results, for accounts and regions that are included in the operation.
String nextToken
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.
String stackSetName
The name or unique ID of the stack set that you want to get operation summaries for.
String nextToken
If the previous paginated request didn't return all of the remaining results, the response object's
NextToken parameter value is set to a token. To retrieve the next set of results, call
ListStackSetOperations again and assign that token to the request object's NextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is
set to null.
Integer maxResults
The maximum number of results to be returned with a single call. If the number of available results exceeds this
maximum, the response includes a NextToken value that you can assign to the NextToken
request parameter to get the next set of results.
SdkInternalList<T> summaries
A list of StackSetOperationSummary structures that contain summary information about operations for
the specified stack set.
String nextToken
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.
String nextToken
If the previous paginated request didn't return all of the remaining results, the response object's
NextToken parameter value is set to a token. To retrieve the next set of results, call
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.
Integer maxResults
The maximum number of results to be returned with a single call. If the number of available results exceeds this
maximum, the response includes a NextToken value that you can assign to the NextToken
request parameter to get the next set of results.
String status
The status of the stack sets that you want to get summary information about.
SdkInternalList<T> summaries
A list of StackSetSummary structures that contain information about the user's stack sets.
String nextToken
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.
String nextToken
A string that identifies the next page of stacks that you want to retrieve.
SdkInternalList<T> stackStatusFilters
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.
SdkInternalList<T> stackSummaries
A list of StackSummary structures containing information about the specified stacks.
String nextToken
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.
String parameterKey
The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
String parameterValue
The value associated with the parameter.
Boolean usePreviousValue
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.
SdkInternalList<T> allowedValues
A list of values that are permitted for a parameter.
String parameterKey
The name that is associated with the parameter.
String defaultValue
The default value of the parameter.
String parameterType
The type of parameter.
Boolean noEcho
Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
String description
The description that is associate with the parameter.
ParameterConstraints parameterConstraints
The criteria that AWS CloudFormation uses to validate parameter values.
String action
The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource),
Modify (changes a resource), or Remove (deletes a resource).
String logicalResourceId
The resource's logical ID, which is defined in the stack's template.
String physicalResourceId
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
String resourceType
The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
String replacement
For the Modify action, indicates whether AWS 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.
SdkInternalList<T> scope
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.
SdkInternalList<T> details
For the Modify action, a list of ResourceChangeDetail structures that describes the
changes that AWS CloudFormation will make to the resource.
ResourceTargetDefinition target
A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change
and whether the resource will be recreated.
String evaluation
Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.
For Static evaluations, AWS 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, AWS
CloudFormation knows that this property value will change, and its value, so this is a Static
evaluation.
For Dynamic evaluations, cannot 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 is 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.
String changeSource
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, AWS
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 AWS CloudFormation until you run an
update on the parent stack.
String causingEntity
The identity of the entity that triggered this change. This entity is a member of the group that is 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.
String attribute
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
Metadata, Properties, or Tags.
String name
If the Attribute value is Properties, the name of the property. For all other
attributes, the value is null.
String requiresRecreation
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 AWS CloudFormation User Guide.
SdkInternalList<T> rollbackTriggers
The triggers to monitor during stack creation or update actions.
By default, AWS 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 you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.
If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.
If you specify an empty list, AWS CloudFormation removes all currently specified triggers.
If a specified Cloudwatch alarm is missing, the entire stack operation fails and is rolled back.
Integer monitoringTimeInMinutes
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. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.
If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for 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.
String arn
The Amazon Resource Name (ARN) of the rollback trigger.
String type
The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
String stackName
The name or unique stack ID that you want to associate a policy with.
String stackPolicyBody
Structure containing the stack policy body. For more information, go to Prevent
Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
StackPolicyBody or the StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackName
The stack name or unique stack ID that includes the resource that you want to signal.
String logicalResourceId
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.
String uniqueId
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.
String status
The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
String stackId
Unique identifier of the stack.
String stackName
The name associated with the stack.
String changeSetId
The unique ID of the change set.
String description
A user-defined description associated with the stack.
SdkInternalList<T> parameters
A list of Parameter structures.
Date creationTime
The time at which the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
RollbackConfiguration rollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
String stackStatus
Current status of the stack.
String stackStatusReason
Success/failure message associated with the stack status.
Boolean disableRollback
Boolean to enable or disable rollback on stack creation failures:
true: disable rollback
false: enable rollback
SdkInternalList<T> notificationARNs
SNS topic ARNs to which stack related events are published.
Integer timeoutInMinutes
The amount of time within which stack creation should complete.
SdkInternalList<T> capabilities
The capabilities allowed in the stack.
SdkInternalList<T> outputs
A list of output structures.
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
SdkInternalList<T> tags
A list of Tags that specify information about the stack.
String stackId
The unique ID name of the instance of the stack.
String eventId
The unique ID of this event.
String stackName
The name associated with a stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier associated with the physical instance of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String resourceProperties
BLOB of the properties used to create the resource.
String clientRequestToken
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.
String stackSetId
The name or unique ID of the stack set that the stack instance is associated with.
String region
The name of the AWS region that the stack instance is associated with.
String account
The name of the AWS account that the stack instance is associated with.
String stackId
The ID of the stack instance.
String status
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:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was
stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
String statusReason
The explanation for the specific status code that is assigned to this stack instance.
String stackSetId
The name or unique ID of the stack set that the stack instance is associated with.
String region
The name of the AWS region that the stack instance is associated with.
String account
The name of the AWS account that the stack instance is associated with.
String stackId
The ID of the stack instance.
String status
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:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was
stopped before the stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
String statusReason
The explanation for the specific status code assigned to this stack instance.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String metadata
The content of the Metadata attribute declared for the resource. For more information, see Metadata
Attribute in the AWS CloudFormation User Guide.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String stackSetName
The name that's associated with the stack set.
String stackSetId
The ID of the stack set.
String description
A description of the stack set that you specify when the stack set is created or updated.
String status
The status of the stack set.
String templateBody
The structure that contains the body of the template that was used to create or update the stack set.
SdkInternalList<T> parameters
A list of input parameters for a stack set.
SdkInternalList<T> capabilities
The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> tags
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
String operationId
The unique ID of a stack set operation.
String stackSetId
The ID of the stack set.
String action
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, as well as all associated stack set instances.
String status
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 AWS
CloudFormation cancels the operation in any remaining regions.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled 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.
StackSetOperationPreferences operationPreferences
The preferences for how AWS CloudFormation performs this stack set operation.
Boolean retainStacks
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 reassociate a retained stack, or add an
existing, saved stack to a new stack set.
Date creationTimestamp
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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
Date endTimestamp
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.
SdkInternalList<T> regionOrder
The order of the regions in where you want to perform the stack operation.
Integer failureToleranceCount
The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.
Conditional: You must specify either FailureToleranceCount or
FailureTolerancePercentage (but not both).
Integer failureTolerancePercentage
The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or
FailureTolerancePercentage, but not both.
Integer maxConcurrentCount
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 .
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but
not both.
Integer maxConcurrentPercentage
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, AWS 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.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but
not both.
String account
The name of the AWS account for this operation result.
String region
The name of the AWS region for this operation result.
String status
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 cancelled. 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.
String statusReason
The reason for the assigned result status.
AccountGateResult accountGateResult
The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
String operationId
The unique ID of the stack set operation.
String action
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 as well as all associated stack set instances.
String status
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 AWS
CloudFormation cancels the operation in any remaining regions.
RUNNING: The operation is currently being performed.
STOPPED: The user has cancelled 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.
Date creationTimestamp
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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
Date endTimestamp
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.
String stackId
Unique stack identifier.
String stackName
The name associated with the stack.
String templateDescription
The template description of the template used to create the stack.
Date creationTime
The time the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
Date deletionTime
The time the stack was deleted.
String stackStatus
The current status of the stack.
String stackStatusReason
Success/Failure message associated with the stack status.
String key
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 (AWS) have the reserved prefix: aws:.
String value
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
String parameterKey
The name associated with the parameter.
String defaultValue
The default value associated with the parameter.
Boolean noEcho
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
String description
User defined description associated with the parameter.
String stackName
The name or unique stack ID of the stack to update.
String templateBody
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 AWS CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
Boolean usePreviousTemplate
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.
String stackPolicyDuringUpdateBody
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 do not specify a stack policy, the current policy that is associated with the stack will be used.
String stackPolicyDuringUpdateURL
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 do not specify a stack policy, the current policy that is associated with the stack will be used.
SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters for the stack. For more information,
see the Parameter data
type.
SdkInternalList<T> capabilities
A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review
all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> resourceTypes
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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
String roleARN
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS 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, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
RollbackConfiguration rollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
String stackPolicyBody
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 do not specify a stack policy, the current policy that is associated with the stack is unchanged.
String stackPolicyURL
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 do not specify a stack policy, the current policy that is associated with the stack is unchanged.
SdkInternalList<T> notificationARNs
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
String clientRequestToken
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests
so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
UpdateStack requests to ensure that AWS 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.
String stackId
Unique identifier of the stack.
String stackSetName
The name or unique ID of the stack set that you want to update.
String description
A brief description of updates that you are making.
String templateBody
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 AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or
TemplateURL—or set UsePreviousTemplate to true.
String templateURL
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. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or
TemplateURL—or set UsePreviousTemplate to true.
Boolean usePreviousTemplate
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.
SdkInternalList<T> parameters
A list of input parameters for the stack set template.
SdkInternalList<T> capabilities
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you
must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an
InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
SdkInternalList<T> tags
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet action, AWS 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, AWS 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.
StackSetOperationPreferences operationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
String operationId
The unique ID for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.
If you don't specify an operation ID, AWS CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is
OUTDATED.
String operationId
The unique ID for this stack set operation.
String templateBody
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 AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
TemplateBody is used.
String templateURL
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. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
TemplateBody is used.
SdkInternalList<T> parameters
A list of TemplateParameter structures.
String description
The description found within the template.
SdkInternalList<T> capabilities
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 AWS CloudFormation Templates.
String capabilitiesReason
The list of resources that generated the values in the Capabilities response element.
SdkInternalList<T> declaredTransforms
A list of the transforms that are declared in the template.
Copyright © 2017. All rights reserved.