Documentation

A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

See: newStackSet smart constructor.

Create a value of StackSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:administrationRoleARN:StackSet', stackSet_administrationRoleARN - The 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 stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

$sel:autoDeployment:StackSet', stackSet_autoDeployment - [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

$sel:capabilities:StackSet', stackSet_capabilities - The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

$sel:description:StackSet', stackSet_description - A description of the stack set that you specify when the stack set is created or updated.

$sel:executionRoleName:StackSet', stackSet_executionRoleName - 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.

$sel:managedExecution:StackSet', stackSet_managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

$sel:organizationalUnitIds:StackSet', stackSet_organizationalUnitIds - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

$sel:parameters:StackSet', stackSet_parameters - A list of input parameters for a stack set.

$sel:permissionModel:StackSet', stackSet_permissionModel - Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

$sel:stackSetARN:StackSet', stackSet_stackSetARN - The Amazon Resource Name (ARN) of the stack set.

$sel:stackSetDriftDetectionDetails:StackSet', stackSet_stackSetDriftDetectionDetails - 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 isn't included.

$sel:stackSetId:StackSet', stackSet_stackSetId - The ID of the stack set.

$sel:stackSetName:StackSet', stackSet_stackSetName - The name that's associated with the stack set.

$sel:status:StackSet', stackSet_status - The status of the stack set.

$sel:tags:StackSet', stackSet_tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

$sel:templateBody:StackSet', stackSet_templateBody - The structure that contains the body of the template that was used to create or update the stack set.

The 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 stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

Service-managed permissions

Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

A description of the stack set that you specify when the stack set is created or updated.

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.

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Service-managed permissions

The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

A list of input parameters for a stack set.

Describes how the IAM roles required for stack set operations are created.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

The Amazon Resource Name (ARN) of the stack set.

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 isn't included.

The ID of the stack set.

The name that's associated with the stack set.

The status of the stack set.

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

The structure that contains the body of the template that was used to create or update the stack set.