---
type: resource-type
title: GuardHook
description: aws resource type AWS::CloudFormation::GuardHook
name: GuardHook
lexicon: aws
resource_type: AWS::CloudFormation::GuardHook
---
`AWS::CloudFormation::GuardHook`, a resource type of the aws lexicon.

## Properties

- `Alias` (`string`, required): The typename alias for the hook.
- `ExecutionRole` (`string`, required): The execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3.
- `FailureMode` (`"FAIL" | "WARN"`, required): Attribute to specify CloudFormation behavior on hook failure.
- `HookStatus` (`"DISABLED" | "ENABLED"`, required): Attribute to specify which stacks this hook applies to or should get invoked for
- `RuleLocation` (`GuardHook_S3Location`, required)
- `TargetOperations` (`GuardHook_TargetOperation[]`, required): Which operations should this Hook run against? Resource changes, stacks or change sets.
- `HookArn` (`string`, optional): The Amazon Resource Name (ARN) of the activated hook
- `LogBucket` (`string`, optional): S3 Bucket where the guard validate report will be uploaded to
- `Options` (`any`, optional)
- `StackFilters` (`Record<string, unknown>`, optional): Filters to allow hooks to target specific stack attributes
- `TargetFilters` (`any`, optional): Attribute to specify which targets should invoke the hook

## Attributes

- `HookArn`