software.amazon.awscdk.services.s3objectlambda

Class AccessPoint

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.s3objectlambda.AccessPoint

All Implemented Interfaces:

IConstruct, IDependable, IResource, IAccessPoint

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:30.160Z")
public class AccessPoint
extends Resource
implements IAccessPoint

(experimental) An S3 object lambda access point for intercepting and transforming `GetObject` requests.

Example:

 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.s3objectlambda.*;
 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessPoint.Builder (experimental) A fluent builder for AccessPoint.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3objectlambda.IAccessPoint

IAccessPoint.Jsii$Default, IAccessPoint.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AccessPoint(software.amazon.jsii.JsiiObjectRef objRef)
	AccessPoint(software.constructs.Construct scope, java.lang.String id, AccessPointProps props)

Method Summary

Modifier and Type	Method and Description
static IAccessPoint	fromAccessPointAttributes(software.constructs.Construct scope, java.lang.String id, AccessPointAttributes attrs) (experimental) Reference an existing AccessPoint defined outside of the CDK code.
java.lang.String	getAccessPointArn() (experimental) The ARN of the access point.
java.lang.String	getAccessPointCreationDate() (experimental) The creation data of the access point.
java.lang.String	getAccessPointName() (experimental) The ARN of the access point.
java.lang.String	getDomainName() (experimental) Implement the IAccessPoint.domainName field.
java.lang.String	getRegionalDomainName() (experimental) Implement the IAccessPoint.regionalDomainName field.
java.lang.String	virtualHostedUrlForObject() (experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.
java.lang.String	virtualHostedUrlForObject(java.lang.String key) (experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.
java.lang.String	virtualHostedUrlForObject(java.lang.String key, VirtualHostedStyleUrlOptions options) (experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

AccessPoint

protected AccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

AccessPoint

protected AccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AccessPoint

public AccessPoint(software.constructs.Construct scope,
                   java.lang.String id,
                   AccessPointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAccessPointAttributes

public static IAccessPoint fromAccessPointAttributes(software.constructs.Construct scope,
                                                     java.lang.String id,
                                                     AccessPointAttributes attrs)

(experimental) Reference an existing AccessPoint defined outside of the CDK code.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

virtualHostedUrlForObject

public java.lang.String virtualHostedUrlForObject(java.lang.String key,
                                                  VirtualHostedStyleUrlOptions options)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Parameters:

key -

options -

Returns:

an ObjectS3Url token

virtualHostedUrlForObject

public java.lang.String virtualHostedUrlForObject(java.lang.String key)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Parameters:

key -

Returns:

an ObjectS3Url token

virtualHostedUrlForObject

public java.lang.String virtualHostedUrlForObject()

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Returns:

an ObjectS3Url token

getAccessPointArn

public java.lang.String getAccessPointArn()

(experimental) The ARN of the access point.

Specified by:

getAccessPointArn in interface IAccessPoint

getAccessPointCreationDate

public java.lang.String getAccessPointCreationDate()

(experimental) The creation data of the access point.

Specified by:

getAccessPointCreationDate in interface IAccessPoint

getAccessPointName

public java.lang.String getAccessPointName()

(experimental) The ARN of the access point.

getDomainName

public java.lang.String getDomainName()

(experimental) Implement the IAccessPoint.domainName field.

Specified by:

getDomainName in interface IAccessPoint

getRegionalDomainName

public java.lang.String getRegionalDomainName()

(experimental) Implement the IAccessPoint.regionalDomainName field.

Specified by:

getRegionalDomainName in interface IAccessPoint