StackSet
A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS 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.
Contents
- 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 AWS CloudFormation User Guide.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
- AutoDeployment
-
[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
Type: AutoDeployment object
Required: No
- Capabilities.member.N
-
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.
Type: Array of strings
Valid Values:
CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPANDRequired: No
- Description
-
A description of the stack set that you specify when the stack set is created or updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z_0-9+=,.@-]+Required: No
- ManagedExecution
-
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Type: ManagedExecution object
Required: No
- OrganizationalUnitIds.member.N
-
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
Type: Array of strings
Pattern:
^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$Required: No
- Parameters.member.N
-
A list of input parameters for a stack set.
Type: Array of Parameter objects
Required: No
- PermissionModel
-
Describes how the IAM roles required for stack set operations are created.
-
With
self-managedpermissions, 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-managedpermissions, 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.
Type: String
Valid Values:
SERVICE_MANAGED | SELF_MANAGEDRequired: No
-
- Regions.member.N
-
Returns a list of all AWS Regions the given StackSet has stack instances deployed in. The AWS Regions list output is in no particular order.
Type: Array of strings
Pattern:
^[a-zA-Z0-9-]{1,128}$Required: No
- StackSetARN
-
The Amazon Resource Name (ARN) of the stack set.
Type: String
Required: No
- 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.
Type: StackSetDriftDetectionDetails object
Required: No
- StackSetId
-
The ID of the stack set.
Type: String
Required: No
- StackSetName
-
The name that's associated with the stack set.
Type: String
Required: No
- Status
-
The status of the stack set.
Type: String
Valid Values:
ACTIVE | DELETEDRequired: No
- Tags.member.N
-
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
Type: Array of Tag objects
Array Members: Maximum number of 50 items.
Required: No
- TemplateBody
-
The structure that contains the body of the template that was used to create or update the stack set.
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
