@aws-cdk/aws-s3objectlambda-alpha.AccessPointProps

Experimental

@aws-cdk/aws-s3objectlambda-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AccessPointProps Struct

The S3 object lambda access point configuration.

AccessPointProps

used as props by

• AccessPoint

Stability

Experimental

Source

lib/access-point.ts

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as s3objectlambda from '@aws-cdk/aws-s3objectlambda-alpha';
import * as cdk from 'aws-cdk-lib';

const stack = new cdk.Stack();
const bucket = new s3.Bucket(stack, 'MyBucket');
const handler = new lambda.Function(stack, 'MyFunction', {
	runtime: lambda.Runtime.NODEJS_LATEST,
	handler: 'index.handler',
	code: lambda.Code.fromAsset('lambda.zip'),
});
new s3objectlambda.AccessPoint(stack, 'MyObjectLambda', {
	bucket,
	handler,
	accessPointName: 'my-access-point',
	payload: {
		prop: "value",
	},
});

Properties

accessPointName?optionalstringaccess_point_name?optionalstraccessPointName?optionalStringAccessPointName?optionalstringAccessPointName?optional*string#

The name of the S3 object lambda access point.

Default: a unique name will be generated

bucketIBucketRefbucketIBucketRefbucketIBucketRefBucketIBucketRefBucketIBucketRefrequired#

The bucket to which this access point belongs.

cloudWatchMetricsEnabled?optionalbooleancloud_watch_metrics_enabled?optionalboolcloudWatchMetricsEnabled?optionalBooleanCloudWatchMetricsEnabled?optionalboolCloudWatchMetricsEnabled?optional*bool= false#

Whether CloudWatch metrics are enabled for the access point.

handlerIFunctionhandlerIFunctionhandlerIFunctionHandlerIFunctionHandlerIFunctionrequired#

The Lambda function used to transform objects.

payload?optional{ [key: string]: any }payload?optionaltyping.Mapping[str, Any]payload?optionalMap<String, Object>Payload?optionalIDictionary<string, object>Payload?optional*map[string]interface{}#

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

Default: No data.

supportsGetObjectPartNumber?optionalbooleansupports_get_object_part_number?optionalboolsupportsGetObjectPartNumber?optionalBooleanSupportsGetObjectPartNumber?optionalboolSupportsGetObjectPartNumber?optional*bool= false#

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

supportsGetObjectRange?optionalbooleansupports_get_object_range?optionalboolsupportsGetObjectRange?optionalBooleanSupportsGetObjectRange?optionalboolSupportsGetObjectRange?optional*bool= false#

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