Package software.amazon.awscdk.services.s3objectlambda

AWS::S3ObjectLambda Construct Library

See: Description

Interface Summary

Interface	Description
AccessPointAttributes	(experimental) The access point resource attributes.
AccessPointProps	(experimental) The S3 object lambda access point configuration.
CfnAccessPoint.ObjectLambdaConfigurationProperty	A configuration used when creating an Object Lambda Access Point.
CfnAccessPoint.TransformationConfigurationProperty	A configuration used when creating an Object Lambda Access Point transformation.
CfnAccessPointPolicyProps	Properties for defining a `CfnAccessPointPolicy`.
CfnAccessPointProps	Properties for defining a `CfnAccessPoint`.
IAccessPoint	(experimental) The interface that represents the AccessPoint resource.
IAccessPoint.Jsii$Default	Internal default implementation for IAccessPoint.

Class Summary

Class	Description
AccessPoint	(experimental) An S3 object lambda access point for intercepting and transforming `GetObject` requests.
AccessPoint.Builder	(experimental) A fluent builder for AccessPoint.
AccessPointAttributes.Builder	A builder for AccessPointAttributes
AccessPointAttributes.Jsii$Proxy	An implementation for AccessPointAttributes
AccessPointProps.Builder	A builder for AccessPointProps
AccessPointProps.Jsii$Proxy	An implementation for AccessPointProps
CfnAccessPoint	A CloudFormation `AWS::S3ObjectLambda::AccessPoint`.
CfnAccessPoint.Builder	A fluent builder for CfnAccessPoint.
CfnAccessPoint.ObjectLambdaConfigurationProperty.Builder	A builder for CfnAccessPoint.ObjectLambdaConfigurationProperty
CfnAccessPoint.ObjectLambdaConfigurationProperty.Jsii$Proxy	An implementation for CfnAccessPoint.ObjectLambdaConfigurationProperty
CfnAccessPoint.TransformationConfigurationProperty.Builder	A builder for CfnAccessPoint.TransformationConfigurationProperty
CfnAccessPoint.TransformationConfigurationProperty.Jsii$Proxy	An implementation for CfnAccessPoint.TransformationConfigurationProperty
CfnAccessPointPolicy	A CloudFormation `AWS::S3ObjectLambda::AccessPointPolicy`.
CfnAccessPointPolicy.Builder	A fluent builder for CfnAccessPointPolicy.
CfnAccessPointPolicyProps.Builder	A builder for CfnAccessPointPolicyProps
CfnAccessPointPolicyProps.Jsii$Proxy	An implementation for CfnAccessPointPolicyProps
CfnAccessPointProps.Builder	A builder for CfnAccessPointProps
CfnAccessPointProps.Jsii$Proxy	An implementation for CfnAccessPointProps
IAccessPoint.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Package software.amazon.awscdk.services.s3objectlambda Description

AWS::S3ObjectLambda Construct Library

This construct library allows you to define S3 object lambda access points.

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 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();
 

Handling range and part number requests

Lambdas are currently limited to only transforming GetObject requests. However, they can additionally support GetObject-Range and GetObject-PartNumber requests, which needs to be specified in the access point configuration:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 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")
         .supportsGetObjectRange(true)
         .supportsGetObjectPartNumber(true)
         .build();
 

Pass additional data to Lambda function

You can specify an additional object that provides supplemental data to the Lambda function used to transform objects. The data is delivered as a JSON payload to the Lambda:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 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();