Guard Hooks - Amazon CloudFormation
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).

Guard Hooks

To use an Amazon CloudFormation Guard Hook in your account, you must activate the Hook for the account and Region where you want to use it. Activating a Hook makes it usable in stack operations in the account and Region where it's activated.

When you activate a Guard Hook, CloudFormation creates an entry in your account's registry for the activated Hook as a private Hook. This allows you to set any configuration properties the Hook includes. Configuration properties define how the Hook is configured for a given Amazon Web Services account and Region.

Amazon CLI commands for working with Guard Hooks

The Amazon CLI commands for working with Guard Hooks include:

  • activate-type to start the activation process for a Guard Hook.

  • set-type-configuration to specify the configuration data for a Hook in your account.

  • list-types to list the Hooks in your account.

  • describe-type to return detailed information about a specific Hook or specific Hook version, including current configuration data.

  • deactivate-type to remove a previously activated Hook from your account.