Package software.amazon.awscdk.services.s3

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.s3.CfnAccessPoint
All Implemented Interfaces:
IInspectable, ITaggableV2, IAccessPointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:46.122Z") @Stability(Stable) public class CfnAccessPoint extends CfnResource implements IInspectable, IAccessPointRef, ITaggableV2
The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

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.s3.*;
 Object policy;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .bucket("bucket")
         // the properties below are optional
         .bucketAccountId("bucketAccountId")
         .name("name")
         .policy(policy)
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .vpcId("vpcId")
                 .build())
         .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)
      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

    • fromAccessPointArn

      @Stability(Stable) @NotNull public static IAccessPointRef fromAccessPointArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IAccessPointRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromAccessPointName

      @Stability(Stable) @NotNull public static IAccessPointRef fromAccessPointName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String accessPointName)
      Creates a new IAccessPointRef from a accessPointName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      accessPointName - 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 String getAttrAlias()
      The alias for this access point.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      This property contains the details of the ARN for the access point.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of this access point.

    • getAttrNetworkOrigin

      @Stability(Stable) @NotNull public String getAttrNetworkOrigin()
      Indicates whether this access point allows access from the internet.

      If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , and the access point doesn't allow access from the internet. Otherwise, NetworkOrigin is Internet , and the access point allows access from the internet, subject to the access point and bucket access policies.

      Allowed values : VPC | Internet

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getBucket

      @Stability(Stable) @NotNull public String getBucket()
      The name of the bucket associated with this access point.

    • setBucket

      @Stability(Stable) public void setBucket(@NotNull String value)
      The name of the bucket associated with this access point.

    • getBucketAccountId

      @Stability(Stable) @Nullable public String getBucketAccountId()
      The AWS account ID associated with the S3 bucket associated with this access point.

    • setBucketAccountId

      @Stability(Stable) public void setBucketAccountId(@Nullable String value)
      The AWS account ID associated with the S3 bucket associated with this 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.

    • getPolicy

      @Stability(Stable) @Nullable public Object getPolicy()
      The access point policy associated with this access point.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable Object value)
      The access point policy associated with this access point.

    • getPublicAccessBlockConfiguration

      @Stability(Stable) @Nullable public Object getPublicAccessBlockConfiguration()
      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.

      Returns union: either IResolvable or CfnAccessPoint.PublicAccessBlockConfigurationProperty

    • setPublicAccessBlockConfiguration

      @Stability(Stable) public void setPublicAccessBlockConfiguration(@Nullable IResolvable value)
      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.

    • setPublicAccessBlockConfiguration

      @Stability(Stable) public void setPublicAccessBlockConfiguration(@Nullable CfnAccessPoint.PublicAccessBlockConfigurationProperty value)
      The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of tags that you can apply to access points.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of tags that you can apply to access points.

    • getVpcConfiguration

      @Stability(Stable) @Nullable public Object getVpcConfiguration()
      The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

      Returns union: either IResolvable or CfnAccessPoint.VpcConfigurationProperty

    • setVpcConfiguration

      @Stability(Stable) public void setVpcConfiguration(@Nullable IResolvable value)
      The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

    • setVpcConfiguration

      @Stability(Stable) public void setVpcConfiguration(@Nullable CfnAccessPoint.VpcConfigurationProperty value)
      The Virtual Private Cloud (VPC) configuration for this access point, if one exists.