Interface AccessPointProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AccessPointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:41.200Z")
@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.*; 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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forAccessPointProps
static final class
An implementation forAccessPointProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic AccessPointProps.Builder
builder()
default String
(experimental) The name of the S3 object lambda access point.(experimental) The bucket to which this access point belongs.default Boolean
(experimental) Whether CloudWatch metrics are enabled for the access point.(experimental) The Lambda function used to transform objects.(experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.default Boolean
(experimental) Whether the Lambda function can processGetObject-PartNumber
requests.default Boolean
(experimental) Whether the Lambda function can processGetObject-Range
requests.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBucket
(experimental) The bucket to which this access point belongs. -
getHandler
(experimental) The Lambda function used to transform objects. -
getAccessPointName
(experimental) The name of the S3 object lambda access point.Default: a unique name will be generated
-
getCloudWatchMetricsEnabled
(experimental) Whether CloudWatch metrics are enabled for the access point.Default: false
-
getPayload
(experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.Default: - No data.
-
getSupportsGetObjectPartNumber
(experimental) Whether the Lambda function can processGetObject-PartNumber
requests.Default: false
-
getSupportsGetObjectRange
(experimental) Whether the Lambda function can processGetObject-Range
requests.Default: false
-
builder
- Returns:
- a
AccessPointProps.Builder
ofAccessPointProps
-