change_set_hooks

Creates, updates, deletes, gets or lists a change_set_hooks resource.

Overview

Name	change_set_hooks
Type	Resource
Id	aws.cloudformation.change_set_hooks

Fields

The following fields are returned by SELECT queries:

describe_change_set_hooks

Name	Datatype	Description
failure_mode	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.
invocation_point	string	The specific point in the provisioning process where the Hook is invoked.
target_details	string	Specifies details about the target that the Hook will run against.
type_configuration_version_id	string	The version ID of the type configuration.
type_name	string	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
type_version_id	string	The version ID of the type specified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_change_set_hooks	select	ChangeSetName, region	StackName, NextToken, LogicalResourceId	Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ChangeSetName	string	The name or Amazon Resource Name (ARN) of the change set that you want to describe.
region	string	AWS region (default: us-east-1)
LogicalResourceId	string	If specified, lists only the Hooks related to the specified LogicalResourceId.
NextToken	string	The token for the next set of items to return. (You received this token from a previous call.)
StackName	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.

SELECT examples

describe_change_set_hooks

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

SELECT
failure_mode,
invocation_point,
target_details,
type_configuration_version_id,
type_name,
type_version_id
FROM aws.cloudformation.change_set_hooks
WHERE ChangeSetName = '{{ ChangeSetName }}' -- required
AND region = '{{ region }}' -- required
AND StackName = '{{ StackName }}'
AND NextToken = '{{ NextToken }}'
AND LogicalResourceId = '{{ LogicalResourceId }}'
;