Package 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:
IConstruct, IDependable, IResource, IAccessPoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.198Z") @Stability(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();

  • Constructor Details

    • AccessPoint

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

    • AccessPoint

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

    • AccessPoint

      @Stability(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 Details

    • fromAccessPointAttributes

      @Stability(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(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(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(Experimental) @NotNull public String virtualHostedUrlForObject()
      (experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.
      Specified by:
      virtualHostedUrlForObject in interface IAccessPoint
      Returns:
      an ObjectS3Url token

    • getAccessPointArn

      @Stability(Experimental) @NotNull public String getAccessPointArn()
      (experimental) The ARN of the access point.
      Specified by:
      getAccessPointArn in interface IAccessPoint

    • getAccessPointCreationDate

      @Stability(Experimental) @NotNull public String getAccessPointCreationDate()
      (experimental) The creation data of the access point.
      Specified by:
      getAccessPointCreationDate in interface IAccessPoint

    • getAccessPointName

      @Stability(Experimental) @NotNull public String getAccessPointName()
      (experimental) The ARN of the access point.

    • getDomainName

      @Stability(Experimental) @NotNull public String getDomainName()
      (experimental) Implement the IAccessPoint.domainName field.
      Specified by:
      getDomainName in interface IAccessPoint

    • getRegionalDomainName

      @Stability(Experimental) @NotNull public String getRegionalDomainName()
      (experimental) Implement the IAccessPoint.regionalDomainName field.
      Specified by:
      getRegionalDomainName in interface IAccessPoint