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

Class CreateBucketRequest

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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • bucketNamespace

      public final BucketNamespace bucketNamespace()

      Specifies the namespace where you want to create your general purpose bucket. When you create a general purpose bucket, you can choose to create a bucket in the shared global namespace or you can choose to create a bucket in your account regional namespace. Your account regional namespace is a subdivision of the global namespace that only your account can create buckets in. For more information on bucket namespaces, see Namespaces for general purpose buckets.

      General purpose buckets in your account regional namespace must follow a specific naming convention. These buckets consist of a bucket name prefix that you create, and a suffix that contains your 12-digit Amazon Web Services Account ID, the Amazon Web Services Region code, and ends with -an. Bucket names must follow the format bucket-name-prefix-accountId-region-an (for example, amzn-s3-demo-bucket-111122223333-us-west-2-an). For information about bucket naming restrictions, see Account regional namespace naming rules in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      If the service returns an enum value that is not available in the current SDK version, bucketNamespace will return BucketNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bucketNamespaceAsString().

      Returns:
      Specifies the namespace where you want to create your general purpose bucket. When you create a general purpose bucket, you can choose to create a bucket in the shared global namespace or you can choose to create a bucket in your account regional namespace. Your account regional namespace is a subdivision of the global namespace that only your account can create buckets in. For more information on bucket namespaces, see Namespaces for general purpose buckets.

      General purpose buckets in your account regional namespace must follow a specific naming convention. These buckets consist of a bucket name prefix that you create, and a suffix that contains your 12-digit Amazon Web Services Account ID, the Amazon Web Services Region code, and ends with -an. Bucket names must follow the format bucket-name-prefix-accountId-region-an (for example, amzn-s3-demo-bucket-111122223333-us-west-2-an). For information about bucket naming restrictions, see Account regional namespace naming rules in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      See Also:

    • bucketNamespaceAsString

      public final String bucketNamespaceAsString()

      Specifies the namespace where you want to create your general purpose bucket. When you create a general purpose bucket, you can choose to create a bucket in the shared global namespace or you can choose to create a bucket in your account regional namespace. Your account regional namespace is a subdivision of the global namespace that only your account can create buckets in. For more information on bucket namespaces, see Namespaces for general purpose buckets.

      General purpose buckets in your account regional namespace must follow a specific naming convention. These buckets consist of a bucket name prefix that you create, and a suffix that contains your 12-digit Amazon Web Services Account ID, the Amazon Web Services Region code, and ends with -an. Bucket names must follow the format bucket-name-prefix-accountId-region-an (for example, amzn-s3-demo-bucket-111122223333-us-west-2-an). For information about bucket naming restrictions, see Account regional namespace naming rules in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      If the service returns an enum value that is not available in the current SDK version, bucketNamespace will return BucketNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bucketNamespaceAsString().

      Returns:
      Specifies the namespace where you want to create your general purpose bucket. When you create a general purpose bucket, you can choose to create a bucket in the shared global namespace or you can choose to create a bucket in your account regional namespace. Your account regional namespace is a subdivision of the global namespace that only your account can create buckets in. For more information on bucket namespaces, see Namespaces for general purpose buckets.

      General purpose buckets in your account regional namespace must follow a specific naming convention. These buckets consist of a bucket name prefix that you create, and a suffix that contains your 12-digit Amazon Web Services Account ID, the Amazon Web Services Region code, and ends with -an. Bucket names must follow the format bucket-name-prefix-accountId-region-an (for example, amzn-s3-demo-bucket-111122223333-us-west-2-an). For information about bucket naming restrictions, see Account regional namespace naming rules in the Amazon S3 User Guide.

      This functionality is not supported for directory buckets.

      See Also:

    • 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