[ aws . cloudformation ]

describe-change-set-hooks

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-change-set-hooks
--change-set-name <value>
[--stack-name <value>]
[--next-token <value>]
[--logical-resource-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--change-set-name (string)

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

--stack-name (string)

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

--next-token (string)

A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.

--logical-resource-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

ChangeSetId -> (string)

The change set identifier (stack ID).

ChangeSetName -> (string)

The change set name.

Hooks -> (list)

List of hook objects.

(structure)

Specifies the resource, the hook, and the hook version to be invoked.

InvocationPoint -> (string)

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

FailureMode -> (string)

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.

TypeName -> (string)

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

Note

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

• Alexa

• AMZN

• Amazon

• ASK

• AWS

• Custom

• Dev

TypeVersionId -> (string)

The version ID of the type specified.

TypeConfigurationVersionId -> (string)

The version ID of the type configuration.

TargetDetails -> (structure)

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

TargetType -> (string)

The name of the type.

ResourceTargetDetails -> (structure)

Required if TargetType is RESOURCE .

LogicalResourceId -> (string)

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

ResourceType -> (string)

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

ResourceAction -> (string)

Specifies the action of the resource.

Status -> (string)

Provides the status of the change set hook.

NextToken -> (string)

Pagination token, null or empty if no more results.

StackId -> (string)

The stack identifier (stack ID).

StackName -> (string)

The stack name.