software.amazon.awsconstructs.services.s3lambda

Class S3ToLambda.Builder

java.lang.Object

software.amazon.awsconstructs.services.s3lambda.S3ToLambda.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3ToLambda>

Enclosing class:

S3ToLambda

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

A fluent builder for S3ToLambda.

Method Summary

Modifier and Type	Method and Description
S3ToLambda.Builder	bucketProps(software.amazon.awscdk.services.s3.BucketProps bucketProps) Optional user provided props to override the default props.
S3ToLambda	build()
static S3ToLambda.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
S3ToLambda.Builder	deployBucket(Boolean deployBucket) Whether to create a S3 Bucket or use an existing S3 Bucket.
S3ToLambda.Builder	deployLambda(Boolean deployLambda) Whether to create a new lambda function or use an existing lambda function.
S3ToLambda.Builder	existingBucketObj(software.amazon.awscdk.services.s3.Bucket existingBucketObj) Existing instance of S3 Bucket object.
S3ToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object.
S3ToLambda.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Optional user provided props to override the default props.
S3ToLambda.Builder	s3EventSourceProps(software.amazon.awscdk.services.lambda.eventsources.S3EventSourceProps s3EventSourceProps) Optional user provided props to override the default props.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static S3ToLambda.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 S3ToLambda.Builder.

deployLambda

public S3ToLambda.Builder deployLambda(Boolean deployLambda)

Whether to create a new lambda function or use an existing lambda function.

If set to false, you must provide a lambda function object as existingObj

Default: - true

Parameters:

deployLambda - Whether to create a new lambda function or use an existing lambda function. This parameter is required.

Returns:

this

bucketProps

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

Optional user provided props to override the default props.

If deploy is set to true only then this property is required

Default: - Default props are used

Parameters:

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

Returns:

this

deployBucket

public S3ToLambda.Builder deployBucket(Boolean deployBucket)

Whether to create a S3 Bucket or use an existing S3 Bucket.

If set to false, you must provide S3 Bucket as existingBucketObj

Default: - true

Parameters:

deployBucket - Whether to create a S3 Bucket or use an existing S3 Bucket. This parameter is required.

Returns:

this

existingBucketObj

public S3ToLambda.Builder existingBucketObj(software.amazon.awscdk.services.s3.Bucket existingBucketObj)

Existing instance of S3 Bucket object.

If deployBucket is set to false only then this property is required

Default: - None

Parameters:

existingBucketObj - Existing instance of S3 Bucket object. This parameter is required.

Returns:

this

existingLambdaObj

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

Existing instance of Lambda Function object.

If deploy is set to false only then this property is required

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object. This parameter is required.

Returns:

this

lambdaFunctionProps

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

Optional user provided props to override the default props.

If deploy is set to true only then this property is required

Default: - Default props are used

Parameters:

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

Returns:

this

s3EventSourceProps

public S3ToLambda.Builder s3EventSourceProps(software.amazon.awscdk.services.lambda.eventsources.S3EventSourceProps s3EventSourceProps)

Optional user provided props to override the default props.

Default: - Default props are used

Parameters:

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

Returns:

this

build

public S3ToLambda build()

Specified by:

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