Package software.amazon.awscdk.services.s3

Class CfnAccessPoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.s3.CfnAccessPoint
All Implemented Interfaces:
software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:09.196Z") @Stability(Stable) public class CfnAccessPoint extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.IInspectable
A CloudFormation `AWS::S3::AccessPoint`.

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnAccessPoint.Builder
    A fluent builder for CfnAccessPoint.
    static interface 
    CfnAccessPoint.PolicyStatusProperty
    Example:
    static interface 
    CfnAccessPoint.PublicAccessBlockConfigurationProperty
    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
    static interface 
    CfnAccessPoint.VpcConfigurationProperty
    The Virtual Private Cloud (VPC) configuration for this access point.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

    software.amazon.awscdk.core.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

    software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.IInspectable.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CFN_RESOURCE_TYPE_NAME
    The CloudFormation resource type name for this resource class.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnAccessPoint(software.amazon.awscdk.core.Construct scope, String id, CfnAccessPointProps props)
    Create a new `AWS::S3::AccessPoint`.
    protected
    CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttrAlias()
    The alias for this access point.
    String
    getAttrArn()
    This property contains the details of the ARN for the access point.
    String
    getAttrName()
    The name of this access point.
    String
    getAttrNetworkOrigin()
    Indicates whether this access point allows access from the internet.
    String
    getBucket()
    The name of the bucket associated with this access point.
    String
    getBucketAccountId()
    The AWS account ID associated with the S3 bucket associated with this access point.
    protected Map<String,Object>
    getCfnProperties()
     
    String
    getName()
    The name of this access point.
    Object
    getPolicy()
    The access point policy associated with this access point.
    Object
    getPolicyStatus()
    `AWS::S3::AccessPoint.PolicyStatus`.
    Object
    getPublicAccessBlockConfiguration()
    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
    Object
    getVpcConfiguration()
    The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
    void
    inspect(software.amazon.awscdk.core.TreeInspector inspector)
    Examines the CloudFormation resource and discloses attributes.
    protected Map<String,Object>
    renderProperties(Map<String,Object> props)
     
    void
    setBucket(String value)
    The name of the bucket associated with this access point.
    void
    setBucketAccountId(String value)
    The AWS account ID associated with the S3 bucket associated with this access point.
    void
    setName(String value)
    The name of this access point.
    void
    setPolicy(Object value)
    The access point policy associated with this access point.
    void
    setPolicyStatus(Object value)
    `AWS::S3::AccessPoint.PolicyStatus`.
    void
    setPublicAccessBlockConfiguration(software.amazon.awscdk.core.IResolvable value)
    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
    void
    setPublicAccessBlockConfiguration(CfnAccessPoint.PublicAccessBlockConfigurationProperty value)
    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
    void
    setVpcConfiguration(software.amazon.awscdk.core.IResolvable value)
    The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
    void
    setVpcConfiguration(CfnAccessPoint.VpcConfigurationProperty value)
    The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

    Methods inherited from class software.amazon.awscdk.core.CfnResource

    addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

    Methods inherited from class software.amazon.awscdk.core.CfnRefElement

    getRef

    Methods inherited from class software.amazon.awscdk.core.CfnElement

    getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

    Methods inherited from class software.amazon.awscdk.core.Construct

    getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

    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.jsii.JsiiSerializable

    $jsii$toJson

  • 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.amazon.awscdk.core.Construct scope, @NotNull String id, @NotNull CfnAccessPointProps props)
      Create a new `AWS::S3::AccessPoint`.

      Parameters:
      scope - - scope in which this resource is defined. This parameter is required.
      id - - scoped id of the resource. This parameter is required.
      props - - resource properties. This parameter is required.

  • Method Details

    • inspect

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

      Specified by:
      inspect in interface software.amazon.awscdk.core.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 software.amazon.awscdk.core.CfnResource
      Parameters:
      props - This parameter is required.

    • 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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class software.amazon.awscdk.core.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.

    • getPolicy

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

    • setPolicy

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

    • getPolicyStatus

      @Stability(Stable) @NotNull public Object getPolicyStatus()
      `AWS::S3::AccessPoint.PolicyStatus`.

    • setPolicyStatus

      @Stability(Stable) public void setPolicyStatus(@NotNull Object value)
      `AWS::S3::AccessPoint.PolicyStatus`.

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

      If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

    • setName

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

      If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

    • getPublicAccessBlockConfiguration

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

      You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide .

    • setPublicAccessBlockConfiguration

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

      You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide .

    • setPublicAccessBlockConfiguration

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

      You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide .

    • getVpcConfiguration

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

    • setVpcConfiguration

      @Stability(Stable) public void setVpcConfiguration(@Nullable software.amazon.awscdk.core.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.