StackSet¶
Structure Class¶
StackSet
dataclass
¶
Bases: _SerdeShape
A structure that contains information about a StackSet. With StackSets, you can provision stacks across Amazon Web Services accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.
Attributes¶
administration_role_arn
class-attribute
instance-attribute
¶
administration_role_arn: str | None = ...
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 StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the CloudFormation User Guide.
auto_deployment
class-attribute
instance-attribute
¶
auto_deployment: AutoDeployment | None = ...
Describes 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.
capabilities
class-attribute
instance-attribute
¶
The 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.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description of the StackSet that you specify when the StackSet is created or updated.
execution_role_name
class-attribute
instance-attribute
¶
execution_role_name: str | None = ...
The 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_execution
class-attribute
instance-attribute
¶
managed_execution: ManagedExecution | None = ...
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
organizational_unit_ids
class-attribute
instance-attribute
¶
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
parameters
class-attribute
instance-attribute
¶
A list of input parameters for a StackSet.
permission_model
class-attribute
instance-attribute
¶
permission_model: str | None = ...
Describes how the IAM roles required for StackSet 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 permissions. -
With
service-managedpermissions, 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.
regions
class-attribute
instance-attribute
¶
Returns 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_arn
class-attribute
instance-attribute
¶
stack_set_arn: str | None = ...
The Amazon Resource Name (ARN) of the StackSet.
stack_set_drift_detection_details
class-attribute
instance-attribute
¶
stack_set_drift_detection_details: StackSetDriftDetectionDetails | None = ...
Detailed 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_id
class-attribute
instance-attribute
¶
stack_set_id: str | None = ...
The ID of the StackSet.
stack_set_name
class-attribute
instance-attribute
¶
stack_set_name: str | None = ...
The name that's associated with the StackSet.
tags
class-attribute
instance-attribute
¶
A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.