Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Interface CfnLambdaHookMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLambdaHookMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.942Z")
@Stability(Stable)
public interface CfnLambdaHookMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnLambdaHookPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
 CfnLambdaHookMixinProps cfnLambdaHookMixinProps = CfnLambdaHookMixinProps.builder()
         .alias("alias")
         .executionRole("executionRole")
         .failureMode("failureMode")
         .hookStatus("hookStatus")
         .lambdaFunction("lambdaFunction")
         .stackFilters(StackFiltersProperty.builder()
                 .filteringCriteria("filteringCriteria")
                 .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()
                 .actions(List.of("actions"))
                 .invocationPoints(List.of("invocationPoints"))
                 .targetNames(List.of("targetNames"))
                 .targets(List.of(HookTargetProperty.builder()
                         .action("action")
                         .invocationPoint("invocationPoint")
                         .targetName("targetName")
                         .build()))
                 .build())
         .targetOperations(List.of("targetOperations"))
         .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	CfnLambdaHookMixinProps.Builder	A builder for CfnLambdaHookMixinProps
static final class	CfnLambdaHookMixinProps.Jsii$Proxy	An implementation for CfnLambdaHookMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnLambdaHookMixinProps.Builder	builder()
default String	getAlias()	The type name alias for the Hook.
default String	getExecutionRole()	The IAM role that the Hook assumes to invoke your Lambda function.
default String	getFailureMode()	Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.
default String	getHookStatus()	Specifies if the Hook is ENABLED or DISABLED .
default 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.
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

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 CfnLambdaHookPropsMixin.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 CfnLambdaHookPropsMixin.TargetFiltersProperty

See Also:

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

getTargetOperations

@Stability(Stable)
@Nullable
default List<String> getTargetOperations()

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

builder

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

Returns:

a CfnLambdaHookMixinProps.Builder of CfnLambdaHookMixinProps