Package software.amazon.awscdk

Interface CfnLambdaHookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLambdaHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:57.263Z")
@Stability(Stable)
public interface CfnLambdaHookProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLambdaHook.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnLambdaHookProps cfnLambdaHookProps = CfnLambdaHookProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLambdaHookProps.Builder	A builder for CfnLambdaHookProps
static final class	CfnLambdaHookProps.Jsii$Proxy	An implementation for CfnLambdaHookProps

Method Summary

Modifier and Type	Method	Description
static CfnLambdaHookProps.Builder	builder()
String	getAlias()	The type name alias for the Hook.
String	getExecutionRole()	The IAM role that the Hook assumes to invoke your Lambda function.
String	getFailureMode()	Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.
String	getHookStatus()	Specifies if the Hook is ENABLED or DISABLED .
String	getLambdaFunction()	Specifies the Lambda function for the Hook.
default Object	getStackFilters()	Specifies the stack level filters for the Hook.
default Object	getTargetFilters()	Specifies the target filters for the Hook.
List<String>	getTargetOperations()	Specifies the list of operations the Hook is run against.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

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::Lambda::MyTestHook .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-alias

getExecutionRole

@Stability(Stable)
@NotNull
String getExecutionRole()

The IAM role that the Hook assumes to invoke your Lambda function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-executionrole

getFailureMode

@Stability(Stable)
@NotNull
String getFailureMode()

Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.

• 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-lambdahook.html#cfn-cloudformation-lambdahook-failuremode

getHookStatus

@Stability(Stable)
@NotNull
String getHookStatus()

Specifies if the Hook is ENABLED or DISABLED .

Default: - "ENABLED"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-hookstatus

getLambdaFunction

@Stability(Stable)
@NotNull
String getLambdaFunction()

Specifies the Lambda function for the Hook. You can use:.

• The full Amazon Resource Name (ARN) without a suffix.
• A qualified ARN with a version or alias suffix.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-lambdafunction

getTargetOperations

@Stability(Stable)
@NotNull
List<String> getTargetOperations()

Specifies the list of operations the Hook is run against.

For more information, see Hook targets in the AWS 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-lambdahook.html#cfn-cloudformation-lambdahook-targetoperations

getStackFilters

@Stability(Stable)
@Nullable
default Object getStackFilters()

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

Returns union: either IResolvable or CfnLambdaHook.StackFiltersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-stackfilters

getTargetFilters

@Stability(Stable)
@Nullable
default Object getTargetFilters()

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

Returns union: either IResolvable or CfnLambdaHook.TargetFiltersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-targetfilters

builder

@Stability(Stable)
static CfnLambdaHookProps.Builder builder()

Returns:

a CfnLambdaHookProps.Builder of CfnLambdaHookProps