Class: Aws::CloudFormation::Types::StackSet

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::StackSet

Includes:

Structure

Defined in:

lib/aws-sdk-cloudformation/types.rb

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #administration_role_arn ⇒ String

  The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.

• #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.

• #parameters ⇒ Array<Types::Parameter>

  A list of input parameters for a stack set.

• #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*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#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.][1

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#parameters ⇒ Array<Types::Parameter>

A list of input parameters for a stack set.

Returns:

• (Array<Types::Parameter>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#stack_set_arn ⇒ String

The Amazon Resource Number (ARN) of the stack set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

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

Returns:

• (Types::StackSetDriftDetectionDetails)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#stack_set_id ⇒ String

The ID of the stack set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#stack_set_name ⇒ String

The name that’s associated with the stack set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#status ⇒ String

The status of the stack set.

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end

#template_body ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 5867

class StackSet < Struct.new(
  :stack_set_name,
  :stack_set_id,
  :description,
  :status,
  :template_body,
  :parameters,
  :capabilities,
  :tags,
  :stack_set_arn,
  :administration_role_arn,
  :execution_role_name,
  :stack_set_drift_detection_details)
  include Aws::Structure
end