software.amazon.awscdk.services.s3objectlambda

Class AccessPoint.Builder

java.lang.Object

software.amazon.awscdk.services.s3objectlambda.AccessPoint.Builder

Enclosing class:

AccessPoint

public static final class AccessPoint.Builder
extends java.lang.Object

(experimental) A fluent builder for AccessPoint.

Method Summary

Modifier and Type	Method and Description
AccessPoint.Builder	accessPointName(java.lang.String accessPointName) (experimental) The name of the S3 object lambda access point.
AccessPoint.Builder	bucket(IBucket bucket) (experimental) The bucket to which this access point belongs.
AccessPoint	build()
AccessPoint.Builder	cloudWatchMetricsEnabled(java.lang.Boolean cloudWatchMetricsEnabled) (experimental) Whether CloudWatch metrics are enabled for the access point.
static AccessPoint.Builder	create(software.constructs.Construct scope, java.lang.String id)
AccessPoint.Builder	handler(IFunction handler) (experimental) The Lambda function used to transform objects.
AccessPoint.Builder	payload(java.util.Map<java.lang.String,? extends java.lang.Object> payload) (experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.
AccessPoint.Builder	supportsGetObjectPartNumber(java.lang.Boolean supportsGetObjectPartNumber) (experimental) Whether the Lambda function can process `GetObject-PartNumber` requests.
AccessPoint.Builder	supportsGetObjectRange(java.lang.Boolean supportsGetObjectRange) (experimental) Whether the Lambda function can process `GetObject-Range` requests.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AccessPoint.Builder create(software.constructs.Construct scope,
                                         java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AccessPoint.Builder.

bucket

public AccessPoint.Builder bucket(IBucket bucket)

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

Parameters:

bucket - The bucket to which this access point belongs. This parameter is required.

Returns:

this

handler

public AccessPoint.Builder handler(IFunction handler)

(experimental) The Lambda function used to transform objects.

Parameters:

handler - The Lambda function used to transform objects. This parameter is required.

Returns:

this

accessPointName

public AccessPoint.Builder accessPointName(java.lang.String accessPointName)

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

Default: a unique name will be generated

Parameters:

accessPointName - The name of the S3 object lambda access point. This parameter is required.

Returns:

this

cloudWatchMetricsEnabled

public AccessPoint.Builder cloudWatchMetricsEnabled(java.lang.Boolean cloudWatchMetricsEnabled)

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

Default: false

Parameters:

cloudWatchMetricsEnabled - Whether CloudWatch metrics are enabled for the access point. This parameter is required.

Returns:

this

payload

public AccessPoint.Builder payload(java.util.Map<java.lang.String,? extends java.lang.Object> payload)

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

Default: - No data.

Parameters:

payload - Additional JSON that provides supplemental data passed to the Lambda function on every request. This parameter is required.

Returns:

this

supportsGetObjectPartNumber

public AccessPoint.Builder supportsGetObjectPartNumber(java.lang.Boolean supportsGetObjectPartNumber)

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

Default: false

Parameters:

supportsGetObjectPartNumber - Whether the Lambda function can process `GetObject-PartNumber` requests. This parameter is required.

Returns:

this

supportsGetObjectRange

public AccessPoint.Builder supportsGetObjectRange(java.lang.Boolean supportsGetObjectRange)

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

Default: false

Parameters:

supportsGetObjectRange - Whether the Lambda function can process `GetObject-Range` requests. This parameter is required.

Returns:

this

build

public AccessPoint build()