software.amazon.awsconstructs.services.lambdas3

Interface LambdaToS3Props

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaToS3Props.Jsii$Proxy

@Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-26T15:51:51.688Z")
public interface LambdaToS3Props
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LambdaToS3Props.Builder A builder for LambdaToS3Props
static class	LambdaToS3Props.Jsii$Proxy An implementation for LambdaToS3Props

Method Summary

Modifier and Type	Method and Description
static LambdaToS3Props.Builder	builder()
default String	getBucketEnvironmentVariableName() Optional Name for the Lambda function environment variable set to the name of the bucket.
default List<String>	getBucketPermissions() Optional bucket permissions to grant to the Lambda function.
default software.amazon.awscdk.services.s3.BucketProps	getBucketProps() Optional user provided props to override the default props for the S3 Bucket.
default Boolean	getDeployVpc() Whether to deploy a new VPC.
default software.amazon.awscdk.services.s3.IBucket	getExistingBucketObj() Existing instance of S3 Bucket object, providing both this and `bucketProps` will cause an error.
default software.amazon.awscdk.services.lambda.Function	getExistingLambdaObj() Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
default software.amazon.awscdk.services.ec2.IVpc	getExistingVpc() An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
default software.amazon.awscdk.services.lambda.FunctionProps	getLambdaFunctionProps() Optional user provided props to override the default props for the Lambda function.
default software.amazon.awscdk.services.s3.BucketProps	getLoggingBucketProps() Optional user provided props to override the default props for the S3 Logging Bucket.
default Boolean	getLogS3AccessLogs() Whether to turn on Access Logs for the S3 bucket with the associated storage costs.
default software.amazon.awscdk.services.ec2.VpcProps	getVpcProps() Properties to override default properties if deployVpc is true.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucketEnvironmentVariableName

@Nullable
default String getBucketEnvironmentVariableName()

Optional Name for the Lambda function environment variable set to the name of the bucket.

Default: - S3_BUCKET_NAME

getBucketPermissions

@Nullable
default List<String> getBucketPermissions()

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.

getBucketProps

@Nullable
default software.amazon.awscdk.services.s3.BucketProps getBucketProps()

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

Default: - Default props are used

getDeployVpc

@Nullable
default Boolean getDeployVpc()

Whether to deploy a new VPC.

Default: - false

getExistingBucketObj

@Nullable
default software.amazon.awscdk.services.s3.IBucket getExistingBucketObj()

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

Default: - None

getExistingLambdaObj

@Nullable
default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()

Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.

Default: - None

getExistingVpc

@Nullable
default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()

An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

getLambdaFunctionProps

@Nullable
default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()

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

Default: - Default properties are used.

getLoggingBucketProps

@Nullable
default software.amazon.awscdk.services.s3.BucketProps getLoggingBucketProps()

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

Default: - Default props are used

getLogS3AccessLogs

@Nullable
default Boolean getLogS3AccessLogs()

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

Enabling Access Logging is a best practice.

Default: - true

getVpcProps

@Nullable
default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()

Properties to override default properties if deployVpc is true.

builder

static LambdaToS3Props.Builder builder()

Returns:

a LambdaToS3Props.Builder of LambdaToS3Props