@aws-cdk_aws-s3objectlambda-alpha.AccessPointProps

interface AccessPointProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.S3ObjectLambda.Alpha.AccessPointProps
Gogithub.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2#AccessPointProps
Javasoftware.amazon.awscdk.services.s3objectlambda.alpha.AccessPointProps
Pythonaws_cdk.aws_s3objectlambda_alpha.AccessPointProps
TypeScript (source)@aws-cdk/aws-s3objectlambda-alpha ยป AccessPointProps

The S3 object lambda access point configuration.

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_14_X,
    handler: 'index.handler',
    code: lambda.Code.fromAsset('lambda.zip'),
});
new s3objectlambda.AccessPoint(stack, 'MyObjectLambda', {
    bucket,
    handler,
    accessPointName: 'my-access-point',
    payload: {
        prop: "value",
    },
});

Properties

NameTypeDescription
bucket๐Ÿ”นIBucketThe bucket to which this access point belongs.
handler๐Ÿ”นIFunctionThe Lambda function used to transform objects.
accessPointName?๐Ÿ”นstringThe name of the S3 object lambda access point.
cloudWatchMetricsEnabled?๐Ÿ”นbooleanWhether CloudWatch metrics are enabled for the access point.
payload?๐Ÿ”น{ [string]: any }Additional JSON that provides supplemental data passed to the Lambda function on every request.
supportsGetObjectPartNumber?๐Ÿ”นbooleanWhether the Lambda function can process GetObject-PartNumber requests.
supportsGetObjectRange?๐Ÿ”นbooleanWhether the Lambda function can process GetObject-Range requests.

bucket๐Ÿ”น

Type: IBucket

The bucket to which this access point belongs.


handler๐Ÿ”น

Type: IFunction

The Lambda function used to transform objects.


accessPointName?๐Ÿ”น

Type: string (optional, default: a unique name will be generated)

The name of the S3 object lambda access point.


cloudWatchMetricsEnabled?๐Ÿ”น

Type: boolean (optional, default: false)

Whether CloudWatch metrics are enabled for the access point.


payload?๐Ÿ”น

Type: { [string]: any } (optional, default: No data.)

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


supportsGetObjectPartNumber?๐Ÿ”น

Type: boolean (optional, default: false)

Whether the Lambda function can process GetObject-PartNumber requests.


supportsGetObjectRange?๐Ÿ”น

Type: boolean (optional, default: false)

Whether the Lambda function can process GetObject-Range requests.