Class AccessPoint.Builder
java.lang.Object
software.amazon.awscdk.services.s3objectlambda.AccessPoint.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<AccessPoint>
- Enclosing class:
- AccessPoint
@Stability(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 TypeMethodDescriptionaccessPointName
(String accessPointName) (experimental) The name of the S3 object lambda access point.(experimental) The bucket to which this access point belongs.build()
cloudWatchMetricsEnabled
(Boolean cloudWatchMetricsEnabled) (experimental) Whether CloudWatch metrics are enabled for the access point.static AccessPoint.Builder
(experimental) The Lambda function used to transform objects.(experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.supportsGetObjectPartNumber
(Boolean supportsGetObjectPartNumber) (experimental) Whether the Lambda function can processGetObject-PartNumber
requests.supportsGetObjectRange
(Boolean supportsGetObjectRange) (experimental) Whether the Lambda function can processGetObject-Range
requests.
-
Method Details
-
create
@Stability(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
(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
(experimental) The Lambda function used to transform objects.- Parameters:
handler
- The Lambda function used to transform objects. This parameter is required.- Returns:
this
-
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(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
(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(Experimental) public AccessPoint.Builder supportsGetObjectPartNumber(Boolean supportsGetObjectPartNumber) (experimental) Whether the Lambda function can processGetObject-PartNumber
requests.Default: false
- Parameters:
supportsGetObjectPartNumber
- Whether the Lambda function can processGetObject-PartNumber
requests. This parameter is required.- Returns:
this
-
supportsGetObjectRange
@Stability(Experimental) public AccessPoint.Builder supportsGetObjectRange(Boolean supportsGetObjectRange) (experimental) Whether the Lambda function can processGetObject-Range
requests.Default: false
- Parameters:
supportsGetObjectRange
- Whether the Lambda function can processGetObject-Range
requests. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AccessPoint>
- Returns:
- a newly built instance of
AccessPoint
.
-