Package software.amazon.awscdk.services.cloudformation

Class CfnLambdaHook

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudformation.CfnLambdaHook
All Implemented Interfaces:
IInspectable, ILambdaHookRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:32.806Z") @Stability(Stable) public class CfnLambdaHook extends CfnResource implements IInspectable, ILambdaHookRef
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 AWS CloudFormation Hooks User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnLambdaHook cfnLambdaHook = CfnLambdaHook.Builder.create(this, "MyCfnLambdaHook")
         .alias("alias")
         .executionRole("executionRole")
         .failureMode("failureMode")
         .hookStatus("hookStatus")
         .lambdaFunction("lambdaFunction")
         .targetOperations(List.of("targetOperations"))
         // the properties below are optional
         .stackFilters(StackFiltersProperty.builder()
                 .filteringCriteria("filteringCriteria")
                 // the properties below are optional
                 .stackNames(StackNamesProperty.builder()
                         .exclude(List.of("exclude"))
                         .include(List.of("include"))
                         .build())
                 .stackRoles(StackRolesProperty.builder()
                         .exclude(List.of("exclude"))
                         .include(List.of("include"))
                         .build())
                 .build())
         .targetFilters(TargetFiltersProperty.builder()
                 .targets(List.of(HookTargetProperty.builder()
                         .action("action")
                         .invocationPoint("invocationPoint")
                         .targetName("targetName")
                         .build()))
                 // the properties below are optional
                 .actions(List.of("actions"))
                 .invocationPoints(List.of("invocationPoints"))
                 .targetNames(List.of("targetNames"))
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLambdaHook

      protected CfnLambdaHook(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLambdaHook

      protected CfnLambdaHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLambdaHook

      @Stability(Stable) public CfnLambdaHook(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLambdaHookProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrHookArn

      @Stability(Stable) @NotNull public String getAttrHookArn()
      Returns the ARN of a Lambda Hook.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLambdaHookRef

      @Stability(Stable) @NotNull public LambdaHookReference getLambdaHookRef()
      A reference to a LambdaHook resource.
      Specified by:
      getLambdaHookRef in interface ILambdaHookRef

    • getAlias

      @Stability(Stable) @NotNull public String getAlias()
      The type name alias for the Hook.

      This alias must be unique per account and Region.

    • setAlias

      @Stability(Stable) public void setAlias(@NotNull String value)
      The type name alias for the Hook.

      This alias must be unique per account and Region.

    • getExecutionRole

      @Stability(Stable) @NotNull public String getExecutionRole()
      The IAM role that the Hook assumes to invoke your Lambda function.

    • setExecutionRole

      @Stability(Stable) public void setExecutionRole(@NotNull String value)
      The IAM role that the Hook assumes to invoke your Lambda function.

    • getFailureMode

      @Stability(Stable) @NotNull public String getFailureMode()
      Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.

    • setFailureMode

      @Stability(Stable) public void setFailureMode(@NotNull String value)
      Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.

    • getHookStatus

      @Stability(Stable) @NotNull public String getHookStatus()
      Specifies if the Hook is ENABLED or DISABLED .

    • setHookStatus

      @Stability(Stable) public void setHookStatus(@NotNull String value)
      Specifies if the Hook is ENABLED or DISABLED .

    • getLambdaFunction

      @Stability(Stable) @NotNull public String getLambdaFunction()
      Specifies the Lambda function for the Hook.

      You can use:.

    • setLambdaFunction

      @Stability(Stable) public void setLambdaFunction(@NotNull String value)
      Specifies the Lambda function for the Hook.

      You can use:.

    • getTargetOperations

      @Stability(Stable) @NotNull public List<String> getTargetOperations()
      Specifies the list of operations the Hook is run against.

    • setTargetOperations

      @Stability(Stable) public void setTargetOperations(@NotNull List<String> value)
      Specifies the list of operations the Hook is run against.

    • getStackFilters

      @Stability(Stable) @Nullable public Object getStackFilters()
      Specifies the stack level filters for the Hook.

      Returns union: either IResolvable or CfnLambdaHook.StackFiltersProperty

    • setStackFilters

      @Stability(Stable) public void setStackFilters(@Nullable IResolvable value)
      Specifies the stack level filters for the Hook.

    • setStackFilters

      @Stability(Stable) public void setStackFilters(@Nullable CfnLambdaHook.StackFiltersProperty value)
      Specifies the stack level filters for the Hook.

    • getTargetFilters

      @Stability(Stable) @Nullable public Object getTargetFilters()
      Specifies the target filters for the Hook.

      Returns union: either IResolvable or CfnLambdaHook.TargetFiltersProperty

    • setTargetFilters

      @Stability(Stable) public void setTargetFilters(@Nullable IResolvable value)
      Specifies the target filters for the Hook.

    • setTargetFilters

      @Stability(Stable) public void setTargetFilters(@Nullable CfnLambdaHook.TargetFiltersProperty value)
      Specifies the target filters for the Hook.