software.amazon.awscdk.services.s3objectlambda

Class AccessPoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.s3objectlambda.AccessPoint

All Implemented Interfaces:

IDependable, IResource, IAccessPoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:21.521Z")
 @Stability(value=Experimental)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	AccessPoint(software.constructs.Construct scope, String id, AccessPointProps props)
protected	AccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AccessPoint

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

AccessPoint

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

AccessPoint

@Stability(value=Experimental)
public AccessPoint(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  AccessPointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromAccessPointAttributes

@Stability(value=Experimental)
 @NotNull
public static IAccessPoint fromAccessPointAttributes(@NotNull
                                                                                              software.constructs.Construct scope,
                                                                                              @NotNull
                                                                                              String id,
                                                                                              @NotNull
                                                                                              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

@Stability(value=Experimental)
 @NotNull
public String virtualHostedUrlForObject(@Nullable
                                                                                 String key,
                                                                                 @Nullable
                                                                                 VirtualHostedStyleUrlOptions options)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Parameters:

key -

options -

Returns:

an ObjectS3Url token

virtualHostedUrlForObject

@Stability(value=Experimental)
 @NotNull
public String virtualHostedUrlForObject(@Nullable
                                                                                 String key)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Parameters:

key -

Returns:

an ObjectS3Url token

virtualHostedUrlForObject

@Stability(value=Experimental)
 @NotNull
public String virtualHostedUrlForObject()

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Returns:

an ObjectS3Url token

getAccessPointArn

@Stability(value=Experimental)
 @NotNull
public String getAccessPointArn()

(experimental) The ARN of the access point.

Specified by:

getAccessPointArn in interface IAccessPoint

getAccessPointCreationDate

@Stability(value=Experimental)
 @NotNull
public String getAccessPointCreationDate()

(experimental) The creation data of the access point.

Specified by:

getAccessPointCreationDate in interface IAccessPoint

getAccessPointName

@Stability(value=Experimental)
 @NotNull
public String getAccessPointName()

(experimental) The ARN of the access point.

getDomainName

@Stability(value=Experimental)
 @NotNull
public String getDomainName()

(experimental) Implement the IAccessPoint.domainName field.

Specified by:

getDomainName in interface IAccessPoint

getRegionalDomainName

@Stability(value=Experimental)
 @NotNull
public String getRegionalDomainName()

(experimental) Implement the IAccessPoint.regionalDomainName field.

Specified by:

getRegionalDomainName in interface IAccessPoint