class
Amazonite::CloudFormation::StackSet
- Amazonite::CloudFormation::StackSet
- Reference
- Object
Overview
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.
Defined in:
cloudformation/stack_set.crConstructors
- .from_xml(node : XML::Node) : self
- .new(stack_set_name : String | Nil = nil, stack_set_id : String | Nil = nil, description : String | Nil = nil, status : StackSetStatus | Nil = nil, template_body : String | Nil = nil, parameters : Array(Parameter) | Nil = nil, capabilities : Array(Capability) | Nil = nil, tags : Array(Tag) | Nil = nil, stack_set_arn : String | Nil = nil, administration_role_arn : String | Nil = nil, execution_role_name : String | Nil = nil, stack_set_drift_detection_details : StackSetDriftDetectionDetails | Nil = nil, auto_deployment : AutoDeployment | Nil = nil, permission_model : PermissionModels | Nil = nil, organizational_unit_ids : Array(String) | Nil = nil, managed_execution : ManagedExecution | Nil = nil, regions : Array(String) | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#administration_role_arn : String | Nil
The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
-
#administration_role_arn=(administration_role_arn : String | Nil)
The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
-
#auto_deployment : AutoDeployment | Nil
Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
-
#auto_deployment=(auto_deployment : AutoDeployment | Nil)
Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
-
#capabilities : Array(Capability) | Nil
The capabilities that are allowed in the StackSet.
-
#capabilities=(capabilities : Array(Capability) | Nil)
The capabilities that are allowed in the StackSet.
-
#description : String | Nil
A description of the StackSet that you specify when the StackSet is created or updated.
-
#description=(description : String | Nil)
A description of the StackSet that you specify when the StackSet is created or updated.
-
#execution_role_name : String | Nil
The name of the IAM execution role used to create or update the StackSet.
-
#execution_role_name=(execution_role_name : String | Nil)
The name of the IAM execution role used to create or update the StackSet.
-
#hash(hasher)
See
Object#hash(hasher) -
#managed_execution : ManagedExecution | Nil
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
-
#managed_execution=(managed_execution : ManagedExecution | Nil)
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
-
#organizational_unit_ids : Array(String) | Nil
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
-
#organizational_unit_ids=(organizational_unit_ids : Array(String) | Nil)
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
-
#parameters : Array(Parameter) | Nil
A list of input parameters for a StackSet.
-
#parameters=(parameters : Array(Parameter) | Nil)
A list of input parameters for a StackSet.
-
#permission_model : PermissionModels | Nil
Describes how the IAM roles required for StackSet operations are created.
-
#permission_model=(permission_model : PermissionModels | Nil)
Describes how the IAM roles required for StackSet operations are created.
-
#regions : Array(String) | Nil
Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in.
-
#regions=(regions : Array(String) | Nil)
Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in.
-
#stack_set_arn : String | Nil
The Amazon Resource Name (ARN) of the StackSet.
-
#stack_set_arn=(stack_set_arn : String | Nil)
The Amazon Resource Name (ARN) of the StackSet.
-
#stack_set_drift_detection_details : StackSetDriftDetectionDetails | Nil
Detailed information about the drift status of the StackSet.
-
#stack_set_drift_detection_details=(stack_set_drift_detection_details : StackSetDriftDetectionDetails | Nil)
Detailed information about the drift status of the StackSet.
-
#stack_set_id : String | Nil
The ID of the StackSet.
-
#stack_set_id=(stack_set_id : String | Nil)
The ID of the StackSet.
-
#stack_set_name : String | Nil
The name that's associated with the StackSet.
-
#stack_set_name=(stack_set_name : String | Nil)
The name that's associated with the StackSet.
-
#status : StackSetStatus | Nil
The status of the StackSet.
-
#status=(status : StackSetStatus | Nil)
The status of the StackSet.
-
#tags : Array(Tag) | Nil
A list of tags that specify information about the StackSet.
-
#tags=(tags : Array(Tag) | Nil)
A list of tags that specify information about the StackSet.
-
#template_body : String | Nil
The structure that contains the body of the template that was used to create or update the StackSet.
-
#template_body=(template_body : String | Nil)
The structure that contains the body of the template that was used to create or update the StackSet.
- #to_query_params(prefix : String) : Array(Tuple(String, String))
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.
A description of the StackSet that you specify when the StackSet is created or updated.
A description of the StackSet that you specify when the StackSet is created or updated.
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.
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.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
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.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
A list of input parameters for a StackSet.
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.
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.
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.
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.
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.
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.
A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.
A list of tags that specify information about the StackSet. 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 StackSet.
The structure that contains the body of the template that was used to create or update the StackSet.