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

Class CfnAccessPointPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.s3express.CfnAccessPointPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessPointPropsMixin>

Enclosing class:

CfnAccessPointPropsMixin

@Stability(Stable)
public static final class CfnAccessPointPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccessPointPropsMixin>

A fluent builder for CfnAccessPointPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAccessPointPropsMixin.Builder	bucket(String bucket)	The name of the bucket that you want to associate the access point with.
CfnAccessPointPropsMixin.Builder	bucketAccountId(String bucketAccountId)	The AWS account ID that owns the bucket associated with this access point.
CfnAccessPointPropsMixin	build()
static CfnAccessPointPropsMixin.Builder	create()
static CfnAccessPointPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAccessPointPropsMixin.Builder	name(String name)	An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 .
CfnAccessPointPropsMixin.Builder	policy(Object policy)	The access point policy associated with the specified access point.
CfnAccessPointPropsMixin.Builder	publicAccessBlockConfiguration(CfnAccessPointPropsMixin.PublicAccessBlockConfigurationProperty publicAccessBlockConfiguration)	Public access is blocked by default to access points for directory buckets.
CfnAccessPointPropsMixin.Builder	publicAccessBlockConfiguration(IResolvable publicAccessBlockConfiguration)	Public access is blocked by default to access points for directory buckets.
CfnAccessPointPropsMixin.Builder	scope(CfnAccessPointPropsMixin.ScopeProperty scope)	You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
CfnAccessPointPropsMixin.Builder	scope(IResolvable scope)	You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
CfnAccessPointPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of tags that you can apply to access points.
CfnAccessPointPropsMixin.Builder	vpcConfiguration(CfnAccessPointPropsMixin.VpcConfigurationProperty vpcConfiguration)	If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
CfnAccessPointPropsMixin.Builder	vpcConfiguration(IResolvable vpcConfiguration)	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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccessPointPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAccessPointPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAccessPointPropsMixin.Builder create()

Returns:

a new instance of CfnAccessPointPropsMixin.Builder.

bucket

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder bucket(String bucket)

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

Parameters:

bucket - The name of the bucket that you want to associate the access point with. This parameter is required.

Returns:

this

See Also:

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

bucketAccountId

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder bucketAccountId(String bucketAccountId)

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

Parameters:

bucketAccountId - The AWS account ID that owns the bucket associated with this access point. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder name(String name)

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.

Parameters:

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

Returns:

this

See Also:

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

policy

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder policy(Object policy)

The access point policy associated with the specified access point.

Parameters:

policy - The access point policy associated with the specified access point. This parameter is required.

Returns:

this

See Also:

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

publicAccessBlockConfiguration

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder publicAccessBlockConfiguration(IResolvable publicAccessBlockConfiguration)

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

Parameters:

publicAccessBlockConfiguration - Public access is blocked by default to access points for directory buckets. This parameter is required.

Returns:

this

See Also:

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

publicAccessBlockConfiguration

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder publicAccessBlockConfiguration(CfnAccessPointPropsMixin.PublicAccessBlockConfigurationProperty publicAccessBlockConfiguration)

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

Parameters:

publicAccessBlockConfiguration - Public access is blocked by default to access points for directory buckets. This parameter is required.

Returns:

this

See Also:

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

scope

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder scope(IResolvable scope)

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.

Parameters:

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

Returns:

this

See Also:

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

scope

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder scope(CfnAccessPointPropsMixin.ScopeProperty scope)

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.

Parameters:

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

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - An array of tags that you can apply to access points. This parameter is required.

Returns:

this

See Also:

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

vpcConfiguration

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder vpcConfiguration(IResolvable vpcConfiguration)

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

Parameters:

vpcConfiguration - If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC). This parameter is required.

Returns:

this

See Also:

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

vpcConfiguration

@Stability(Stable)
public CfnAccessPointPropsMixin.Builder vpcConfiguration(CfnAccessPointPropsMixin.VpcConfigurationProperty vpcConfiguration)

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

Parameters:

vpcConfiguration - If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC). This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccessPointPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccessPointPropsMixin>

Returns:

a newly built instance of CfnAccessPointPropsMixin.