Disable and enable Amazon CloudFormation Hooks - Amazon CloudFormation
Disable and enable a Hook (console)Disable and enable a Hook (Amazon CLI)
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).

Disable and enable Amazon CloudFormation Hooks

This topic describes how to disable and then re-enable a Hook to temporarily prevent it from being active in your account. Disabling Hooks can be useful when you need to investigate an issue without interference from Hooks.

Disable and enable a Hook in your account (console)

To disable a Hook in your account

  1. Sign in to the Amazon Web Services Management Console and open the Amazon CloudFormation console at https://console.amazonaws.cn/cloudformation.

  2. On the navigation bar at the top of the screen, choose the Amazon Web Services Region where the Hook is located.

  3. From the navigation pane, choose Hooks.

  4. Choose the name of the Hook you want to disable.

  5. On the Hook details page, to the right of the Hook's name, choose the Disable button.

  6. When prompted for confirmation, choose Disable Hook.

To re-enable a previously disabled Hook

  1. Sign in to the Amazon Web Services Management Console and open the Amazon CloudFormation console at https://console.amazonaws.cn/cloudformation.

  2. On the navigation bar at the top of the screen, choose the Amazon Web Services Region where the Hook is located.

  3. From the navigation pane, choose Hooks.

  4. Choose the name of the Hook you want to enable.

  5. On the Hook details page, to the right of the Hook's name, choose the Enable button.

  6. When prompted for confirmation, choose Enable Hook.

Disable and enable a Hook in your account (Amazon CLI)

Important

The Amazon CLI commands for disabling and enabling Hooks replace the entire Hook configuration with the values specified in the --configuration option. To avoid unintended changes, you must include all existing settings you wish to keep when running these commands. To view the current configuration data, use the describe-type command.

To disable a Hook

Use the following set-type-configuration command and specify HookInvocationStatus as DISABLED to disable the Hook. Replace the placeholders with your specific values.

aws cloudformation set-type-configuration \
  --configuration "{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus": "DISABLED", "FailureMode": "FAIL", "TargetOperations": ["STACK","RESOURCE","CHANGE_SET"], "Properties":{}}}}" \
  --type-arn "arn:aws:cloudformation:us-west-2:123456789012:type/hook/MyTestHook" \
  --region us-west-2
To re-enable a previously disabled Hook

Use the following set-type-configuration command and specify HookInvocationStatus as ENABLED to re-enable the Hook. Replace the placeholders with your specific values.

aws cloudformation set-type-configuration \
  --configuration "{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus": "ENABLED", "FailureMode": "FAIL", "TargetOperations": ["STACK","RESOURCE","CHANGE_SET"], "Properties":{}}}}" \
  --type-arn "arn:aws:cloudformation:us-west-2:123456789012:type/hook/MyTestHook" \
  --region us-west-2

For more information, see Hook configuration schema syntax reference.