ChangeSetHook - Amazon CloudFormation
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ChangeSetHook

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

Contents

FailureMode

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.

Type: String

Valid Values: FAIL | WARN

Required: No

InvocationPoint

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

Type: String

Valid Values: PRE_PROVISION

Required: No

TargetDetails

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

Type: ChangeSetHookTargetDetails object

Required: No

TypeConfigurationVersionId

The version ID of the type configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-]+

Required: No

TypeName

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 196.

Required: No

TypeVersionId

The version ID of the type specified.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-]+

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: