software.amazon.awscdk.services.s3

Interface CfnAccessPointProps

All Known Implementing Classes:

CfnAccessPointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.547Z")
public interface CfnAccessPointProps

Properties for defining a `CfnAccessPoint`.

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;
 CfnAccessPointProps cfnAccessPointProps = CfnAccessPointProps.builder()
         .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	Interface and Description
static class	CfnAccessPointProps.Builder A builder for CfnAccessPointProps
static class	CfnAccessPointProps.Jsii$Proxy An implementation for CfnAccessPointProps

Method Summary

Modifier and Type	Method and Description
static CfnAccessPointProps.Builder	builder()
java.lang.String	getBucket() The name of the bucket associated with this access point.
default java.lang.String	getBucketAccountId() The AWS account ID associated with the S3 bucket associated with this access point.
default java.lang.String	getName() The name of this access point.
default java.lang.Object	getPolicy() The access point policy associated with this access point.
default java.lang.Object	getPolicyStatus() The container element for a bucket's policy status.
default java.lang.Object	getPublicAccessBlockConfiguration() The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
default java.lang.Object	getVpcConfiguration() The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

Method Detail

getBucket

java.lang.String getBucket()

The name of the bucket associated with this access point.

getBucketAccountId

default java.lang.String getBucketAccountId()

The AWS account ID associated with the S3 bucket associated with this access point.

getName

default java.lang.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.

getPolicy

default java.lang.Object getPolicy()

The access point policy associated with this access point.

getPolicyStatus

default java.lang.Object getPolicyStatus()

The container element for a bucket's policy status.

getPublicAccessBlockConfiguration

default java.lang.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 .

getVpcConfiguration

default java.lang.Object getVpcConfiguration()

The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

builder

static CfnAccessPointProps.Builder builder()

Returns:

a CfnAccessPointProps.Builder of CfnAccessPointProps