2021/02/18 - AWS CloudFormation - 15 updated api methods
Changes Adding the 'callAs' parameter to all CloudFormation StackSets APIs except getTemplateSummary to support creating and managing service-managed StackSets with AWS Organizations Delegated Administrators
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Creates stack instances for the specified accounts, within the specified 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',
],
'OrganizationalUnitIds': [
'string',
]
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
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 AWS 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 AWS Organizations accounts for which to create stack instances in the specified Regions.
You can specify Accounts or DeploymentTargets , but not both.
Accounts (list) --
The names of one or more AWS accounts for which you want to deploy stack set updates.
(string) --
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
(string) --
list
[REQUIRED]
The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
(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 Regions. When specifying parameters and their values, be aware of how AWS 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 a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true . (You cannot specify both a value and set UsePreviousValue to true .)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not 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, AWS 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 SSMparameter types in the template.
dict
Preferences for how AWS CloudFormation performs this stack set operation.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
string
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED .
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Creates a stack set.
See also: AWS API Documentation
Request Syntax
client.create_stack_set(
StackSetName='string',
Description='string',
TemplateBody='string',
TemplateURL='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'
)
string
[REQUIRED]
The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
Note
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
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 AWS 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 AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
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, AWS 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 SSMparameter types in the template.
list
In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS 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 AWS account; for example, by creating new AWS 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, AWS 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 AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
Note
Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
(string) --
list
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an AWS 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 (AWS) 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 AWS 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, AWS 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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
dict
Describes whether StackSets automatically deploys to AWS 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 AWS 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 AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS 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 AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
This field is autopopulated if not provided.
dict
Response Syntax
{
'StackSetId': 'string'
}
Response Structure
(dict) --
StackSetId (string) --
The ID of the stack set that you're creating.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Deletes stack instances for the specified accounts, in the specified Regions.
See also: AWS API Documentation
Request Syntax
client.delete_stack_instances(
StackSetName='string',
Accounts=[
'string',
],
DeploymentTargets={
'Accounts': [
'string',
],
'OrganizationalUnitIds': [
'string',
]
},
Regions=[
'string',
],
OperationPreferences={
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
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 AWS accounts that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets , but not both.
(string) --
dict
[Service-managed permissions] The AWS 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 AWS accounts for which you want to deploy stack set updates.
(string) --
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
(string) --
list
[REQUIRED]
The Regions where you want to delete stack set instances.
(string) --
dict
Preferences for how AWS CloudFormation performs this stack set operation.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
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 AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED .
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
See also: AWS API Documentation
Request Syntax
client.delete_stack_set(
StackSetName='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Returns the stack instance that's associated with the specified stack set, AWS account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
See also: AWS API Documentation
Request Syntax
client.describe_stack_instance(
StackSetName='string',
StackInstanceAccount='string',
StackInstanceRegion='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or the unique stack ID of the stack set that you want to get stack instance information for.
string
[REQUIRED]
The ID of an AWS account that's associated with this stack instance.
string
[REQUIRED]
The name of a Region that's associated with this stack instance.
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'StackInstance': {
'StackSetId': 'string',
'Region': 'string',
'Account': 'string',
'StackId': 'string',
'ParameterOverrides': [
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
'Status': 'CURRENT'|'OUTDATED'|'INOPERABLE',
'StackInstanceStatus': {
'DetailedStatus': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'|'INOPERABLE'
},
'StatusReason': 'string',
'OrganizationalUnitId': 'string',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
StackInstance (dict) --
The stack instance that matches the specified request parameters.
StackSetId (string) --
The name or unique ID of the stack set that the stack instance is associated with.
Region (string) --
The name of the AWS Region that the stack instance is associated with.
Account (string) --
[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
StackId (string) --
The ID of the stack instance.
ParameterOverrides (list) --
A list of parameters from the stack set template whose values have been overridden in this stack instance.
(dict) --
The Parameter data type.
ParameterKey (string) --
The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS 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 SSMparameter types in the template.
Status (string) --
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually.
OUTDATED : The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT : The stack is currently up to date with the stack set.
StackInstanceStatus (dict) --
The detailed status of the stack instance.
DetailedStatus (string) --
CANCELLED : The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED : The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually.
PENDING : The operation in the specified account and Region has yet to start.
RUNNING : The operation in the specified account and Region is currently in progress.
SUCCEEDED : The operation in the specified account and Region completed successfully.
StatusReason (string) --
The explanation for the specific status code that is assigned to this stack instance.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
DriftStatus (string) --
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
DRIFTED : The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
NOT_CHECKED : AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration.
IN_SYNC : The stack instance's actual configuration matches its expected stack set configuration.
UNKNOWN : This value is reserved for future use.
LastDriftCheckTimestamp (datetime) --
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS 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',
]
}
}
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, AWS 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 SSMparameter 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 AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
(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 AWS 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 (AWS) 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 AWS 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 : AWS 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 AWS 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 AWS 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 AWS 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) --
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Returns the description of the specified stack set 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS 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': {
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
'RetainStacks': True|False,
'AdministrationRoleARN': 'string',
'ExecutionRoleName': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'DeploymentTargets': {
'Accounts': [
'string',
],
'OrganizationalUnitIds': [
'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
}
}
}
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, as well as 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 AWS 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 AWS CloudFormation User Guide.
RUNNING : The operation is currently being performed.
STOPPED : The user has cancelled the operation.
STOPPING : The operation is in the process of stopping, at user request.
SUCCEEDED : The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
OperationPreferences (dict) --
The preferences for how AWS CloudFormation performs this stack set operation.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
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 reassociate a retained stack, or add an existing, saved stack to a new stack set.
AdministrationRoleARN (string) --
The Amazon Resource Number (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 AWS 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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
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 AWS Organizations accounts affected by the stack operation.
Accounts (list) --
The names of one or more AWS accounts for which you want to deploy stack set updates.
(string) --
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
(string) --
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 AWS 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 : AWS 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.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
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, as well as 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 is not 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 on 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={
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
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 AWS CloudFormation performs a stack set operation.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS 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.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.
See also: AWS API Documentation
Request Syntax
client.list_stack_instances(
StackSetName='string',
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'DETAILED_STATUS',
'Values': 'string'
},
],
StackInstanceAccount='string',
StackInstanceRegion='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to list stack instances for.
string
If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .
integer
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.
list
The status that stack instances are filtered by.
(dict) --
The status that stack instances are filtered by.
Name (string) --
The type of filter to apply.
Values (string) --
The status to filter by.
string
The name of the AWS account that you want to list stack instances for.
string
The name of the Region where you want to list stack instances.
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'Summaries': [
{
'StackSetId': 'string',
'Region': 'string',
'Account': 'string',
'StackId': 'string',
'Status': 'CURRENT'|'OUTDATED'|'INOPERABLE',
'StatusReason': 'string',
'StackInstanceStatus': {
'DetailedStatus': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED'|'INOPERABLE'
},
'OrganizationalUnitId': 'string',
'DriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
'LastDriftCheckTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackInstanceSummary structures that contain information about the specified stack instances.
(dict) --
The structure that contains summary information about a stack instance.
StackSetId (string) --
The name or unique ID of the stack set that the stack instance is associated with.
Region (string) --
The name of the AWS Region that the stack instance is associated with.
Account (string) --
[Self-managed permissions] The name of the AWS account that the stack instance is associated with.
StackId (string) --
The ID of the stack instance.
Status (string) --
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually.
OUTDATED : The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
CURRENT : The stack is currently up to date with the stack set.
StatusReason (string) --
The explanation for the specific status code assigned to this stack instance.
StackInstanceStatus (dict) --
The detailed status of the stack instance.
DetailedStatus (string) --
CANCELLED : The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED : The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
INOPERABLE : A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true , to delete the stack instance, and then delete the stack manually.
PENDING : The operation in the specified account and Region has yet to start.
RUNNING : The operation in the specified account and Region is currently in progress.
SUCCEEDED : The operation in the specified account and Region completed successfully.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
DriftStatus (string) --
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
DRIFTED : The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
NOT_CHECKED : AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration.
IN_SYNC : The stack instance's actual configuration matches its expected stack set configuration.
UNKNOWN : This value is reserved for future use.
LastDriftCheckTimestamp (datetime) --
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
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 .
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Returns summary information about the results of a stack set operation.
See also: AWS API Documentation
Request Syntax
client.list_stack_set_operation_results(
StackSetName='string',
OperationId='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 results for.
string
[REQUIRED]
The ID of the stack set operation.
string
If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .
integer
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'Summaries': [
{
'Account': 'string',
'Region': 'string',
'Status': 'PENDING'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLED',
'StatusReason': 'string',
'AccountGateResult': {
'Status': 'SUCCEEDED'|'FAILED'|'SKIPPED',
'StatusReason': 'string'
},
'OrganizationalUnitId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Regions that are included in the operation.
(dict) --
The structure that contains information about a specified operation's results for a given account in a given Region.
Account (string) --
[Self-managed permissions] The name of the AWS account for this operation result.
Region (string) --
The name of the AWS Region for this operation result.
Status (string) --
The result status of the stack set operation for the given account in the given Region.
CANCELLED : The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.
FAILED : The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
RUNNING : The operation in the specified account and Region is currently in progress.
PENDING : The operation in the specified account and Region has yet to start.
SUCCEEDED : The operation in the specified account and Region completed successfully.
StatusReason (string) --
The reason for the assigned result status.
AccountGateResult (dict) --
The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
Status (string) --
The status of the account gate function.
SUCCEEDED : The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and Region.
FAILED : The account gate function has determined that the account and Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED .
SKIPPED : AWS CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:
An account gate function has not been specified for the account and Region. AWS CloudFormation proceeds with the stack set operation in this account and Region.
The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and Region.
Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and Region.
StatusReason (string) --
The reason for the account gate status assigned to this account and Region for the stack set operation.
OrganizationalUnitId (string) --
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
NextToken (string) --
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null .
{'CallAs': 'SELF | DELEGATED_ADMIN'}
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS 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)
},
],
'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 as well as 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 AWS 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 AWS CloudFormation User Guide.
RUNNING : The operation is currently being performed.
STOPPED : The user has cancelled the operation.
STOPPING : The operation is in the process of stopping, at user request.
SUCCEEDED : The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
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.
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 .
{'CallAs': 'SELF | DELEGATED_ADMIN'}
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 AWS account, ListStackSets returns all self-managed stack sets in your AWS 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS 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)
},
],
'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 AWS Organizations accounts that are added to a target organizational unit (OU).
Enabled (boolean) --
If set to true , StackSets automatically deploys additional stack instances to AWS 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 AWS 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 : AWS 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.
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 .
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Stops an in-progress operation on a stack set and its associated stack instances.
See also: AWS API Documentation
Request Syntax
client.stop_stack_set_operation(
StackSetName='string',
OperationId='string',
CallAs='SELF'|'DELEGATED_ADMIN'
)
string
[REQUIRED]
The name or unique ID of the stack set that you want to stop the operation for.
string
[REQUIRED]
The ID of the stack 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
{'CallAs': 'SELF | DELEGATED_ADMIN'}
Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in 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 are not 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',
],
'OrganizationalUnitIds': [
'string',
]
},
Regions=[
'string',
],
ParameterOverrides=[
{
'ParameterKey': 'string',
'ParameterValue': 'string',
'UsePreviousValue': True|False,
'ResolvedValue': 'string'
},
],
OperationPreferences={
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
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 AWS 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 Regions.
You can specify Accounts or DeploymentTargets , but not both.
(string) --
dict
[Service-managed permissions] The AWS 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 AWS accounts for which you want to deploy stack set updates.
(string) --
OrganizationalUnitIds (list) --
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
(string) --
list
[REQUIRED]
The names of one or more 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 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 Regions. When specifying parameters and their values, be aware of how AWS 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 a parameter set to its present value, you can do one of the following:
Do not include the parameter in the list.
Include the parameter and specify UsePreviousValue as true . (You cannot specify both a value and set UsePreviousValue to true .)
To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.
To leave all parameters set to their present values, do not specify this property at all.
During stack set updates, any parameter values overridden for a stack instance are not 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, AWS 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 SSMparameter types in the template.
dict
Preferences for how AWS CloudFormation performs this stack set operation.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
string
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique identifier for this stack set operation.
{'CallAs': 'SELF | DELEGATED_ADMIN'}
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={
'RegionOrder': [
'string',
],
'FailureToleranceCount': 123,
'FailureTolerancePercentage': 123,
'MaxConcurrentCount': 123,
'MaxConcurrentPercentage': 123
},
AdministrationRoleARN='string',
ExecutionRoleName='string',
DeploymentTargets={
'Accounts': [
'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'
)
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 AWS 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 AWS 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, AWS 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 SSMparameter types in the template.
list
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS 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 AWS account; for example, by creating new AWS 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, AWS 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 AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
Warning
Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
(string) --
list
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
(dict) --
The Tag type enables you to specify a key-value pair that can be used to store information about an AWS 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 (AWS) 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 AWS CloudFormation performs this stack set operation.
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 AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
FailureTolerancePercentage (integer) --
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage , but not both.
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.
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, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
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.
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 AWS 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, AWS 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, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS 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 AWS 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 , AWS 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, AWS 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 AWS accounts for which you want to deploy stack set updates.
(string) --
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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
dict
[Service-managed permissions] Describes whether StackSets automatically deploys to AWS 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 AWS 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 AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, AWS CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED .
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, AWS 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, AWS 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, AWS 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, AWS 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The unique ID for this stack set operation.