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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-cloudformation/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 Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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
[Service-managed permissions] 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 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.
#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 stack set.
#permission_model ⇒ String
Describes how the IAM roles required for stack set 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 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 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 stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

Returns:

(String)

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

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`

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

Returns:

(Types::AutoDeployment)

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

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 stack set. Some stack set 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 8922

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 stack set that you specify when the stack set is created or updated.

Returns:

(String)

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

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 stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

Returns:

(String)

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

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 8922

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 8922

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 stack set.

Returns:

(Array<Types::Parameter>)

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

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 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 Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

Returns:

(String)

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

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 8922

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 stack set.

Returns:

(String)

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

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 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 isn't included.

Returns:

(Types::StackSetDriftDetectionDetails)

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

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 stack set.

Returns:

(String)

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

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 stack set.

Returns:

(String)

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

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 stack set.

Returns:

(String)

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

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 stack set. 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 8922

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 stack set.

Returns:

(String)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#administration_role_arn ⇒ String

#auto_deployment ⇒ Types::AutoDeployment

#capabilities ⇒ Array<String>

#description ⇒ String

#execution_role_name ⇒ String

#managed_execution ⇒ Types::ManagedExecution

#organizational_unit_ids ⇒ Array<String>

#parameters ⇒ Array<Types::Parameter>

#permission_model ⇒ String

#regions ⇒ Array<String>

#stack_set_arn ⇒ String

#stack_set_drift_detection_details ⇒ Types::StackSetDriftDetectionDetails

#stack_set_id ⇒ String

#stack_set_name ⇒ String

#status ⇒ String

#tags ⇒ Array<Types::Tag>

#template_body ⇒ String

#administration_role_arn ⇒ `String`

#auto_deployment ⇒ `Types::AutoDeployment`

#capabilities ⇒ `Array<String>`

#description ⇒ `String`

#execution_role_name ⇒ `String`

#managed_execution ⇒ `Types::ManagedExecution`

#organizational_unit_ids ⇒ `Array<String>`

#parameters ⇒ `Array<Types::Parameter>`

#permission_model ⇒ `String`

#regions ⇒ `Array<String>`

#stack_set_arn ⇒ `String`

#stack_set_drift_detection_details ⇒ `Types::StackSetDriftDetectionDetails`

#stack_set_id ⇒ `String`

#stack_set_name ⇒ `String`

#status ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#template_body ⇒ `String`