class Amazonite::CloudFormation::StackSet

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.cr

Constructors

Instance Method Summary

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]
def 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) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def administration_role_arn : String | Nil #

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.


[View source]
def 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.

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.


[View source]
def auto_deployment : AutoDeployment | Nil #

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.


[View source]
def 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). Valid only if the StackSet uses service-managed permissions.


[View source]
def capabilities : Array(Capability) | Nil #

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.


[View source]
def capabilities=(capabilities : Array(Capability) | Nil) #

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.


[View source]
def description : String | Nil #

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


[View source]
def description=(description : String | Nil) #

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


[View source]
def execution_role_name : String | Nil #

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.


[View source]
def execution_role_name=(execution_role_name : String | Nil) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def managed_execution : ManagedExecution | Nil #

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


[View source]
def managed_execution=(managed_execution : ManagedExecution | Nil) #

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


[View source]
def organizational_unit_ids : Array(String) | Nil #

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.


[View source]
def 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.


[View source]
def parameters : Array(Parameter) | Nil #

A list of input parameters for a StackSet.


[View source]
def parameters=(parameters : Array(Parameter) | Nil) #

A list of input parameters for a StackSet.


[View source]
def permission_model : PermissionModels | Nil #

Describes how the IAM roles required for StackSet operations are created.


[View source]
def permission_model=(permission_model : PermissionModels | Nil) #

Describes how the IAM roles required for StackSet operations are created.


[View source]
def regions : Array(String) | Nil #

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.


[View source]
def regions=(regions : Array(String) | Nil) #

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.


[View source]
def stack_set_arn : String | Nil #

The Amazon Resource Name (ARN) of the StackSet.


[View source]
def stack_set_arn=(stack_set_arn : String | Nil) #

The Amazon Resource Name (ARN) of the StackSet.


[View source]
def stack_set_drift_detection_details : StackSetDriftDetectionDetails | Nil #

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.


[View source]
def stack_set_drift_detection_details=(stack_set_drift_detection_details : StackSetDriftDetectionDetails | Nil) #

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.


[View source]
def stack_set_id : String | Nil #

The ID of the StackSet.


[View source]
def stack_set_id=(stack_set_id : String | Nil) #

The ID of the StackSet.


[View source]
def stack_set_name : String | Nil #

The name that's associated with the StackSet.


[View source]
def stack_set_name=(stack_set_name : String | Nil) #

The name that's associated with the StackSet.


[View source]
def status : StackSetStatus | Nil #

The status of the StackSet.


[View source]
def status=(status : StackSetStatus | Nil) #

The status of the StackSet.


[View source]
def tags : Array(Tag) | Nil #

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


[View source]
def tags=(tags : Array(Tag) | Nil) #

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


[View source]
def template_body : String | Nil #

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


[View source]
def template_body=(template_body : String | Nil) #

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


[View source]
def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]
def validate! : Nil #

[View source]