Package software.amazon.awscdk.services.s3objectlambda.alpha

Interface AccessPointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AccessPointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.398Z")
@Stability(Experimental)
public interface AccessPointProps
extends software.amazon.jsii.JsiiSerializable

(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.alpha.*;
 import software.amazon.awscdk.*;
 Stack stack = new Stack();
 Bucket bucket = new Bucket(stack, "MyBucket");
 Function handler = Function.Builder.create(stack, "MyFunction")
         .runtime(Runtime.NODEJS_LATEST)
         .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	Description
static final class	AccessPointProps.Builder	A builder for AccessPointProps
static final class	AccessPointProps.Jsii$Proxy	An implementation for AccessPointProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Experimental)
@NotNull
IBucket getBucket()

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

getHandler

@Stability(Experimental)
@NotNull
IFunction getHandler()

(experimental) The Lambda function used to transform objects.

getAccessPointName

@Stability(Experimental)
@Nullable
default String getAccessPointName()

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

Default: a unique name will be generated

getCloudWatchMetricsEnabled

@Stability(Experimental)
@Nullable
default Boolean getCloudWatchMetricsEnabled()

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

Default: false

getPayload

@Stability(Experimental)
@Nullable
default Map<String,Object> getPayload()

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

Default: - No data.

getSupportsGetObjectPartNumber

@Stability(Experimental)
@Nullable
default Boolean getSupportsGetObjectPartNumber()

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

Default: false

getSupportsGetObjectRange

@Stability(Experimental)
@Nullable
default Boolean getSupportsGetObjectRange()

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

Default: false

builder

@Stability(Experimental)
static AccessPointProps.Builder builder()

Returns:

a AccessPointProps.Builder of AccessPointProps