software.amazon.awsconstructs.services.lambdas3

Class LambdaToS3.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdas3.LambdaToS3.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToS3>

Enclosing class:

LambdaToS3

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

A fluent builder for LambdaToS3.

Method Summary

Modifier and Type	Method and Description
LambdaToS3.Builder	bucketEnvironmentVariableName(String bucketEnvironmentVariableName) Optional Name for the S3 bucket environment variable set for the Lambda function.
LambdaToS3.Builder	bucketPermissions(List<String> bucketPermissions) Optional bucket permissions to grant to the Lambda function.
LambdaToS3.Builder	bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps) User provided props to override the default props for the S3 Bucket.
LambdaToS3	build()
static LambdaToS3.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
LambdaToS3.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToS3.Builder	existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj) Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
LambdaToS3.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToS3.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).
LambdaToS3.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToS3.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 LambdaToS3.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 LambdaToS3.Builder.

bucketEnvironmentVariableName

public LambdaToS3.Builder bucketEnvironmentVariableName(String bucketEnvironmentVariableName)

Optional Name for the S3 bucket environment variable set for the Lambda function.

Default: - None

Parameters:

bucketEnvironmentVariableName - Optional Name for the S3 bucket environment variable set for the Lambda function. This parameter is required.

Returns:

this

bucketPermissions

public LambdaToS3.Builder bucketPermissions(List<String> bucketPermissions)

Optional bucket permissions to grant to the Lambda function.

One or more of the following may be specified: "Delete", "Put", "Read", "ReadWrite", "Write".

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

Parameters:

bucketPermissions - Optional bucket permissions to grant to the Lambda function. This parameter is required.

Returns:

this

bucketProps

public LambdaToS3.Builder bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps)

User provided props to override the default props for the S3 Bucket.

Default: - Default props are used

Parameters:

bucketProps - User provided props to override the default props for the S3 Bucket. This parameter is required.

Returns:

this

deployVpc

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

existingBucketObj

public LambdaToS3.Builder existingBucketObj(software.amazon.awscdk.services.s3.IBucket existingBucketObj)

Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.

Default: - None

Parameters:

existingBucketObj - Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error. This parameter is required.

Returns:

this

existingLambdaObj

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

Specified by:

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