# README
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 "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
import s3objectlambda "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
stack := cdk.NewStack()
bucket := s3.NewBucket(stack, jsii.String("MyBucket"))
handler := lambda.NewFunction(stack, jsii.String("MyFunction"), &functionProps{
Runtime: lambda.Runtime_NODEJS_14_X(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(jsii.String("lambda.zip")),
})
s3objectlambda.NewAccessPoint(stack, jsii.String("MyObjectLambda"), &AccessPointProps{
Bucket: Bucket,
Handler: Handler,
AccessPointName: jsii.String("my-access-point"),
Payload: map[string]interface{}{
"prop": jsii.String("value"),
},
})
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 "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
import s3objectlambda "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
stack := cdk.NewStack()
bucket := s3.NewBucket(stack, jsii.String("MyBucket"))
handler := lambda.NewFunction(stack, jsii.String("MyFunction"), &functionProps{
Runtime: lambda.Runtime_NODEJS_14_X(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(jsii.String("lambda.zip")),
})
s3objectlambda.NewAccessPoint(stack, jsii.String("MyObjectLambda"), &AccessPointProps{
Bucket: Bucket,
Handler: Handler,
AccessPointName: jsii.String("my-access-point"),
SupportsGetObjectRange: jsii.Boolean(true),
SupportsGetObjectPartNumber: jsii.Boolean(true),
})
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 "github.com/aws/aws-cdk-go/awscdk"
import s3 "github.com/aws/aws-cdk-go/awscdk"
import s3objectlambda "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
stack := cdk.NewStack()
bucket := s3.NewBucket(stack, jsii.String("MyBucket"))
handler := lambda.NewFunction(stack, jsii.String("MyFunction"), &functionProps{
Runtime: lambda.Runtime_NODEJS_14_X(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(jsii.String("lambda.zip")),
})
s3objectlambda.NewAccessPoint(stack, jsii.String("MyObjectLambda"), &AccessPointProps{
Bucket: Bucket,
Handler: Handler,
AccessPointName: jsii.String("my-access-point"),
Payload: map[string]interface{}{
"prop": jsii.String("value"),
},
})
# Functions
Reference an existing AccessPoint defined outside of the CDK code.
Return whether the given object is a Construct.
Check whether the given construct is a Resource.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Return whether the given object is a Construct.
Experimental.
Experimental.
Create a new `AWS::S3ObjectLambda::AccessPoint`.
Create a new `AWS::S3ObjectLambda::AccessPoint`.
Create a new `AWS::S3ObjectLambda::AccessPointPolicy`.
Create a new `AWS::S3ObjectLambda::AccessPointPolicy`.
# Structs
The access point resource attributes.
The S3 object lambda access point configuration.
The alias of an Object Lambda Access Point.
Example: // The code below shows an example of how to instantiate this type.
Example: // The code below shows an example of how to instantiate this type.
A configuration used when creating an Object Lambda Access Point.
Indicates whether this access point policy is public.
The `PublicAccessBlock` configuration that you want to apply to this Amazon S3 account.
A configuration used when creating an Object Lambda Access Point transformation.
Properties for defining a `CfnAccessPointPolicy`.
Properties for defining a `CfnAccessPoint`.
# Interfaces
An S3 object lambda access point for intercepting and transforming `GetObject` requests.
A CloudFormation `AWS::S3ObjectLambda::AccessPoint`.
A CloudFormation `AWS::S3ObjectLambda::AccessPointPolicy`.
The interface that represents the AccessPoint resource.