2021/11/19 - AWS CloudFormation - 4 updated api methods
Changes The StackSets ManagedExecution feature will allow concurrency for non-conflicting StackSet operations and queuing the StackSet operations that conflict at a given time for later execution.
{'ManagedExecution': {'Active': 'boolean'}}
Creates a stack set.
See also: AWS API Documentation
Request Syntax
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
}
)
string
[REQUIRED]
The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
string
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
string
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
string
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
string
The stack ID you are importing into a new stack set. Specify the Amazon Resource Number (ARN) of the stack.
list
The input parameters for the stack set template.
(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 is 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 Systems Manager parameter key. This field is returned only for SSM parameter types in the template.
list
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
(string) --
list
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.
(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]
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]
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
string
The Amazon Resource Number (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.
string
The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
string
Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
With 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.
With 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.
dict
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.
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.
string
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
To create a stack set with service-managed permissions while signed in to the management account, specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
string
A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
This field is autopopulated if not provided.
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.
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.
{'StackSet': {'ManagedExecution': {'Active': 'boolean'}}}
Returns the description of the specified stack set.
See also: AWS API Documentation
Request Syntax
client.describe_stack_set(
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set whose description you want.
string
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
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 is 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 Systems Manager parameter key. This field is returned only for SSM 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.
(string) --
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 Number (ARN) of the stack set.
AdministrationRoleARN (string) --
The Amazon Resource Number (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 is not 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 has not 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 cancelled 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 has not 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:
Stack instances that match the stack set configuration.
Stack instances that have drifted from the stack set configuration.
Stack instances where the drift detection operation has failed.
Stack instances currently being checked for drift.
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 do not 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.
With 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.
With 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.
(string) --
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.
When false (default), StackSets performs one operation at a time in request order.
{'Summaries': {'ManagedExecution': {'Active': 'boolean'}}}
Returns summary information about stack sets that are associated with the user.
[Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.
See also: AWS API Documentation
Request Syntax
client.list_stack_sets(
NextToken='string',
MaxResults=123,
Status='ACTIVE'|'DELETED',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call 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
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
The status of the stack sets that you want to get summary information about.
string
[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
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.
With 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.
With 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 has not 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.
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 has not 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.
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.
{'ManagedExecution': {'Active': 'boolean'}}
Updates the stack set, and associated stack instances in the specified accounts and 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
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',
]
},
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
}
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to update.
string
A brief description of updates that you are making.
string
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
string
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
boolean
Use the existing template that's associated with the stack set that you're updating.
Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
list
A list of input parameters for the stack set template.
(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 is 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 Systems Manager parameter key. This field is returned only for SSM parameter types in the template.
list
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in CloudFormation Templates.
CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
(string) --
list
The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've 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, CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
(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]
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]
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
dict
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.
(string) --
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.
string
The Amazon Resource Number (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.
string
The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
dict
[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 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.
Accounts (list) --
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
(string) --
AccountsUrl (string) --
Returns the value of the AccountsUrl property.
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
(string) --
string
Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.
With 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.
With 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.
dict
[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, do not specify DeploymentTargets or Regions.
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.
string
The unique ID for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
This field is autopopulated if not provided.
list
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions 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.
(string) --
list
The 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.
(string) --
string
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
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.
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.