interface AccessPointProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.S3ObjectLambda.Alpha.AccessPointProps |
![]() | github.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2#AccessPointProps |
![]() | software.amazon.awscdk.services.s3objectlambda.alpha.AccessPointProps |
![]() | aws_cdk.aws_s3objectlambda_alpha.AccessPointProps |
![]() | @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_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
Name | Type | Description |
---|---|---|
bucket | IBucket | The bucket to which this access point belongs. |
handler | IFunction | The Lambda function used to transform objects. |
access | string | The name of the S3 object lambda access point. |
cloud | boolean | Whether 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. |
supports | boolean | Whether the Lambda function can process GetObject-PartNumber requests. |
supports | boolean | Whether 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.