Package software.amazon.awscdk.services.s3objectlambda

Class CfnAccessPoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3objectlambda.CfnAccessPoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAccessPointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.240Z") @Stability(Stable) public class CfnAccessPoint extends CfnResource implements IInspectable, IAccessPointRef
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3objectlambda.*;
 Object contentTransformation;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .objectLambdaConfiguration(ObjectLambdaConfigurationProperty.builder()
                 .supportingAccessPoint("supportingAccessPoint")
                 .transformationConfigurations(List.of(TransformationConfigurationProperty.builder()
                         .actions(List.of("actions"))
                         .contentTransformation(contentTransformation)
                         .build()))
                 // the properties below are optional
                 .allowedFeatures(List.of("allowedFeatures"))
                 .cloudWatchMetricsEnabled(false)
                 .build())
         // the properties below are optional
         .name("name")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccessPoint

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

    • CfnAccessPoint

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

    • CfnAccessPoint

      @Stability(Stable) public CfnAccessPoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAccessPointProps props)
      Create a new AWS::S3ObjectLambda::AccessPoint.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAccessPoint

      @Stability(Stable) @NotNull public static String arnForAccessPoint(@NotNull IAccessPointRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAccessPoint

      @Stability(Stable) @NotNull public static Boolean isCfnAccessPoint(@NotNull Object x)
      Checks whether the given object is a CfnAccessPoint.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAccessPointRef

      @Stability(Stable) @NotNull public AccessPointReference getAccessPointRef()
      A reference to a AccessPoint resource.
      Specified by:
      getAccessPointRef in interface IAccessPointRef

    • getAttrAlias

      @Stability(Stable) @NotNull public IResolvable getAttrAlias()

    • getAttrAliasStatus

      @Stability(Stable) @NotNull public String getAttrAliasStatus()
      The status of the Object Lambda Access Point alias.

      Valid Values: PROVISIONING | READY .

    • getAttrAliasValue

      @Stability(Stable) @NotNull public String getAttrAliasValue()
      The alias name value of the Object Lambda Access Point.

      For example: myolap-1a4n8yjrb3kda96f67zwrwiiuse1a--ol-s3 .

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Specifies the ARN for the Object Lambda Access Point.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The date and time when the specified Object Lambda Access Point was created.

    • getAttrPolicyStatus

      @Stability(Stable) @NotNull public IResolvable getAttrPolicyStatus()

    • getAttrPolicyStatusIsPublic

      @Stability(Stable) @NotNull public IResolvable getAttrPolicyStatusIsPublic()
      Specifies whether the Object lambda Access Point Policy is Public or not.

      Object lambda Access Points are private by default.

    • getAttrPublicAccessBlockConfiguration

      @Stability(Stable) @NotNull public IResolvable getAttrPublicAccessBlockConfiguration()
      The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point.

      All public access to Object lambda Access Points are blocked by default, and any policy that would give public access to them will be also blocked. This behavior cannot be changed for Object lambda Access Points.

    • getAttrPublicAccessBlockConfigurationBlockPublicAcls

      @Stability(Stable) @NotNull public IResolvable getAttrPublicAccessBlockConfigurationBlockPublicAcls()

    • getAttrPublicAccessBlockConfigurationBlockPublicPolicy

      @Stability(Stable) @NotNull public IResolvable getAttrPublicAccessBlockConfigurationBlockPublicPolicy()

    • getAttrPublicAccessBlockConfigurationIgnorePublicAcls

      @Stability(Stable) @NotNull public IResolvable getAttrPublicAccessBlockConfigurationIgnorePublicAcls()

    • getAttrPublicAccessBlockConfigurationRestrictPublicBuckets

      @Stability(Stable) @NotNull public IResolvable getAttrPublicAccessBlockConfigurationRestrictPublicBuckets()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getObjectLambdaConfiguration

      @Stability(Stable) @NotNull public Object getObjectLambdaConfiguration()
      A configuration used when creating an Object Lambda Access Point.

      Returns union: either IResolvable or CfnAccessPoint.ObjectLambdaConfigurationProperty

    • setObjectLambdaConfiguration

      @Stability(Stable) public void setObjectLambdaConfiguration(@NotNull IResolvable value)
      A configuration used when creating an Object Lambda Access Point.

    • setObjectLambdaConfiguration

      @Stability(Stable) public void setObjectLambdaConfiguration(@NotNull CfnAccessPoint.ObjectLambdaConfigurationProperty value)
      A configuration used when creating an Object Lambda Access Point.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of this access point.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of this access point.