Package software.amazon.awssdk.services.s3control.model

Class CreateBucketRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3control.model.S3ControlRequest

software.amazon.awssdk.services.s3control.model.CreateBucketRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBucketRequest.Builder

Method Summary

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.
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, overwrite, and delete any object 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.
String	outpostId()	The ID of the Outposts where the bucket is being created.
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 is not supported by Amazon S3 on Outposts 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 is not supported by Amazon S3 on Outposts buckets.

See Also:

BucketCannedACL

aclAsString

public final String aclAsString()

The canned ACL to apply to the bucket.

This is not supported by Amazon S3 on Outposts 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 is not supported by Amazon S3 on Outposts buckets.

See Also:

BucketCannedACL

bucket

public final String bucket()

The name of the bucket.

Returns:

The name of the bucket.

createBucketConfiguration

public final CreateBucketConfiguration createBucketConfiguration()

The configuration information for the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

The configuration information for the bucket.

This is not supported by Amazon S3 on Outposts buckets.

grantFullControl

public final String grantFullControl()

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This is not supported by Amazon S3 on Outposts buckets.

grantRead

public final String grantRead()

Allows grantee to list the objects in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Allows grantee to list the objects in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

grantReadACP

public final String grantReadACP()

Allows grantee to read the bucket ACL.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Allows grantee to read the bucket ACL.

This is not supported by Amazon S3 on Outposts buckets.

grantWrite

public final String grantWrite()

Allows grantee to create, overwrite, and delete any object in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Allows grantee to create, overwrite, and delete any object in the bucket.

This is not supported by Amazon S3 on Outposts buckets.

grantWriteACP

public final String grantWriteACP()

Allows grantee to write the ACL for the applicable bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Allows grantee to write the ACL for the applicable bucket.

This is not supported by Amazon S3 on Outposts buckets.

objectLockEnabledForBucket

public final Boolean objectLockEnabledForBucket()

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

This is not supported by Amazon S3 on Outposts buckets.

outpostId

public final String outpostId()

The ID of the Outposts where the bucket is being created.

This ID is required by Amazon S3 on Outposts buckets.

Returns:

The ID of the Outposts where the bucket is being created.

This ID is required by Amazon S3 on Outposts buckets.

toBuilder

public CreateBucketRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

Specified by:

toBuilder in class S3ControlRequest

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