Package software.amazon.awscdk

Interface CfnLambdaHookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLambdaHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.087Z")
@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()
                 .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 typename alias for the hook.
String	getExecutionRole()	IAM Role ARN.
String	getFailureMode()	Attribute to specify CloudFormation behavior on hook failure.
String	getHookStatus()	Attribute to specify which stacks this hook applies to or should get invoked for.
String	getLambdaFunction()	Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
default Object	getStackFilters()	Filters to allow hooks to target specific stack attributes.
default Object	getTargetFilters()
List<String>	getTargetOperations()	Which operations should this Hook run against?

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

The typename alias for the hook.

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()

IAM Role ARN.

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()

Attribute to specify CloudFormation behavior on hook failure.

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()

Attribute to specify which stacks this hook applies to or should get invoked for.

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()

Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.

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()

Which operations should this Hook run against?

Resource changes, stacks or change sets.

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()

Filters to allow hooks to target specific stack attributes.

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()

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