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

Class CfnLambdaHookPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnLambdaHookPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLambdaHookPropsMixin>

Enclosing class:

CfnLambdaHookPropsMixin

@Stability(Stable)
public static final class CfnLambdaHookPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLambdaHookPropsMixin>

A fluent builder for CfnLambdaHookPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLambdaHookPropsMixin.Builder	alias(String alias)	The type name alias for the Hook.
CfnLambdaHookPropsMixin	build()
static CfnLambdaHookPropsMixin.Builder	create()
static CfnLambdaHookPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLambdaHookPropsMixin.Builder	executionRole(String executionRole)	The IAM role that the Hook assumes to invoke your Lambda function.
CfnLambdaHookPropsMixin.Builder	failureMode(String failureMode)	Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.
CfnLambdaHookPropsMixin.Builder	hookStatus(String hookStatus)	Specifies if the Hook is ENABLED or DISABLED .
CfnLambdaHookPropsMixin.Builder	lambdaFunction(String lambdaFunction)	Specifies the Lambda function for the Hook.
CfnLambdaHookPropsMixin.Builder	stackFilters(CfnLambdaHookPropsMixin.StackFiltersProperty stackFilters)	Specifies the stack level filters for the Hook.
CfnLambdaHookPropsMixin.Builder	stackFilters(IResolvable stackFilters)	Specifies the stack level filters for the Hook.
CfnLambdaHookPropsMixin.Builder	targetFilters(CfnLambdaHookPropsMixin.TargetFiltersProperty targetFilters)	Specifies the target filters for the Hook.
CfnLambdaHookPropsMixin.Builder	targetFilters(IResolvable targetFilters)	Specifies the target filters for the Hook.
CfnLambdaHookPropsMixin.Builder	targetOperations(List<String> targetOperations)	Specifies the list of operations the Hook is run against.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLambdaHookPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLambdaHookPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLambdaHookPropsMixin.Builder create()

Returns:

a new instance of CfnLambdaHookPropsMixin.Builder.

alias

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder alias(String alias)

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 .

Parameters:

alias - The type name alias for the Hook. This alias must be unique per account and Region. This parameter is required.

Returns:

this

See Also:

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

executionRole

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder executionRole(String executionRole)

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

Parameters:

executionRole - The IAM role that the Hook assumes to invoke your Lambda function. This parameter is required.

Returns:

this

See Also:

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

failureMode

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder failureMode(String failureMode)

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.

Parameters:

failureMode - Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response. This parameter is required.

Returns:

this

See Also:

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

hookStatus

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder hookStatus(String hookStatus)

Specifies if the Hook is ENABLED or DISABLED .

Default: - "ENABLED"

Parameters:

hookStatus - Specifies if the Hook is ENABLED or DISABLED . This parameter is required.

Returns:

this

See Also:

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

lambdaFunction

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder lambdaFunction(String lambdaFunction)

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.

Parameters:

lambdaFunction - Specifies the Lambda function for the Hook. You can use:. This parameter is required.

Returns:

this

See Also:

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

stackFilters

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder stackFilters(IResolvable stackFilters)

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

Parameters:

stackFilters - Specifies the stack level filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

stackFilters

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder stackFilters(CfnLambdaHookPropsMixin.StackFiltersProperty stackFilters)

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

Parameters:

stackFilters - Specifies the stack level filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

targetFilters

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder targetFilters(IResolvable targetFilters)

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

Parameters:

targetFilters - Specifies the target filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

targetFilters

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder targetFilters(CfnLambdaHookPropsMixin.TargetFiltersProperty targetFilters)

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

Parameters:

targetFilters - Specifies the target filters for the Hook. This parameter is required.

Returns:

this

See Also:

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

targetOperations

@Stability(Stable)
public CfnLambdaHookPropsMixin.Builder targetOperations(List<String> targetOperations)

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

Parameters:

targetOperations - Specifies the list of operations the Hook is run against. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLambdaHookPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLambdaHookPropsMixin>

Returns:

a newly built instance of CfnLambdaHookPropsMixin.