Skip to main content

stack_sets

Creates, updates, deletes, gets or lists a stack_sets resource.

Overview​

Namestack_sets
TypeResource
Idaws.cloudformation.stack_sets

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
administration_role_arnstringThe Amazon Resource Name (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the CloudFormation User Guide.
auto_deploymentstringDescribes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). Valid only if the StackSet uses service-managed permissions.
capabilitiesstringThe capabilities that are allowed in the StackSet. Some StackSet templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.
descriptionstringA description of the StackSet that you specify when the StackSet is created or updated.
execution_role_namestringThe name of the IAM execution role used to create or update the StackSet. Use customized execution roles to control which stack resources users and groups can include in their StackSets.
managed_executionstringDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
organizational_unit_idsstring[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
parametersstringA list of input parameters for a StackSet.
permission_modelstringDescribes how the IAM roles required for StackSet 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 permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
regionsstringReturns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
stack_set_arnstringThe Amazon Resource Name (ARN) of the StackSet.
stack_set_drift_detection_detailsstringDetailed information about the drift status of the StackSet. For StackSets, contains information about the last completed drift operation performed on the StackSet. Information about drift operations currently in progress isn't included.
stack_set_idstringThe ID of the StackSet.
stack_set_namestringThe name that's associated with the StackSet.
statusstringThe status of the StackSet.
tagsstringA list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.
template_bodystringThe structure that contains the body of the template that was used to create or update the StackSet.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_stack_setselectStackSetName, regionCallAsReturns the description of the specified StackSet. This API provides strongly consistent reads meaning it will always return the most up-to-date data.
list_stack_setsselectregionNextToken, MaxResults, Status, CallAsReturns summary information about StackSets that are associated with the user. This API provides strongly consistent reads meaning it will always return the most up-to-date data. [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed StackSets in your Amazon Web Services account. [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all StackSets 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 StackSets with service-managed permissions in the management account.
create_stack_setinsertStackSetName, regionDescription, TemplateBody, TemplateURL, StackId, Parameters, Capabilities, Tags, AdministrationRoleARN, ExecutionRoleName, PermissionModel, AutoDeployment, CallAs, ClientRequestToken, ManagedExecutionCreates a StackSet.
update_stack_setupdateStackSetName, regionDescription, TemplateBody, TemplateURL, UsePreviousTemplate, Parameters, Capabilities, Tags, OperationPreferences, AdministrationRoleARN, ExecutionRoleName, DeploymentTargets, PermissionModel, AutoDeployment, OperationId, Accounts, Regions, CallAs, ManagedExecutionUpdates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions. Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent CreateStackInstances calls on the specified StackSet use the updated StackSet. The maximum number of organizational unit (OUs) supported by a UpdateStackSet operation is 50. If you need more than 50, consider the following options: Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each. Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.
delete_stack_setdeleteStackSetName, regionCallAsDeletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
detect_stack_set_driftexecStackSetName, regionOperationPreferences, OperationId, CallAsDetect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see Performing drift detection on CloudFormation StackSets. DetectStackSetDrift returns the OperationId of the StackSet 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 StackSet, in addition to the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.) Use ListStackInstances to return a list of stack instances belonging to the StackSet, 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. You can only run a single drift detection operation on a given StackSet at one time. To stop a drift detection StackSet operation, use StopStackSetOperation.
stop_stack_set_operationexecStackSetName, OperationId, regionCallAsStops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
OperationIdstringThe ID of the stack operation.
StackSetNamestringThe name or unique ID of the StackSet that you want to stop the operation for.
regionstringAWS region (default: us-east-1)
Accountsarray[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update StackSet instances. To update all the stack instances associated with this StackSet, don't specify the Accounts or Regions properties. If the StackSet update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.
AdministrationRoleARNstring[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this StackSet. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide. If you specified a customized administrator role when you created the StackSet, you must specify a customized administrator role, even if it is the same customized administrator role used with this StackSet previously.
AutoDeploymentobject[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide. If you specify AutoDeployment, don't specify DeploymentTargets or Regions.
CallAsstringSpecifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions. By default, SELF is specified. Use SELF for StackSets with self-managed permissions. If you are signed in to the management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
CapabilitiesarrayIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the StackSet and its associated stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates. CAPABILITY_AUTO_EXPAND Some templates reference macros. If your StackSet template references one or more macros, you must update the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To update the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros. StackSets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.
ClientRequestTokenstringA unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another StackSet with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
DeploymentTargetsobject[Service-managed permissions] The Organizations accounts in which to update associated stack instances. To update all the stack instances associated with this StackSet, do not specify DeploymentTargets or Regions. If the StackSet update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
DescriptionstringA brief description of updates that you are making.
ExecutionRoleNamestring[Self-managed permissions] The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet 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 StackSets. If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the StackSet, so long as you have permissions to perform operations on the StackSet.
ManagedExecutionobjectDescribes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.
MaxResultsintegerThe 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.
NextTokenstringThe token for the next set of items to return. (You received this token from a previous call.)
OperationIdstringThe ID of the StackSet operation.
OperationPreferencesobjectThe user-specified preferences for how CloudFormation performs a StackSet operation. For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
ParametersarrayA list of input parameters for the StackSet template.
PermissionModelstringDescribes how the IAM roles required for StackSet 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 permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
RegionsarrayThe Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update StackSet instances. To update all the stack instances associated with this StackSet, do not specify the Accounts or Regions properties. If the StackSet update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
StackIdstringThe stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN) of the stack.
StatusstringThe status of the StackSets that you want to get summary information about.
TagsarrayThe key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this StackSet. This means: If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this StackSet, even tags you've specified before (for example, when creating the StackSet or during a previous update of the StackSet.). Any tags that you don't include in the updated list of tags are removed from the StackSet, and therefore from the stacks and resources as well. If you specify an empty value, CloudFormation removes all currently associated tags. If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the StackSet from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the StackSet, 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 StackSet is not updated.
TemplateBodystringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
TemplateURLstringThe URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https:​//. S3 static website URLs are not supported. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
UsePreviousTemplatebooleanUse the existing template that's associated with the StackSet that you're updating. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

SELECT examples​

Returns the description of the specified StackSet. This API provides strongly consistent reads meaning it will always return the most up-to-date data.

SELECT
administration_role_arn,
auto_deployment,
capabilities,
description,
execution_role_name,
managed_execution,
organizational_unit_ids,
parameters,
permission_model,
regions,
stack_set_arn,
stack_set_drift_detection_details,
stack_set_id,
stack_set_name,
status,
tags,
template_body
FROM aws.cloudformation.stack_sets
WHERE StackSetName = '{{ StackSetName }}' -- required
AND region = '{{ region }}' -- required
AND CallAs = '{{ CallAs }}'
;

INSERT examples​

Creates a StackSet.

INSERT INTO aws.cloudformation.stack_sets (
StackSetName,
region,
Description,
TemplateBody,
TemplateURL,
StackId,
Parameters,
Capabilities,
Tags,
AdministrationRoleARN,
ExecutionRoleName,
PermissionModel,
AutoDeployment,
CallAs,
ClientRequestToken,
ManagedExecution
)
SELECT 
'{{ StackSetName }}',
'{{ region }}',
'{{ Description }}',
'{{ TemplateBody }}',
'{{ TemplateURL }}',
'{{ StackId }}',
'{{ Parameters }}',
'{{ Capabilities }}',
'{{ Tags }}',
'{{ AdministrationRoleARN }}',
'{{ ExecutionRoleName }}',
'{{ PermissionModel }}',
'{{ AutoDeployment }}',
'{{ CallAs }}',
'{{ ClientRequestToken }}',
'{{ ManagedExecution }}'
RETURNING
line_items
;

UPDATE examples​

Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions. Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent CreateStackInstances calls on the specified StackSet use the updated StackSet. The maximum number of organizational unit (OUs) supported by a UpdateStackSet operation is 50. If you need more than 50, consider the following options: Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each. Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

UPDATE aws.cloudformation.stack_sets
SET 
-- No updatable properties
WHERE 
StackSetName = '{{ StackSetName }}' --required
AND region = '{{ region }}' --required
AND Description = '{{ Description}}'
AND TemplateBody = '{{ TemplateBody}}'
AND TemplateURL = '{{ TemplateURL}}'
AND UsePreviousTemplate = {{ UsePreviousTemplate}}
AND Parameters = '{{ Parameters}}'
AND Capabilities = '{{ Capabilities}}'
AND Tags = '{{ Tags}}'
AND OperationPreferences = '{{ OperationPreferences}}'
AND AdministrationRoleARN = '{{ AdministrationRoleARN}}'
AND ExecutionRoleName = '{{ ExecutionRoleName}}'
AND DeploymentTargets = '{{ DeploymentTargets}}'
AND PermissionModel = '{{ PermissionModel}}'
AND AutoDeployment = '{{ AutoDeployment}}'
AND OperationId = '{{ OperationId}}'
AND Accounts = '{{ Accounts}}'
AND Regions = '{{ Regions}}'
AND CallAs = '{{ CallAs}}'
AND ManagedExecution = '{{ ManagedExecution}}'
RETURNING
line_items;

DELETE examples​

Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.

DELETE FROM aws.cloudformation.stack_sets
WHERE StackSetName = '{{ StackSetName }}' --required
AND region = '{{ region }}' --required
AND CallAs = '{{ CallAs }}'
;

Lifecycle Methods​

Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see Performing drift detection on CloudFormation StackSets. DetectStackSetDrift returns the OperationId of the StackSet 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 StackSet, in addition to the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.) Use ListStackInstances to return a list of stack instances belonging to the StackSet, 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. You can only run a single drift detection operation on a given StackSet at one time. To stop a drift detection StackSet operation, use StopStackSetOperation.

EXEC aws.cloudformation.stack_sets.detect_stack_set_drift 
@StackSetName='{{ StackSetName }}' --required, 
@region='{{ region }}' --required, 
@OperationPreferences='{{ OperationPreferences }}', 
@OperationId='{{ OperationId }}', 
@CallAs='{{ CallAs }}'
;
Last updated on