Class CreateBucketRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateBucketRequest.Builder,
CreateBucketRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BucketCannedACL
acl()
The canned ACL to apply to the bucket.final String
The canned ACL to apply to the bucket.final String
bucket()
The name of the bucket to create.static CreateBucketRequest.Builder
builder()
The configuration information for the bucket.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.final String
Allows grantee to list the objects in the bucket.final String
Allows grantee to read the bucket ACL.final String
Allows grantee to create new objects in the bucket.final String
Allows grantee to write the ACL for the applicable bucket.final int
hashCode()
final Boolean
Specifies whether you want S3 Object Lock to be enabled for the new bucket.final ObjectOwnership
Returns the value of the ObjectOwnership property for this object.final String
Returns the value of the ObjectOwnership property for this object.static Class
<? extends CreateBucketRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnBucketCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
- See Also:
-
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 returnBucketCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaclAsString()
.- Returns:
- The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
- See Also:
-
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 formatbucket_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 formatbucket_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
The configuration information for the bucket.
- Returns:
- The configuration information for the bucket.
-
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
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
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
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
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
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
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 returnObjectOwnership.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectOwnershipAsString()
.- Returns:
- The value of the ObjectOwnership property for this object.
- See Also:
-
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 returnObjectOwnership.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectOwnershipAsString()
.- Returns:
- The value of the ObjectOwnership property for this object.
- See Also:
-
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 interfaceToCopyableBuilder<CreateBucketRequest.Builder,
CreateBucketRequest> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-