software.amazon.awsconstructs.services.lambdadynamodb

Class LambdaToDynamoDB.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdadynamodb.LambdaToDynamoDB.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToDynamoDB>

Enclosing class:

LambdaToDynamoDB

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

A fluent builder for LambdaToDynamoDB.

Method Summary

Modifier and Type	Method and Description
LambdaToDynamoDB	build()
static LambdaToDynamoDB.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
LambdaToDynamoDB.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToDynamoDB.Builder	dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps) Optional user provided props to override the default props.
LambdaToDynamoDB.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToDynamoDB.Builder	existingTableObj(software.amazon.awscdk.services.dynamodb.Table existingTableObj) Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.
LambdaToDynamoDB.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).
LambdaToDynamoDB.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToDynamoDB.Builder	tableEnvironmentVariableName(String tableEnvironmentVariableName) Optional Name for the DynamoDB table environment variable set for the Lambda function.
LambdaToDynamoDB.Builder	tablePermissions(String tablePermissions) Optional table permissions to grant to the Lambda function.
LambdaToDynamoDB.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 LambdaToDynamoDB.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 LambdaToDynamoDB.Builder.

deployVpc

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

dynamoTableProps

public LambdaToDynamoDB.Builder dynamoTableProps(software.amazon.awscdk.services.dynamodb.TableProps dynamoTableProps)

Optional user provided props to override the default props.

Default: - Default props are used

Parameters:

dynamoTableProps - Optional user provided props to override the default props. This parameter is required.

Returns:

this

existingLambdaObj

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

existingTableObj

public LambdaToDynamoDB.Builder existingTableObj(software.amazon.awscdk.services.dynamodb.Table existingTableObj)

Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error.

Default: - None

Parameters:

existingTableObj - Existing instance of DynamoDB table object, providing both this and `dynamoTableProps` will cause an error. This parameter is required.

Returns:

this

existingVpc

public LambdaToDynamoDB.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 LambdaToDynamoDB.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

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

Default: - Default props are used

Parameters:

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

Returns:

this

tableEnvironmentVariableName

public LambdaToDynamoDB.Builder tableEnvironmentVariableName(String tableEnvironmentVariableName)

Optional Name for the DynamoDB table environment variable set for the Lambda function.

Default: - None

Parameters:

tableEnvironmentVariableName - Optional Name for the DynamoDB table environment variable set for the Lambda function. This parameter is required.

Returns:

this

tablePermissions

public LambdaToDynamoDB.Builder tablePermissions(String tablePermissions)

Optional table permissions to grant to the Lambda function.

One of the following may be specified: "All", "Read", "ReadWrite", "Write".

Default: - Read/write access is given to the Lambda function if no value is specified.

Parameters:

tablePermissions - Optional table permissions to grant to the Lambda function. This parameter is required.

Returns:

this

vpcProps

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

Specified by:

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