You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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.

Returned by:

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

Returns:

  • (String)

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

#auto_deploymentTypes::AutoDeployment

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

Returns:

  • (Types::AutoDeployment)

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

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

Returns:

  • (Array<String>)

    The capabilities that are allowed in the stack set.

#descriptionString

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

Returns:

  • (String)

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

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

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

#organizational_unit_idsArray<String>

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

Returns:

  • (Array<String>)

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

#parametersArray<Types::Parameter>

A list of input parameters for a stack set.

Returns:

#permission_modelString

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

Returns:

  • (String)

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

#stack_set_arnString

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

Returns:

  • (String)

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

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

Returns:

#stack_set_idString

The ID of the stack set.

Returns:

  • (String)

    The ID of the stack set.

#stack_set_nameString

The name that\'s associated with the stack set.

Returns:

  • (String)

    The name that\'s associated with the stack set.

#statusString

The status of the stack set.

Possible values:

  • ACTIVE
  • DELETED

Returns:

  • (String)

    The status of the stack set.

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

    A list of tags that specify information about the stack set.

#template_bodyString

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

Returns:

  • (String)

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