class CfnLambdaHookPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.CloudFormation.CfnLambdaHookPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscloudformation#CfnLambdaHookPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnLambdaHookPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_cloudformation.CfnLambdaHookPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_cloudformation » CfnLambdaHookPropsMixin

Implements IMixin

Extends Mixin

The AWS::CloudFormation::LambdaHook resource creates and activates a Lambda Hook.

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudformation as cloudformation } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnLambdaHookPropsMixin = new cloudformation.CfnLambdaHookPropsMixin({
  alias: 'alias',
  executionRole: 'executionRole',
  failureMode: 'failureMode',
  hookStatus: 'hookStatus',
  lambdaFunction: 'lambdaFunction',
  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: mergeStrategy,
});

Initializer

new CfnLambdaHookPropsMixin(props: CfnLambdaHookMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

Name	Type	Description
props	CfnLambdaHookMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnLambdaHookMixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

• construct 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.