software.amazon.awsconstructs.services.lambdaeventbridge

Class LambdaToEventbridge.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdaeventbridge.LambdaToEventbridge.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToEventbridge>

Enclosing class:

LambdaToEventbridge

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

A fluent builder for LambdaToEventbridge.

Method Summary

Modifier and Type	Method and Description
LambdaToEventbridge	build()
static LambdaToEventbridge.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
LambdaToEventbridge.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToEventbridge.Builder	eventBusEnvironmentVariableName(String eventBusEnvironmentVariableName) Optional Name for the EventBus's name environment variable set for the Lambda function.
LambdaToEventbridge.Builder	eventBusProps(software.amazon.awscdk.services.events.EventBusProps eventBusProps) A new custom EventBus is created with provided props.
LambdaToEventbridge.Builder	existingEventBusInterface(software.amazon.awscdk.services.events.IEventBus existingEventBusInterface) Existing instance of a custom EventBus.
LambdaToEventbridge.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToEventbridge.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).
LambdaToEventbridge.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToEventbridge.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 LambdaToEventbridge.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 LambdaToEventbridge.Builder.

deployVpc

public LambdaToEventbridge.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

eventBusEnvironmentVariableName

public LambdaToEventbridge.Builder eventBusEnvironmentVariableName(String eventBusEnvironmentVariableName)

Optional Name for the EventBus's name environment variable set for the Lambda function.

Default: - EVENTBUS_NAME is used

Parameters:

eventBusEnvironmentVariableName - Optional Name for the EventBus's name environment variable set for the Lambda function. This parameter is required.

Returns:

this

eventBusProps

public LambdaToEventbridge.Builder eventBusProps(software.amazon.awscdk.services.events.EventBusProps eventBusProps)

A new custom EventBus is created with provided props.

Default: - None

Parameters:

eventBusProps - A new custom EventBus is created with provided props. This parameter is required.

Returns:

this

existingEventBusInterface

public LambdaToEventbridge.Builder existingEventBusInterface(software.amazon.awscdk.services.events.IEventBus existingEventBusInterface)

Existing instance of a custom EventBus.

Default: - None

Parameters:

existingEventBusInterface - Existing instance of a custom EventBus. This parameter is required.

Returns:

this

existingLambdaObj

public LambdaToEventbridge.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 LambdaToEventbridge.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 LambdaToEventbridge.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

vpcProps

public LambdaToEventbridge.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 LambdaToEventbridge build()

Specified by:

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