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 for the S3 Bucket.
S3ToLambda	build()
static S3ToLambda.Builder	create(software.constructs.Construct scope, String id)
S3ToLambda.Builder	existingBucketObj(software.amazon.awscdk.services.s3.Bucket existingBucketObj) Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
S3ToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
S3ToLambda.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Optional user provided props to override the default props for the Lambda function.
S3ToLambda.Builder	loggingBucketProps(software.amazon.awscdk.services.s3.BucketProps loggingBucketProps) Optional user provided props to override the default props for the S3 Logging Bucket.
S3ToLambda.Builder	logS3AccessLogs(Boolean logS3AccessLogs) Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
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.constructs.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.

bucketProps

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

Optional user provided props to override the default props for the S3 Bucket.

Default: - Default props are used

Parameters:

bucketProps - Optional user provided props to override the default props for the 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, 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 S3ToLambda.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

lambdaFunctionProps

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

Optional user provided props to override the default props for the Lambda function.

Default: - Default props are used

Parameters:

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

Returns:

this

loggingBucketProps

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

Optional user provided props to override the default props for the S3 Logging Bucket.

Default: - Default props are used

Parameters:

loggingBucketProps - Optional user provided props to override the default props for the S3 Logging Bucket. This parameter is required.

Returns:

this

logS3AccessLogs

public S3ToLambda.Builder logS3AccessLogs(Boolean logS3AccessLogs)

Whether to turn on Access Logs for the S3 bucket with the associated storage costs.

Enabling Access Logging is a best practice.

Default: - true

Parameters:

logS3AccessLogs - Whether to turn on Access Logs for the S3 bucket with the associated storage costs. 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>