class CfnGuardHookPropsMixin

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

Implements IMixin

Extends Mixin

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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 } from '@aws-cdk/mixins-preview';
import { mixins as cloudformation_mixins } from '@aws-cdk/mixins-preview/aws-cloudformation';
const cfnGuardHookPropsMixin = new cloudformation_mixins.CfnGuardHookPropsMixin({
  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'],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnGuardHookPropsMixin(props: CfnGuardHookMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGuardHookMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CloudFormation::GuardHook.

Properties

Name	Type	Description
props	CfnGuardHookMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGuardHookMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.