software.amazon.awscdk.services.s3objectlambda

Interface AccessPointProps

All Known Implementing Classes:

AccessPointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:54.925Z")
public interface AccessPointProps

(experimental) The S3 object lambda access point configuration.

Example:

 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.s3objectlambda.*;
 import software.amazon.awscdk.core.*;
 Stack stack = new Stack();
 Bucket bucket = new Bucket(stack, "MyBucket");
 Function handler = Function.Builder.create(stack, "MyFunction")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset("lambda.zip"))
         .build();
 AccessPoint.Builder.create(stack, "MyObjectLambda")
         .bucket(bucket)
         .handler(handler)
         .accessPointName("my-access-point")
         .payload(Map.of(
                 "prop", "value"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AccessPointProps.Builder	builder()
default java.lang.String	getAccessPointName() (experimental) The name of the S3 object lambda access point.
IBucket	getBucket() (experimental) The bucket to which this access point belongs.
default java.lang.Boolean	getCloudWatchMetricsEnabled() (experimental) Whether CloudWatch metrics are enabled for the access point.
IFunction	getHandler() (experimental) The Lambda function used to transform objects.
default java.util.Map<java.lang.String,java.lang.Object>	getPayload() (experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.
default java.lang.Boolean	getSupportsGetObjectPartNumber() (experimental) Whether the Lambda function can process `GetObject-PartNumber` requests.
default java.lang.Boolean	getSupportsGetObjectRange() (experimental) Whether the Lambda function can process `GetObject-Range` requests.

Method Detail

getBucket

IBucket getBucket()

(experimental) The bucket to which this access point belongs.

getHandler

IFunction getHandler()

(experimental) The Lambda function used to transform objects.

getAccessPointName

default java.lang.String getAccessPointName()

(experimental) The name of the S3 object lambda access point.

Default: a unique name will be generated

getCloudWatchMetricsEnabled

default java.lang.Boolean getCloudWatchMetricsEnabled()

(experimental) Whether CloudWatch metrics are enabled for the access point.

Default: false

getPayload

default java.util.Map<java.lang.String,java.lang.Object> getPayload()

(experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.

Default: - No data.

getSupportsGetObjectPartNumber

default java.lang.Boolean getSupportsGetObjectPartNumber()

(experimental) Whether the Lambda function can process `GetObject-PartNumber` requests.

Default: false

getSupportsGetObjectRange

default java.lang.Boolean getSupportsGetObjectRange()

(experimental) Whether the Lambda function can process `GetObject-Range` requests.

Default: false

builder

static AccessPointProps.Builder builder()

Returns:

a AccessPointProps.Builder of AccessPointProps