interface CfnGuardHookMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudFormation.Mixins.CfnGuardHookMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudformation/mixins#CfnGuardHookMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.CfnGuardHookMixinProps
Python	aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnGuardHookMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cloudformation » mixins » CfnGuardHookMixinProps

Properties for CfnGuardHookPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cloudformation_mixins } from '@aws-cdk/mixins-preview/aws-cloudformation';
const cfnGuardHookMixinProps: cloudformation_mixins.CfnGuardHookMixinProps = {
  alias: 'alias',
  executionRole: 'executionRole',
  failureMode: 'failureMode',
  hookStatus: 'hookStatus',
  logBucket: 'logBucket',
  options: {
    inputParams: {
      uri: 'uri',
      versionId: 'versionId',
    },
  },
  ruleLocation: {
    uri: 'uri',
    versionId: 'versionId',
  },
  stackFilters: {
    filteringCriteria: 'filteringCriteria',
    stackNames: {
      exclude: ['exclude'],
      include: ['include'],
    },
    stackRoles: {
      exclude: ['exclude'],
      include: ['include'],
    },
  },
  targetFilters: {
    actions: ['actions'],
    invocationPoints: ['invocationPoints'],
    targetNames: ['targetNames'],
    targets: [{
      action: 'action',
      invocationPoint: 'invocationPoint',
      targetName: 'targetName',
    }],
  },
  targetOperations: ['targetOperations'],
};

Properties

Name	Type	Description
alias?	string	The type name alias for the Hook. This alias must be unique per account and Region.
executionRole?	string	The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.
failureMode?	string	Specifies how the Hook responds when rules fail their evaluation.
hookStatus?	string	Specifies if the Hook is ENABLED or DISABLED .
logBucket?	string	Specifies the name of an S3 bucket to store the Guard output report.
options?	IResolvable | OptionsProperty	Specifies the S3 location of your input parameters.
ruleLocation?	IResolvable | S3LocationProperty	Specifies the S3 location of your Guard rules.
stackFilters?	IResolvable | StackFiltersProperty	Specifies the stack level filters for the Hook.
targetFilters?	IResolvable | TargetFiltersProperty	Specifies the target filters for the Hook.
targetOperations?	string[]	Specifies the list of operations the Hook is run against.

---

alias?

Type: string (optional)

The type name alias for the Hook. This alias must be unique per account and Region.

The alias must be in the form Name1::Name2::Name3 and must not begin with AWS . For example, Private::Guard::MyTestHook .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-alias

---

executionRole?

Type: string (optional)

The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-executionrole

---

failureMode?

Type: string (optional, default: "WARN")

Specifies how the Hook responds when rules fail their evaluation.

• FAIL : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies.
• WARN : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-failuremode

---

hookStatus?

Type: string (optional, default: "DISABLED")

Specifies if the Hook is ENABLED or DISABLED .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-hookstatus

---

logBucket?

Type: string (optional)

Specifies the name of an S3 bucket to store the Guard output report.

This report contains the results of your Guard rule validations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-logbucket

---

options?

Type: IResolvable | OptionsProperty (optional)

Specifies the S3 location of your input parameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-options

---

ruleLocation?

Type: IResolvable | S3LocationProperty (optional)

Specifies the S3 location of your Guard rules.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-rulelocation

---

stackFilters?

Type: IResolvable | StackFiltersProperty (optional)

Specifies the stack level filters for the Hook.

Example stack level filter in JSON:

"StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}}

Example stack level filter in YAML:

StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-stackfilters

---

targetFilters?

Type: IResolvable | TargetFiltersProperty (optional)

Specifies the target filters for the Hook.

Example target filter in JSON:

"TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]}

Example target filter in YAML:

TargetFilters: Actions: - CREATE - UPDATE - DELETE

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetfilters

---

targetOperations?

Type: string[] (optional)

Specifies the list of operations the Hook is run against.

For more information, see Hook targets in the CloudFormation Hooks User Guide .

Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetoperations