Skip to content
AWS for Query.Farm

aws.cloudformation.describe_change_set_hooks

Example SQL Queries

SELECT * FROM
aws.cloudformation.describe_change_set_hooks
WHERE
"change_set_name" = 'VALUE';

Description

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Table Definition

Column NameColumn Data Type
change_set_name Required Input Column

The change set name.

VARCHAR
logical_resource_id Input Column

If specified, lists only the hooks related to the specified LogicalResourceId.

VARCHAR
next_token Input Column

Pagination token, null or empty if no more results.

VARCHAR
stack_name Input Column

The stack name.

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
change_set_id

The change set identifier (stack ID).

VARCHAR
hooks

List of hook objects.

STRUCT(
    "invocation_point" VARCHAR,
    "failure_mode" VARCHAR,
    "type_name" VARCHAR,
    "type_version_id" VARCHAR,
    "type_configuration_version_id" VARCHAR,
    "target_details" STRUCT(
        "target_type" VARCHAR,
        "resource_target_details" STRUCT(
            "logical_resource_id" VARCHAR,
            "resource_type" VARCHAR,
            "resource_action" VARCHAR
        )
    )
)[]
Show child fields
hooks[]
Show child fields
hooks[].failure_mode

Specify the hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

hooks[].invocation_point

Specifies the points in provisioning logic where a hook is invoked.

hooks[].target_details

Specifies details about the target that the hook will run against.

Show child fields
hooks[].target_details.resource_target_details

Required if TargetType is RESOURCE.

Show child fields
hooks[].target_details.resource_target_details.logical_resource_id

The resource's logical ID, which is defined in the stack's template.

hooks[].target_details.resource_target_details.resource_action

Specifies the action of the resource.

hooks[].target_details.resource_target_details.resource_type

The type of CloudFormation resource, such as AWS::S3::Bucket.

hooks[].target_details.target_type

The name of the type.

hooks[].type_configuration_version_id

The version ID of the type configuration.

hooks[].type_name

The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

hooks[].type_version_id

The version ID of the type specified.

stack_id

The stack identifier (stack ID).

VARCHAR
status

Provides the status of the change set hook.

VARCHAR