Skip to content
AWS for Query.Farm

aws.cloudformation.describe_stack_set

Example SQL Queries

SELECT * FROM
aws.cloudformation.describe_stack_set
WHERE
"stack_set_name" = 'VALUE';

Description

Returns the description of the specified StackSet.

Table Definition

Column NameColumn Data Type
stack_set_name Required Input Column

The name or unique ID of the stack set whose description you want.

VARCHAR
call_as Input Column

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
stack_set

The specified stack set.

STRUCT(
    "stack_set_name" VARCHAR,
    "stack_set_id" VARCHAR,
    "description" VARCHAR,
    "status" VARCHAR,
    "template_body" VARCHAR,
    "parameters" STRUCT(
        "parameter_key" VARCHAR,
        "parameter_value" VARCHAR,
        "use_previous_value" BOOLEAN,
        "resolved_value" VARCHAR
    )[],
    "capabilities" VARCHAR[],
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "stack_set_arn" VARCHAR,
    "administration_role_arn" VARCHAR,
    "execution_role_name" VARCHAR,
    "stack_set_drift_detection_details" STRUCT(
        "drift_status" VARCHAR,
        "drift_detection_status" VARCHAR,
        "last_drift_check_timestamp" TIMESTAMP_S,
        "total_stack_instances_count" BIGINT,
        "drifted_stack_instances_count" BIGINT,
        "in_sync_stack_instances_count" BIGINT,
        "in_progress_stack_instances_count" BIGINT,
        "failed_stack_instances_count" BIGINT
    ),
    "auto_deployment" STRUCT(
        "enabled" BOOLEAN,
        "retain_stacks_on_account_removal" BOOLEAN
    ),
    "permission_model" VARCHAR,
    "organizational_unit_ids" VARCHAR[],
    "managed_execution" STRUCT(
        "active" BOOLEAN
    ),
    "regions" VARCHAR[]
)
Show child fields
stack_set.administration_role_arn

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.

stack_set.auto_deployment

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

Show child fields
stack_set.auto_deployment.enabled

If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

stack_set.auto_deployment.retain_stacks_on_account_removal

If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

stack_set.capabilities[]
stack_set.description

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

stack_set.execution_role_name

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.

stack_set.managed_execution

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

Show child fields
stack_set.managed_execution.active

When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

When false (default), StackSets performs one operation at a time in request order.

stack_set.organizational_unit_ids[]
stack_set.parameters[]
Show child fields
stack_set.parameters[].parameter_key

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

stack_set.parameters[].parameter_value

The input value associated with the parameter.

stack_set.parameters[].resolved_value

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.

stack_set.parameters[].use_previous_value

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

stack_set.permission_model

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

stack_set.regions[]
stack_set.stack_set_arn

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

stack_set.stack_set_drift_detection_details

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.

Show child fields
stack_set.stack_set_drift_detection_details.drift_detection_status

The status of the stack set drift detection operation.

  • COMPLETED: The drift detection operation completed without failing on any stack instances.

  • FAILED: The drift detection operation exceeded the specified failure tolerance.

  • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.

  • IN_PROGRESS: The drift detection operation is currently being performed.

  • STOPPED: The user has canceled the drift detection operation.

stack_set.stack_set_drift_detection_details.drift_status

Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.

  • DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.

  • IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.

stack_set.stack_set_drift_detection_details.drifted_stack_instances_count

The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

stack_set.stack_set_drift_detection_details.failed_stack_instances_count

The number of stack instances for which the drift detection operation failed.

stack_set.stack_set_drift_detection_details.in_progress_stack_instances_count

The number of stack instances that are currently being checked for drift.

stack_set.stack_set_drift_detection_details.in_sync_stack_instances_count

The number of stack instances which match the expected template and parameter configuration of the stack set.

stack_set.stack_set_drift_detection_details.last_drift_check_timestamp

Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection hasn't yet been performed.

stack_set.stack_set_drift_detection_details.total_stack_instances_count

The total number of stack instances belonging to this stack set.

The total number of stack instances is equal to the total of:

  • Stack instances that match the stack set configuration.

  • Stack instances that have drifted from the stack set configuration.

  • Stack instances where the drift detection operation has failed.

  • Stack instances currently being checked for drift.

stack_set.stack_set_id

The ID of the stack set.

stack_set.stack_set_name

The name that's associated with the stack set.

stack_set.status

The status of the stack set.

stack_set.tags[]
Show child fields
stack_set.tags[].key

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

stack_set.tags[].value

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

stack_set.template_body

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