software.amazon.awsconstructs.services.lambdastepfunction

Class LambdaToStepFunction.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdastepfunction.LambdaToStepFunction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToStepFunction>

Enclosing class:

LambdaToStepFunction

public static final class LambdaToStepFunction.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaToStepFunction>

A fluent builder for LambdaToStepFunction.

Method Summary

Modifier and Type	Method and Description
LambdaToStepFunction	build()
static LambdaToStepFunction.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
LambdaToStepFunction.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms) Whether to create recommended CloudWatch alarms.
LambdaToStepFunction.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToStepFunction.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToStepFunction.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
LambdaToStepFunction.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToStepFunction.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) User provided props to override the default props for the CloudWatchLogs LogGroup.
LambdaToStepFunction.Builder	stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName) Optional Name for the Lambda function environment variable set to the ARN of the state machine.
LambdaToStepFunction.Builder	stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps) User provided StateMachineProps to override the defaults.
LambdaToStepFunction.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Properties to override default properties if deployVpc is true.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LambdaToStepFunction.Builder create(software.amazon.awscdk.core.Construct scope,
                                                  String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of LambdaToStepFunction.Builder.

stateMachineProps

public LambdaToStepFunction.Builder stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps)

User provided StateMachineProps to override the defaults.

Default: - None

Parameters:

stateMachineProps - User provided StateMachineProps to override the defaults. This parameter is required.

Returns:

this

createCloudWatchAlarms

public LambdaToStepFunction.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Whether to create recommended CloudWatch alarms.

Default: - Alarms are created

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms. This parameter is required.

Returns:

this

deployVpc

public LambdaToStepFunction.Builder deployVpc(Boolean deployVpc)

Whether to deploy a new VPC.

Default: - false

Parameters:

deployVpc - Whether to deploy a new VPC. This parameter is required.

Returns:

this

existingLambdaObj

public LambdaToStepFunction.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. This parameter is required.

Returns:

this

existingVpc

public LambdaToStepFunction.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

Parameters:

existingVpc - An existing VPC for the construct to use (construct will NOT create a new VPC in this case). This parameter is required.

Returns:

this

lambdaFunctionProps

public LambdaToStepFunction.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

User provided props to override the default props for the Lambda function.

Default: - Default properties are used.

Parameters:

lambdaFunctionProps - User provided props to override the default props for the Lambda function. This parameter is required.

Returns:

this

logGroupProps

public LambdaToStepFunction.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

User provided props to override the default props for the CloudWatchLogs LogGroup.

Default: - Default props are used

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup. This parameter is required.

Returns:

this

stateMachineEnvironmentVariableName

public LambdaToStepFunction.Builder stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName)

Optional Name for the Lambda function environment variable set to the ARN of the state machine.

Default: - STATE_MACHINE_ARN

Parameters:

stateMachineEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the ARN of the state machine. This parameter is required.

Returns:

this

vpcProps

public LambdaToStepFunction.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Properties to override default properties if deployVpc is true.

Parameters:

vpcProps - Properties to override default properties if deployVpc is true. This parameter is required.

Returns:

this

build

public LambdaToStepFunction build()

Specified by:

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