java.lang.Object
- software.amazon.awssdk.services.s3.model.CreateBucketConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBucketConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>

The configuration information for the bucket.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateBucketConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BucketInfo`	`bucket()`	Specifies the information about the bucket that will be created.
`static CreateBucketConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`LocationInfo`	`location()`	Specifies the location where the bucket will be created.
`BucketLocationConstraint`	`locationConstraint()`	Specifies the Region where the bucket will be created.
`String`	`locationConstraintAsString()`	Specifies the Region where the bucket will be created.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateBucketConfiguration.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	An array of tags that you can apply to the bucket that you're creating.
`CreateBucketConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - locationConstraint
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, locationConstraint will return BucketLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationConstraintAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    BucketLocationConstraint
  - locationConstraintAsString
```
public final String locationConstraintAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, locationConstraint will return BucketLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationConstraintAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    BucketLocationConstraint
  - location
```
public final 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.
    
    Returns:
    
    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.
  - bucket
```
public final BucketInfo bucket()
```
    Specifies the information about the bucket that will be created.
    
    This functionality is only supported by directory buckets.
    
    Returns:
    
    Specifies the information about the bucket that will be created.
    
    This functionality is only supported by directory buckets.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateBucketConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBucketConfiguration.Builder,CreateBucketConfiguration>
  - builder
```
public static CreateBucketConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBucketConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateBucketConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

locationConstraint

locationConstraintAsString

location

bucket

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField