Interface CreateBucketRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
,S3Request.Builder
,SdkBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateBucketRequest
public static interface CreateBucketRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateBucketRequest.Builder
acl(String acl)
The canned ACL to apply to the bucket.CreateBucketRequest.Builder
acl(BucketCannedACL acl)
The canned ACL to apply to the bucket.CreateBucketRequest.Builder
bucket(String bucket)
The name of the bucket to create.default CreateBucketRequest.Builder
createBucketConfiguration(Consumer<CreateBucketConfiguration.Builder> createBucketConfiguration)
The configuration information for the bucket.CreateBucketRequest.Builder
createBucketConfiguration(CreateBucketConfiguration createBucketConfiguration)
The configuration information for the bucket.CreateBucketRequest.Builder
grantFullControl(String grantFullControl)
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.CreateBucketRequest.Builder
grantRead(String grantRead)
Allows grantee to list the objects in the bucket.CreateBucketRequest.Builder
grantReadACP(String grantReadACP)
Allows grantee to read the bucket ACL.CreateBucketRequest.Builder
grantWrite(String grantWrite)
Allows grantee to create new objects in the bucket.CreateBucketRequest.Builder
grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable bucket.CreateBucketRequest.Builder
objectLockEnabledForBucket(Boolean objectLockEnabledForBucket)
Specifies whether you want S3 Object Lock to be enabled for the new bucket.CreateBucketRequest.Builder
objectOwnership(String objectOwnership)
Sets the value of the ObjectOwnership property for this object.CreateBucketRequest.Builder
objectOwnership(ObjectOwnership objectOwnership)
Sets the value of the ObjectOwnership property for this object.CreateBucketRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateBucketRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
acl
CreateBucketRequest.Builder acl(String acl)
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
- Parameters:
acl
- The canned ACL to apply to the bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
BucketCannedACL
,BucketCannedACL
-
acl
CreateBucketRequest.Builder acl(BucketCannedACL acl)
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
- Parameters:
acl
- The canned ACL to apply to the bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
BucketCannedACL
,BucketCannedACL
-
bucket
CreateBucketRequest.Builder bucket(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 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- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
createBucketConfiguration
CreateBucketRequest.Builder createBucketConfiguration(CreateBucketConfiguration createBucketConfiguration)
The configuration information for the bucket.
- Parameters:
createBucketConfiguration
- The configuration information for the bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createBucketConfiguration
default CreateBucketRequest.Builder createBucketConfiguration(Consumer<CreateBucketConfiguration.Builder> createBucketConfiguration)
The configuration information for the bucket.
This is a convenience method that creates an instance of theCreateBucketConfiguration.Builder
avoiding the need to create one manually viaCreateBucketConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreateBucketConfiguration(CreateBucketConfiguration)
.- Parameters:
createBucketConfiguration
- a consumer that will call methods onCreateBucketConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
createBucketConfiguration(CreateBucketConfiguration)
-
grantFullControl
CreateBucketRequest.Builder grantFullControl(String grantFullControl)
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
- Parameters:
grantFullControl
- Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantRead
CreateBucketRequest.Builder grantRead(String grantRead)
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
- Parameters:
grantRead
- Allows grantee to list the objects in the bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantReadACP
CreateBucketRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
- Parameters:
grantReadACP
- Allows grantee to read the bucket ACL.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantWrite
CreateBucketRequest.Builder grantWrite(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
grantWriteACP
CreateBucketRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
- Parameters:
grantWriteACP
- Allows grantee to write the ACL for the applicable bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectLockEnabledForBucket
CreateBucketRequest.Builder objectLockEnabledForBucket(Boolean objectLockEnabledForBucket)
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
- Parameters:
objectLockEnabledForBucket
- Specifies whether you want S3 Object Lock to be enabled for the new bucket.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectOwnership
CreateBucketRequest.Builder objectOwnership(String objectOwnership)
Sets the value of the ObjectOwnership property for this object.- Parameters:
objectOwnership
- The new value for the ObjectOwnership property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ObjectOwnership
,ObjectOwnership
-
objectOwnership
CreateBucketRequest.Builder objectOwnership(ObjectOwnership objectOwnership)
Sets the value of the ObjectOwnership property for this object.- Parameters:
objectOwnership
- The new value for the ObjectOwnership property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ObjectOwnership
,ObjectOwnership
-
overrideConfiguration
CreateBucketRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateBucketRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-