2023/11/09 - AWS CloudFormation - 8 updated api methods
Changes Added new ConcurrencyMode feature for AWS CloudFormation StackSets for faster deployments to target accounts.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
See also: AWS API Documentation
Request Syntax
client.create_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to create stack instances from.
list
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts or DeploymentTargets, but not both.
(string) --
dict
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.
You can specify Accounts or DeploymentTargets, but not both.
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) --
AccountFilterType (string) --
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
The following is a list of possible values for the AccountFilterType operation.
INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
NONE: Deploys to all the accounts in specified organizational units (OU).
list
[REQUIRED]
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
(string) --
list
A list of stack set parameters whose values you want to override in the selected stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
(dict) --
The Parameter data type.
ParameterKey (string) --
The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
ParameterValue (string) --
The input value associated with the parameter.
UsePreviousValue (boolean) --
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
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 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
string
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
This field is autopopulated if not provided.
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
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
See also: AWS API Documentation
Request Syntax
client.delete_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
RetainStacks=True|False,
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to delete stack instances for.
list
[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets, but not both.
(string) --
dict
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
You can specify Accounts or DeploymentTargets, but not both.
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) --
AccountFilterType (string) --
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
The following is a list of possible values for the AccountFilterType operation.
INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
NONE: Deploys to all the accounts in specified organizational units (OU).
list
[REQUIRED]
The Amazon Web Services Regions where you want to delete stack set instances.
(string) --
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 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
boolean
[REQUIRED]
Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.
For more information, see Stack set operation options.
string
The unique identifier for this stack set operation.
If you don't specify an operation ID, the SDK generates one automatically.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
This field is autopopulated if not provided.
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
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'StackSetOperation': {'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE '
'| '
'SOFT_FAILURE_TOLERANCE'}}}
Returns the description of the specified StackSet operation.
See also: AWS API Documentation
Request Syntax
client.describe_stack_set_operation(
StackSetName='string',
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or the unique stack ID of the stack set for the stack operation.
string
[REQUIRED]
The unique ID of the stack set operation.
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
{
'StackSetOperation': {
'OperationId': 'string',
'StackSetId': 'string',
'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED',
'OperationPreferences': {
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
'RetainStacks': True|False,
'AdministrationRoleARN': 'string',
'ExecutionRoleName': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'DeploymentTargets': {
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
'StackSetDriftDetectionDetails': {
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'NOT_CHECKED',
'DriftDetectionStatus': 'COMPLETED'|'FAILED'|'PARTIAL_SUCCESS'|'IN_PROGRESS'|'STOPPED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1),
'TotalStackInstancesCount': 123,
'DriftedStackInstancesCount': 123,
'InSyncStackInstancesCount': 123,
'InProgressStackInstancesCount': 123,
'FailedStackInstancesCount': 123
},
'StatusReason': 'string',
'StatusDetails': {
'FailedStackInstancesCount': 123
}
}
}
Response Structure
(dict) --
StackSetOperation (dict) --
The specified stack set operation.
OperationId (string) --
The unique ID of a stack set operation.
StackSetId (string) --
The ID of the stack set.
Action (string) --
The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to all associated stack set instances.
Status (string) --
The status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
OperationPreferences (dict) --
The preferences for how CloudFormation performs this stack set operation.
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
RetainStacks (boolean) --
For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.
AdministrationRoleARN (string) --
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
ExecutionRoleName (string) --
The name of the IAM execution role used to create or update the stack set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
CreationTimestamp (datetime) --
The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
EndTimestamp (datetime) --
The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
DeploymentTargets (dict) --
[Service-managed permissions] The Organizations accounts affected by the stack operation.
Accounts (list) --
The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
(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) --
AccountFilterType (string) --
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
The following is a list of possible values for the AccountFilterType operation.
INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
NONE: Deploys to all the accounts in specified organizational units (OU).
StackSetDriftDetectionDetails (dict) --
Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.
This information will only be present for stack set operations whose Action type is DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
DriftStatus (string) --
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.
DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.
DriftDetectionStatus (string) --
The status of the stack set drift detection operation.
COMPLETED: The drift detection operation completed without failing on any stack instances.
FAILED: The drift detection operation exceeded the specified failure tolerance.
PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.
IN_PROGRESS: The drift detection operation is currently being performed.
STOPPED: The user has canceled the drift detection operation.
LastDriftCheckTimestamp (datetime) --
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.
TotalStackInstancesCount (integer) --
The total number of stack instances belonging to this stack set.
The total number of stack instances is equal to the total of:
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 don't match their expected configuration.
InSyncStackInstancesCount (integer) --
The number of stack instances which match the expected template and parameter configuration of the stack set.
InProgressStackInstancesCount (integer) --
The number of stack instances that are currently being checked for drift.
FailedStackInstancesCount (integer) --
The number of stack instances for which the drift detection operation failed.
StatusReason (string) --
The status of the operation in details.
StatusDetails (dict) --
Detailed information about the StackSet operation.
FailedStackInstancesCount (integer) --
The number of stack instances for which the StackSet operation failed.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
See also: AWS API Documentation
Request Syntax
client.detect_stack_set_drift(
StackSetName='string',
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name of the stack set on which to perform the drift detection operation.
dict
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
string
The ID of the stack set operation.
This field is autopopulated if not provided.
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
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The ID of the drift detection stack set operation.
You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
See also: AWS API Documentation
Request Syntax
client.import_stacks_to_stack_set(
StackSetName='string',
StackIds=[
'string',
],
StackIdsUrl='string',
OrganizationalUnitIds=[
'string',
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name of the stack set. The name must be unique in the Region where you create your stack set.
list
The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.
Specify either StackIds or StackIdsUrl.
(string) --
string
The Amazon S3 URL which contains list of stack ids to be inputted.
Specify either StackIds or StackIdsUrl.
list
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
(string) --
dict
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
string
A unique, user defined, identifier for the stack set operation.
This field is autopopulated if not provided.
string
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
If you are signed in to the management account, specify SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for the stack set operation.
{'Summaries': {'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE '
'| '
'SOFT_FAILURE_TOLERANCE'}}}
Returns summary information about operations performed on a stack set.
See also: AWS API Documentation
Request Syntax
client.list_stack_set_operations(
StackSetName='string',
NextToken='string',
MaxResults=123,
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to get operation summaries for.
string
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
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
[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
{
'Summaries': [
{
'OperationId': 'string',
'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT',
'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'StatusReason': 'string',
'StatusDetails': {
'FailedStackInstancesCount': 123
},
'OperationPreferences': {
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
(dict) --
The structures that contain summary information about the specified operation.
OperationId (string) --
The unique ID of the stack set operation.
Action (string) --
The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
Status (string) --
The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at user request.
SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
CreationTimestamp (datetime) --
The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
EndTimestamp (datetime) --
The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
StatusReason (string) --
The status of the operation in details.
StatusDetails (dict) --
Detailed information about the stack set operation.
FailedStackInstancesCount (integer) --
The number of stack instances for which the StackSet operation failed.
OperationPreferences (dict) --
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
RegionConcurrencyType (string) --
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) --
The order of the Regions 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
NextToken (string) --
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
See also: AWS API Documentation
Request Syntax
client.update_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set associated with the stack instances.
list
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
You can specify Accounts or DeploymentTargets, but not both.
(string) --
dict
[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.
You can specify Accounts or DeploymentTargets, but not both.
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) --
AccountFilterType (string) --
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
The following is a list of possible values for the AccountFilterType operation.
INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
NONE: Deploys to all the accounts in specified organizational units (OU).
list
[REQUIRED]
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
(string) --
list
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
To override the current value for a parameter, include the parameter and specify its value.
To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
(dict) --
The Parameter data type.
ParameterKey (string) --
The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
ParameterValue (string) --
The input value associated with the parameter.
UsePreviousValue (boolean) --
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
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 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
string
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
This field is autopopulated if not provided.
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
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'OperationPreferences': {'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE | '
'SOFT_FAILURE_TOLERANCE'}}
Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
See also: AWS API Documentation
Request Syntax
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,
'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
},
AdministrationRoleARN='string',
ExecutionRoleName='string',
DeploymentTargets={
'Accounts': [
'string',
],
'AccountsUrl': 'string',
'OrganizationalUnitIds': [
'string',
],
'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
},
PermissionModel='SERVICE_MANAGED'|'SELF_MANAGED',
AutoDeployment={
'Enabled': True|False,
'RetainStacksOnAccountRemoval': True|False
},
OperationId='string',
Accounts=[
'string',
],
Regions=[
'string',
],
CallAs='SELF'|'DELEGATED_ADMIN',
ManagedExecution={
'Active': True|False
}
)
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's specified in your template.
ParameterValue (string) --
The input value associated with the parameter.
UsePreviousValue (boolean) --
During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
ResolvedValue (string) --
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM 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 specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
(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 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 can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
By default, 1 is specified.
MaxConcurrentPercentage (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.
ConcurrencyMode (string) --
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: Dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the FailureToleranceCount +1. StackSets will set the actual concurrency of your deployment as the minimum value between the MaxConcurrentCount and the FailureToleranceCount +1. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE: Always run at the concurrency level set by the user in the MaxConcurrentCount or MaxConcurrentPercentage, regardless of the number of failures.
string
The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.
If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
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 Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
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) --
AccountFilterType (string) --
Limit deployment targets to individual accounts or include additional accounts with provided OUs.
The following is a list of possible values for the AccountFilterType operation.
INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.
DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
NONE: Deploys to all the accounts in specified organizational units (OU).
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, don't 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 Amazon Web Services Regions in which to update stack set instances.
To update all the stack instances associated with this stack set, don't specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.
(string) --
list
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.
To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
(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.