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

Inherits:
Struct
  • Object
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, as well as any parameters and capabilities that the template requires.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#administration_role_arnString

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 CloudFormation User Guide.

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deploymentTypes::AutoDeployment

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



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#capabilitiesArray<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>)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_nameString

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)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#managed_executionTypes::ManagedExecution

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



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#organizational_unit_idsArray<String>

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

Returns:

  • (Array<String>)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::Parameter>

A list of input parameters for a stack set.

Returns:



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#permission_modelString

Describes how the IAM roles required for stack set operations are created.

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_arnString

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

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

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



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_idString

The ID of the stack set.

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#stack_set_nameString

The name that's associated with the stack set.

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the stack set.

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end

#template_bodyString

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

Returns:

  • (String)


7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 7938

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)
  SENSITIVE = []
  include Aws::Structure
end