AccessPointProps

class aws_cdk.aws_s3objectlambda_alpha.AccessPointProps(*, bucket, handler, access_point_name=None, cloud_watch_metrics_enabled=None, payload=None, supports_get_object_part_number=None, supports_get_object_range=None)

Bases: object

(experimental) The S3 object lambda access point configuration.

Parameters:

bucket (IBucket) – (experimental) The bucket to which this access point belongs.
handler (IFunction) – (experimental) The Lambda function used to transform objects.
access_point_name (Optional[str]) – (experimental) The name of the S3 object lambda access point. Default: a unique name will be generated
cloud_watch_metrics_enabled (Optional[bool]) – (experimental) Whether CloudWatch metrics are enabled for the access point. Default: false
payload (Optional[Mapping[str, Any]]) – (experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request. Default: - No data.
supports_get_object_part_number (Optional[bool]) – (experimental) Whether the Lambda function can process GetObject-PartNumber requests. Default: false
supports_get_object_range (Optional[bool]) – (experimental) Whether the Lambda function can process GetObject-Range requests. Default: false

Stability:

experimental

ExampleMetadata:

infused

Example:

import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_s3 as s3
import aws_cdk.aws_s3objectlambda_alpha as s3objectlambda
import aws_cdk as cdk

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

Attributes

access_point_name

(experimental) The name of the S3 object lambda access point.

Default:: a unique name will be generated
Stability:: experimental

bucket

(experimental) The bucket to which this access point belongs.

Stability:: experimental

cloud_watch_metrics_enabled

(experimental) Whether CloudWatch metrics are enabled for the access point.

Default:: false
Stability:: experimental

handler

(experimental) The Lambda function used to transform objects.

Stability:: experimental

payload

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

Default:

No data.

Stability:

experimental

supports_get_object_part_number

(experimental) Whether the Lambda function can process GetObject-PartNumber requests.

Default:: false
Stability:: experimental

supports_get_object_range

(experimental) Whether the Lambda function can process GetObject-Range requests.

Default:: false
Stability:: experimental