Experimental

@aws-cdk/aws-s3objectlambda-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AccessPoint L2 construct

An S3 object lambda access point for intercepting and transforming GetObject requests.

Stability: Experimental
Source: lib/access-point.ts

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",
	},
});

python

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"
    }
)

java

import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.s3.*;
import software.amazon.awscdk.services.s3objectlambda.alpha.*;
import software.amazon.awscdk.*;

Stack stack = new Stack();
Bucket bucket = new Bucket(stack, "MyBucket");
Function handler = Function.Builder.create(stack, "MyFunction")
        .runtime(Runtime.NODEJS_LATEST)
        .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();

csharp

// Install: dotnet add package Amazon.CDK.AWS.S3ObjectLambda.Alpha
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.AWS.S3ObjectLambda.Alpha;
using Amazon.CDK;

var stack = new Stack();
var bucket = new Bucket(stack, "MyBucket");
var handler = new Function(stack, "MyFunction", new FunctionProps {
    Runtime = Runtime.NODEJS_LATEST,
    Handler = "index.handler",
    Code = Code.FromAsset("lambda.zip")
});
new AccessPoint(stack, "MyObjectLambda", new AccessPointProps {
    Bucket = bucket,
    Handler = handler,
    AccessPointName = "my-access-point",
    Payload = new Dictionary<string, object> {
        { "prop", "value" }
    }
});

// Install: go get github.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2
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/awscdks3objectlambdaalpha"
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_LATEST(),
	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"),
	},
})

Initializer

new AccessPoint(scope: Construct, id: string, props: AccessPointProps)

python

AccessPoint(scope: Construct, id: str, props: AccessPointProps)

java

new AccessPoint(Construct scope, String id, AccessPointProps props)

csharp

new AccessPoint(Construct scope, string id, AccessPointProps props)

NewAccessPoint(Scope Construct, Id *string, Props AccessPointProps)

Construct Props

accessPointNamestringaccess_point_namestraccessPointNameStringAccessPointNamestringAccessPointName*string= a unique name will be generated#

The name of the S3 object lambda access point.

bucketIBucketRefbucketIBucketRefbucketIBucketRefBucketIBucketRefBucketIBucketRefrequired#

The bucket to which this access point belongs.

cloudWatchMetricsEnabledbooleancloud_watch_metrics_enabledboolcloudWatchMetricsEnabledBooleanCloudWatchMetricsEnabledboolCloudWatchMetricsEnabled*bool= false#

Whether CloudWatch metrics are enabled for the access point.

handlerIFunctionhandlerIFunctionhandlerIFunctionHandlerIFunctionHandlerIFunctionrequired#

The Lambda function used to transform objects.

payload{ [key: string]: any }payloadtyping.Mapping[str, Any]payloadMap<String, Object>PayloadIDictionary<string, object>Payload*map[string]interface{}= No data.#

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

supportsGetObjectPartNumberbooleansupports_get_object_part_numberboolsupportsGetObjectPartNumberBooleanSupportsGetObjectPartNumberboolSupportsGetObjectPartNumber*bool= false#

Whether the Lambda function can process `GetObject-PartNumber` requests.

supportsGetObjectRangebooleansupports_get_object_rangeboolsupportsGetObjectRangeBooleanSupportsGetObjectRangeboolSupportsGetObjectRange*bool= false#

Whether the Lambda function can process `GetObject-Range` requests.

Properties

accessPointArnstringaccess_point_arnstraccessPointArnStringAccessPointArnstringAccessPointArn*stringrequired#

The ARN of the access point.

accessPointCreationDatestringaccess_point_creation_datestraccessPointCreationDateStringAccessPointCreationDatestringAccessPointCreationDate*stringrequired#

The creation data of the access point.

accessPointNamestringaccess_point_namestraccessPointNameStringAccessPointNamestringAccessPointName*stringrequired#

The ARN of the access point.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#

Implement the `IAccessPoint.domainName` field.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

regionalDomainNamestringregional_domain_namestrregionalDomainNameStringRegionalDomainNamestringRegionalDomainName*stringrequired#

Implement the `IAccessPoint.regionalDomainName` field.

s3AccessPointArnstrings3_access_point_arnstrs3AccessPointArnStringS3AccessPointArnstringS3AccessPointArn*stringrequired#

The ARN of the S3 access point.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromAccessPointAttributes(scope: Construct, id: string, attrs: AccessPointAttributes): IAccessPoint@staticmethod def from_access_point_attributes(scope: Construct, id: str, attrs: AccessPointAttributes) -> IAccessPointpublic static IAccessPoint fromAccessPointAttributes(Construct scope, String id, AccessPointAttributes attrs)public static IAccessPoint FromAccessPointAttributes(Construct scope, string id, AccessPointAttributes attrs)func FromAccessPointAttributes(Scope Construct, Id *string, Attrs AccessPointAttributes) IAccessPointstatic#

Reference an existing AccessPoint defined outside of the CDK code.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string

def virtual_hosted_url_for_object(self, key: typing.Optional[str] = None, options: typing.Optional[VirtualHostedStyleUrlOptions] = None) -> str

public String virtualHostedUrlForObject(String key, VirtualHostedStyleUrlOptions options)public string VirtualHostedUrlForObject(string? key = null, VirtualHostedStyleUrlOptions? options = null)func VirtualHostedUrlForObject(Key *string, Options VirtualHostedStyleUrlOptions) *string#

Implement the `IAccessPoint.virtualHostedUrlForObject` method.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

AccessPoint L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​