Package software.amazon.awssdk.services.s3.model

Interface CreateBucketConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>, SdkBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>, SdkPojo

Enclosing class:

CreateBucketConfiguration

@Mutable
@NotThreadSafe
public static interface CreateBucketConfiguration.Builder
extends SdkPojo, CopyableBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>

Method Summary

Modifier and Type	Method	Description
default CreateBucketConfiguration.Builder	bucket(Consumer<BucketInfo.Builder> bucket)	Specifies the information about the bucket that will be created.
CreateBucketConfiguration.Builder	bucket(BucketInfo bucket)	Specifies the information about the bucket that will be created.
default CreateBucketConfiguration.Builder	location(Consumer<LocationInfo.Builder> location)	Specifies the location where the bucket will be created.
CreateBucketConfiguration.Builder	location(LocationInfo location)	Specifies the location where the bucket will be created.
CreateBucketConfiguration.Builder	locationConstraint(String locationConstraint)	Specifies the Region where the bucket will be created.
CreateBucketConfiguration.Builder	locationConstraint(BucketLocationConstraint locationConstraint)	Specifies the Region where the bucket will be created.
CreateBucketConfiguration.Builder	tags(Collection<Tag> tags)	An array of tags that you can apply to the bucket that you're creating.
CreateBucketConfiguration.Builder	tags(Consumer<Tag.Builder>... tags)	An array of tags that you can apply to the bucket that you're creating.
CreateBucketConfiguration.Builder	tags(Tag... tags)	An array of tags that you can apply to the bucket that you're creating.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

locationConstraint

CreateBucketConfiguration.Builder locationConstraint(String locationConstraint)

Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value EU will create a bucket in eu-west-1.

For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

This functionality is not supported for directory buckets.

Parameters:

locationConstraint - Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value EU will create a bucket in eu-west-1.

For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

This functionality is not supported for directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BucketLocationConstraint, BucketLocationConstraint

locationConstraint

CreateBucketConfiguration.Builder locationConstraint(BucketLocationConstraint locationConstraint)

Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value EU will create a bucket in eu-west-1.

For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

This functionality is not supported for directory buckets.

Parameters:

locationConstraint - Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.

If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value EU will create a bucket in eu-west-1.

For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

This functionality is not supported for directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BucketLocationConstraint, BucketLocationConstraint

location

CreateBucketConfiguration.Builder location(LocationInfo location)

Specifies the location where the bucket will be created.

Directory buckets - The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP 403 Forbidden error with the error code AccessDenied. To learn more, see Enable accounts for Local Zones in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

Parameters:

location - Specifies the location where the bucket will be created.

Directory buckets - The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP 403 Forbidden error with the error code AccessDenied. To learn more, see Enable accounts for Local Zones in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

location

default CreateBucketConfiguration.Builder location(Consumer<LocationInfo.Builder> location)

Specifies the location where the bucket will be created.

Directory buckets - The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP 403 Forbidden error with the error code AccessDenied. To learn more, see Enable accounts for Local Zones in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

This is a convenience method that creates an instance of the LocationInfo.Builder avoiding the need to create one manually via LocationInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(LocationInfo).

Parameters:

location - a consumer that will call methods on LocationInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

location(LocationInfo)

bucket

CreateBucketConfiguration.Builder bucket(BucketInfo bucket)

Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

Parameters:

bucket - Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

Returns:

Returns a reference to this object so that method calls can be chained together.

bucket

default CreateBucketConfiguration.Builder bucket(Consumer<BucketInfo.Builder> bucket)

Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

This is a convenience method that creates an instance of the BucketInfo.Builder avoiding the need to create one manually via BucketInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bucket(BucketInfo).

Parameters:

bucket - a consumer that will call methods on BucketInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bucket(BucketInfo)

tags

CreateBucketConfiguration.Builder tags(Collection<Tag> tags)

An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.

• This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

• You must have the s3express:TagResource permission to create a directory bucket with tags.

Parameters:

tags - An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.

• This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

• You must have the s3express:TagResource permission to create a directory bucket with tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateBucketConfiguration.Builder tags(Tag... tags)

An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.

• This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

• You must have the s3express:TagResource permission to create a directory bucket with tags.

Parameters:

tags - An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.

• This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

• You must have the s3express:TagResource permission to create a directory bucket with tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateBucketConfiguration.Builder tags(Consumer<Tag.Builder>... tags)

An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.

• This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.

• You must have the s3express:TagResource permission to create a directory bucket with tags.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)