Package software.amazon.awscdk.cfnpropertymixins.services.s3express

Interface CfnAccessPointMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessPointMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.790Z")
@Stability(Stable)
public interface CfnAccessPointMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnAccessPointPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3express.*;
 Object policy;
 CfnAccessPointMixinProps cfnAccessPointMixinProps = CfnAccessPointMixinProps.builder()
         .bucket("bucket")
         .bucketAccountId("bucketAccountId")
         .name("name")
         .policy(policy)
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .scope(ScopeProperty.builder()
                 .permissions(List.of("permissions"))
                 .prefixes(List.of("prefixes"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .vpcId("vpcId")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAccessPointMixinProps.Builder	builder()
default String	getBucket()	The name of the bucket that you want to associate the access point with.
default String	getBucketAccountId()	The AWS account ID that owns the bucket associated with this access point.
default String	getName()	An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 .
default Object	getPolicy()	The access point policy associated with the specified access point.
default Object	getPublicAccessBlockConfiguration()	Public access is blocked by default to access points for directory buckets.
default Object	getScope()	You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
default List<CfnTag>	getTags()	An array of tags that you can apply to access points.
default Object	getVpcConfiguration()	If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

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

The name of the bucket that you want to associate the access point with.

See Also:

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

getBucketAccountId

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

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

See Also:

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

getName

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

An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 .

For example, accesspointname--zoneID--xa-s3.

See Also:

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

getPolicy

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

The access point policy associated with the specified access point.

See Also:

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

getPublicAccessBlockConfiguration

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

Public access is blocked by default to access points for directory buckets.

Returns union: either IResolvable or CfnAccessPointPropsMixin.PublicAccessBlockConfigurationProperty

See Also:

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

getScope

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

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

For more information, see Manage the scope of your access points for directory buckets.

Returns union: either IResolvable or CfnAccessPointPropsMixin.ScopeProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of tags that you can apply to access points.

Tags are key-value pairs of metadata used to categorize your access points and control access. For more information, see Using tags for attribute-based access control (ABAC) .

See Also:

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

getVpcConfiguration

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

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

Returns union: either IResolvable or CfnAccessPointPropsMixin.VpcConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnAccessPointMixinProps.Builder of CfnAccessPointMixinProps