You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::StackSet
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::StackSet
- Defined in:
- (unknown)
Overview
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, as well as any parameters and capabilities that the template requires.
Returned by:
Instance Attribute Summary collapse
-
#administration_role_arn ⇒ String
The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
-
#auto_deployment ⇒ Types::AutoDeployment
[
Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). -
#capabilities ⇒ Array<String>
The capabilities that are allowed in the stack set.
-
#description ⇒ String
A description of the stack set that you specify when the stack set is created or updated.
-
#execution_role_name ⇒ String
The name of the IAM execution role used to create or update the stack set.
-
#organizational_unit_ids ⇒ Array<String>
[
Service-managed
permissions] The organization root ID or organizational unit (OU) IDs that you specified for [DeploymentTargets][1]. -
#parameters ⇒ Array<Types::Parameter>
A list of input parameters for a stack set.
-
#permission_model ⇒ String
Describes how the IAM roles required for stack set operations are created.
-
#stack_set_arn ⇒ String
The Amazon Resource Number (ARN) of the stack set.
-
#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails
Detailed information about the drift status of the stack set.
-
#stack_set_id ⇒ String
The ID of the stack set.
-
#stack_set_name ⇒ String
The name that\'s associated with the stack set.
-
#status ⇒ String
The status of the stack set.
-
#tags ⇒ Array<Types::Tag>
A list of tags that specify information about the stack set.
-
#template_body ⇒ String
The structure that contains the body of the template that was used to create or update the stack set.
Instance Attribute Details
#administration_role_arn ⇒ 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.
#auto_deployment ⇒ Types::AutoDeployment
[Service-managed
permissions] Describes whether StackSets
automatically deploys to AWS Organizations accounts that are added to a
target organization or organizational unit (OU).
#capabilities ⇒ Array<String>
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.
#description ⇒ String
A description of the stack set that you specify when the stack set is created or updated.
#execution_role_name ⇒ 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.
#organizational_unit_ids ⇒ Array<String>
[Service-managed
permissions] The organization root ID or
organizational unit (OU) IDs that you specified for
DeploymentTargets.
#parameters ⇒ Array<Types::Parameter>
A list of input parameters for a stack set.
#permission_model ⇒ 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.
#stack_set_arn ⇒ String
The Amazon Resource Number (ARN) of the stack set.
#stack_set_drift_detection_details ⇒ Types::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 is not included.
#stack_set_id ⇒ String
The ID of the stack set.
#stack_set_name ⇒ String
The name that\'s associated with the stack set.
#status ⇒ String
The status of the stack set.
Possible values:
- ACTIVE
- DELETED
#tags ⇒ Array<Types::Tag>
A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
#template_body ⇒ String
The structure that contains the body of the template that was used to create or update the stack set.