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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #administration_role_arn ⇒ String

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

• #auto_deployment ⇒ Types::AutoDeployment

  Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

• #capabilities ⇒ Array<String>

  The capabilities that are allowed in the StackSet.

• #description ⇒ String

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

• #execution_role_name ⇒ String

  The name of the IAM execution role used to create or update the StackSet.

• #managed_execution ⇒ Types::ManagedExecution

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

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

• #permission_model ⇒ String

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

• #regions ⇒ Array<String>

  Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in.

• #stack_set_arn ⇒ String

  The Amazon Resource Name (ARN) of the StackSet.

• #stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails

  Detailed information about the drift status of the StackSet.

• #stack_set_id ⇒ String

  The ID of the StackSet.

• #stack_set_name ⇒ String

  The name that's associated with the StackSet.

• #status ⇒ String

  The status of the StackSet.

• #tags ⇒ Array<Types::Tag>

  A list of tags that specify information about the StackSet.

• #template_body ⇒ String

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

Instance Attribute Details

#administration_role_arn ⇒ String

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.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deployment ⇒ Types::AutoDeployment

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.

Returns:

• (Types::AutoDeployment)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#capabilities ⇒ Array<String>

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.

Returns:

• (Array<String>)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_name ⇒ String

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.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#managed_execution ⇒ Types::ManagedExecution

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

Returns:

• (Types::ManagedExecution)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::Parameter>

A list of input parameters for a StackSet.

Returns:

• (Array<Types::Parameter>)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#permission_model ⇒ String

Describes how the IAM roles required for StackSet 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 permissions.

• With service-managed permissions, 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:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

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:

• (Array<String>)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_arn ⇒ String

The Amazon Resource Name (ARN) of the StackSet.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails

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.

Returns:

• (Types::StackSetDriftDetectionDetails)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_id ⇒ String

The ID of the StackSet.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_name ⇒ String

The name that's associated with the StackSet.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the StackSet.

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ String

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

Returns:

• (String)

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

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,
  :auto_deployment,
  :permission_model,
  :organizational_unit_ids,
  :managed_execution,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end