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 Availability Zone. Bucket names must also follow the format bucket_base_name--az_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 Availability Zone. Bucket names must also follow the format bucket_base_name--az_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:

    • toBuilder

      public CreateBucketRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.