Package software.amazon.awscdk.services.s3

Interface CfnAccessPointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessPointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:22.953Z")
@Stability(Stable)
public interface CfnAccessPointProps
extends software.amazon.jsii.JsiiSerializable

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;
 CfnAccessPointProps cfnAccessPointProps = CfnAccessPointProps.builder()
         .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())
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .vpcId("vpcId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccessPointProps.Builder	A builder for CfnAccessPointProps
static final class	CfnAccessPointProps.Jsii$Proxy	An implementation for CfnAccessPointProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The name of the bucket associated with this access point.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket

getBucketAccountId

@Stability(Stable)
@Nullable
default String getBucketAccountId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucketaccountid

getName

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name

getPolicy

@Stability(Stable)
@Nullable
default Object getPolicy()

The access point policy associated with this access point.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy

getPublicAccessBlockConfiguration

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration

getVpcConfiguration

@Stability(Stable)
@Nullable
default Object getVpcConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration

builder

@Stability(Stable)
static CfnAccessPointProps.Builder builder()

Returns:

a CfnAccessPointProps.Builder of CfnAccessPointProps