Package software.amazon.awscdk.services.s3outposts

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.s3outposts.CfnAccessPoint
All Implemented Interfaces:
IInspectable, IAccessPointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.869Z") @Stability(Stable) public class CfnAccessPoint extends CfnResource implements IInspectable, IAccessPointRef
The AWS::S3Outposts::AccessPoint resource specifies an access point and associates it with the specified Amazon S3 on Outposts bucket.

For more information, see Managing data access with Amazon S3 access points .

S3 on Outposts supports only VPC-style access points.

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.s3outposts.*;
 Object policy;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .bucket("bucket")
         .name("name")
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .vpcId("vpcId")
                 .build())
         // the properties below are optional
         .policy(policy)
         .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

    • 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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      This resource contains the details of the S3 on Outposts bucket access point ARN.

      This resource is read-only.

    • getCfnProperties

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

    • getBucket

      @Stability(Stable) @NotNull public String getBucket()
      The Amazon Resource Name (ARN) of the S3 on Outposts bucket that is associated with this access point.

    • setBucket

      @Stability(Stable) public void setBucket(@NotNull String value)
      The Amazon Resource Name (ARN) of the S3 on Outposts bucket that is associated with this access point.

    • getName

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

    • setName

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

    • getVpcConfiguration

      @Stability(Stable) @NotNull 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(@NotNull IResolvable value)
      The virtual private cloud (VPC) configuration for this access point, if one exists.

    • setVpcConfiguration

      @Stability(Stable) public void setVpcConfiguration(@NotNull CfnAccessPoint.VpcConfigurationProperty value)
      The virtual private cloud (VPC) configuration for this access point, if one exists.

    • 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.