software.amazon.awscdk.services.s3objectlambda.alpha

Class AccessPoint.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AccessPoint>

Enclosing class:

AccessPoint

@Stability(value=Experimental)
public static final class AccessPoint.Builder
extends Object
implements software.amazon.jsii.Builder<AccessPoint>

(experimental) A fluent builder for AccessPoint.

Method Summary

Modifier and Type	Method and Description
AccessPoint.Builder	accessPointName(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(Boolean cloudWatchMetricsEnabled) (experimental) Whether CloudWatch metrics are enabled for the access point.
static AccessPoint.Builder	create(software.constructs.Construct scope, String id)
AccessPoint.Builder	handler(IFunction handler) (experimental) The Lambda function used to transform objects.
AccessPoint.Builder	payload(Map<String,? extends Object> payload) (experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.
AccessPoint.Builder	supportsGetObjectPartNumber(Boolean supportsGetObjectPartNumber) (experimental) Whether the Lambda function can process `GetObject-PartNumber` requests.
AccessPoint.Builder	supportsGetObjectRange(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

@Stability(value=Experimental)
public static AccessPoint.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AccessPoint.Builder.

bucket

@Stability(value=Experimental)
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

@Stability(value=Experimental)
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

@Stability(value=Experimental)
public AccessPoint.Builder accessPointName(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

@Stability(value=Experimental)
public AccessPoint.Builder cloudWatchMetricsEnabled(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

@Stability(value=Experimental)
public AccessPoint.Builder payload(Map<String,? extends 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

@Stability(value=Experimental)
public AccessPoint.Builder supportsGetObjectPartNumber(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

@Stability(value=Experimental)
public AccessPoint.Builder supportsGetObjectRange(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

@Stability(value=Experimental)
public AccessPoint build()

Specified by:

build in interface software.amazon.jsii.Builder<AccessPoint>