java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.CreateBucketRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBucketRequest
extends S3Request
implements ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateBucketRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BucketCannedACL`	`acl()`	The canned ACL to apply to the bucket.
`String`	`aclAsString()`	The canned ACL to apply to the bucket.
`String`	`bucket()`	The name of the bucket to create.
`static CreateBucketRequest.Builder`	`builder()`
`CreateBucketConfiguration`	`createBucketConfiguration()`	The configuration information for the bucket.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grantFullControl()`	Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
`String`	`grantRead()`	Allows grantee to list the objects in the bucket.
`String`	`grantReadACP()`	Allows grantee to read the bucket ACL.
`String`	`grantWrite()`	Allows grantee to create new objects in the bucket.
`String`	`grantWriteACP()`	Allows grantee to write the ACL for the applicable bucket.
`int`	`hashCode()`
`Boolean`	`objectLockEnabledForBucket()`	Specifies whether you want S3 Object Lock to be enabled for the new bucket.
`ObjectOwnership`	`objectOwnership()`	Returns the value of the ObjectOwnership property for this object.
`String`	`objectOwnershipAsString()`	Returns the value of the ObjectOwnership property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateBucketRequest.Builder>`	`serializableBuilderClass()`
`CreateBucketRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - acl
```
public final BucketCannedACL acl()
```
    The canned ACL to apply to the bucket.
    
    This functionality is not supported for directory buckets.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    BucketCannedACL
  - aclAsString
```
public final String aclAsString()
```
    The canned ACL to apply to the bucket.
    
    This functionality is not supported for directory buckets.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    BucketCannedACL
  - bucket
```
public final String bucket()
```
    The name of the bucket to create.
    
    General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.
    
    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
    
    Returns:
    
    The name of the bucket to create.
    
    General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.
    
    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
  - createBucketConfiguration
```
public final CreateBucketConfiguration createBucketConfiguration()
```
    The configuration information for the bucket.
    
    Returns:
    
    The configuration information for the bucket.
  - grantFullControl
```
public final String grantFullControl()
```
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
    
    This functionality is not supported for directory buckets.
  - grantRead
```
public final String grantRead()
```
    Allows grantee to list the objects in the bucket.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Allows grantee to list the objects in the bucket.
    
    This functionality is not supported for directory buckets.
  - grantReadACP
```
public final String grantReadACP()
```
    Allows grantee to read the bucket ACL.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Allows grantee to read the bucket ACL.
    
    This functionality is not supported for directory buckets.
  - grantWrite
```
public final String grantWrite()
```
    Allows grantee to create new objects in the bucket.
    
    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Allows grantee to create new objects in the bucket.
    
    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
    
    This functionality is not supported for directory buckets.
  - grantWriteACP
```
public final String grantWriteACP()
```
    Allows grantee to write the ACL for the applicable bucket.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Allows grantee to write the ACL for the applicable bucket.
    
    This functionality is not supported for directory buckets.
  - objectLockEnabledForBucket
```
public final Boolean objectLockEnabledForBucket()
```
    Specifies whether you want S3 Object Lock to be enabled for the new bucket.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Specifies whether you want S3 Object Lock to be enabled for the new bucket.
    
    This functionality is not supported for directory buckets.
  - objectOwnership
```
public final ObjectOwnership objectOwnership()
```
    Returns the value of the ObjectOwnership property for this object.
    If the service returns an enum value that is not available in the current SDK version, objectOwnership will return ObjectOwnership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectOwnershipAsString().
    
    Returns:
    
    The value of the ObjectOwnership property for this object.
    
    See Also:
    
    ObjectOwnership
  - objectOwnershipAsString
```
public final String objectOwnershipAsString()
```
    Returns the value of the ObjectOwnership property for this object.
    If the service returns an enum value that is not available in the current SDK version, objectOwnership will return ObjectOwnership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectOwnershipAsString().
    
    Returns:
    
    The value of the ObjectOwnership property for this object.
    
    See Also:
    
    ObjectOwnership
  - toBuilder
```
public CreateBucketRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static CreateBucketRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBucketRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - 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 CreateBucketRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

acl

aclAsString

bucket

createBucketConfiguration

grantFullControl

grantRead

grantReadACP

grantWrite

grantWriteACP

objectLockEnabledForBucket

objectOwnership

objectOwnershipAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField