pub struct CreateBucketFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateBucket
.
This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket
.
Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.
-
General purpose buckets - If you send your
CreateBucket
request to thes3.amazonaws.com
global endpoint, the request goes to theus-east-1
Region. So the signature calculations in Signature Version 4 must useus-east-1
as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets in the Amazon S3 User Guide. -
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name
. Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - In addition to the
s3:CreateBucket
permission, the following permissions are required in a policy when yourCreateBucket
request includes specific headers:-
Access control lists (ACLs) - In your
CreateBucket
request, if you specify an access control list (ACL) and set it topublic-read
,public-read-write
,authenticated-read
, or if you explicitly specify any other custom ACLs, boths3:CreateBucket
ands3:PutBucketAcl
permissions are required. In yourCreateBucket
request, if you set the ACL toprivate
, or if you don't specify any ACLs, only thes3:CreateBucket
permission is required. -
Object Lock - In your
CreateBucket
request, if you setx-amz-bucket-object-lock-enabled
to true, thes3:PutBucketObjectLockConfiguration
ands3:PutBucketVersioning
permissions are required. -
S3 Object Ownership - If your
CreateBucket
request includes thex-amz-object-ownership
header, then thes3:PutBucketOwnershipControls
permission is required.To set an ACL on a bucket as part of a
CreateBucket
request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default,BucketOwnerEnforced
. Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before usingPutBucketAcl
to set the ACL. If you try to create a bucket with a public ACL, the request will fail.For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.
-
S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. Specifically, you can create a new bucket with Block Public Access enabled, then separately call the
DeletePublicAccessBlock
API. To use this operation, you must have thes3:PutBucketPublicAccessBlock
permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.
-
-
Directory bucket permissions - You must have the
s3express:CreateBucket
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.
For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com
.
The following operations are related to CreateBucket
:
Implementations§
source§impl CreateBucketFluentBuilder
impl CreateBucketFluentBuilder
sourcepub fn as_input(&self) -> &CreateBucketInputBuilder
pub fn as_input(&self) -> &CreateBucketInputBuilder
Access the CreateBucket as a reference.
sourcepub async fn send(
self,
) -> Result<CreateBucketOutput, SdkError<CreateBucketError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateBucketOutput, SdkError<CreateBucketError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<CreateBucketOutput, CreateBucketError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateBucketOutput, CreateBucketError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn acl(self, input: BucketCannedAcl) -> Self
pub fn acl(self, input: BucketCannedAcl) -> Self
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
sourcepub fn set_acl(self, input: Option<BucketCannedAcl>) -> Self
pub fn set_acl(self, input: Option<BucketCannedAcl>) -> Self
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
sourcepub fn get_acl(&self) -> &Option<BucketCannedAcl>
pub fn get_acl(&self) -> &Option<BucketCannedAcl>
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
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
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
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
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
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
sourcepub fn create_bucket_configuration(
self,
input: CreateBucketConfiguration,
) -> Self
pub fn create_bucket_configuration( self, input: CreateBucketConfiguration, ) -> Self
The configuration information for the bucket.
sourcepub fn set_create_bucket_configuration(
self,
input: Option<CreateBucketConfiguration>,
) -> Self
pub fn set_create_bucket_configuration( self, input: Option<CreateBucketConfiguration>, ) -> Self
The configuration information for the bucket.
sourcepub fn get_create_bucket_configuration(
&self,
) -> &Option<CreateBucketConfiguration>
pub fn get_create_bucket_configuration( &self, ) -> &Option<CreateBucketConfiguration>
The configuration information for the bucket.
sourcepub fn grant_full_control(self, input: impl Into<String>) -> Self
pub fn grant_full_control(self, input: impl Into<String>) -> Self
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
sourcepub fn set_grant_full_control(self, input: Option<String>) -> Self
pub fn set_grant_full_control(self, input: Option<String>) -> Self
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
sourcepub fn get_grant_full_control(&self) -> &Option<String>
pub fn get_grant_full_control(&self) -> &Option<String>
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
sourcepub fn grant_read(self, input: impl Into<String>) -> Self
pub fn grant_read(self, input: impl Into<String>) -> Self
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
sourcepub fn set_grant_read(self, input: Option<String>) -> Self
pub fn set_grant_read(self, input: Option<String>) -> Self
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
sourcepub fn get_grant_read(&self) -> &Option<String>
pub fn get_grant_read(&self) -> &Option<String>
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
sourcepub fn grant_read_acp(self, input: impl Into<String>) -> Self
pub fn grant_read_acp(self, input: impl Into<String>) -> Self
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
sourcepub fn set_grant_read_acp(self, input: Option<String>) -> Self
pub fn set_grant_read_acp(self, input: Option<String>) -> Self
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
sourcepub fn get_grant_read_acp(&self) -> &Option<String>
pub fn get_grant_read_acp(&self) -> &Option<String>
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
sourcepub fn grant_write(self, input: impl Into<String>) -> Self
pub fn grant_write(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_grant_write(self, input: Option<String>) -> Self
pub fn set_grant_write(self, input: Option<String>) -> Self
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.
sourcepub fn get_grant_write(&self) -> &Option<String>
pub fn get_grant_write(&self) -> &Option<String>
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.
sourcepub fn grant_write_acp(self, input: impl Into<String>) -> Self
pub fn grant_write_acp(self, input: impl Into<String>) -> Self
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
sourcepub fn set_grant_write_acp(self, input: Option<String>) -> Self
pub fn set_grant_write_acp(self, input: Option<String>) -> Self
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
sourcepub fn get_grant_write_acp(&self) -> &Option<String>
pub fn get_grant_write_acp(&self) -> &Option<String>
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_enabled_for_bucket(self, input: bool) -> Self
pub fn object_lock_enabled_for_bucket(self, input: bool) -> Self
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_enabled_for_bucket(self, input: Option<bool>) -> Self
pub fn set_object_lock_enabled_for_bucket(self, input: Option<bool>) -> Self
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_enabled_for_bucket(&self) -> &Option<bool>
pub fn get_object_lock_enabled_for_bucket(&self) -> &Option<bool>
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
sourcepub fn object_ownership(self, input: ObjectOwnership) -> Self
pub fn object_ownership(self, input: ObjectOwnership) -> Self
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control
canned ACL.
ObjectWriter
- The uploading account will own the object if the object is uploaded with the bucket-owner-full-control
canned ACL.
BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
sourcepub fn set_object_ownership(self, input: Option<ObjectOwnership>) -> Self
pub fn set_object_ownership(self, input: Option<ObjectOwnership>) -> Self
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control
canned ACL.
ObjectWriter
- The uploading account will own the object if the object is uploaded with the bucket-owner-full-control
canned ACL.
BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
sourcepub fn get_object_ownership(&self) -> &Option<ObjectOwnership>
pub fn get_object_ownership(&self) -> &Option<ObjectOwnership>
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control
canned ACL.
ObjectWriter
- The uploading account will own the object if the object is uploaded with the bucket-owner-full-control
canned ACL.
BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
Trait Implementations§
source§impl Clone for CreateBucketFluentBuilder
impl Clone for CreateBucketFluentBuilder
source§fn clone(&self) -> CreateBucketFluentBuilder
fn clone(&self) -> CreateBucketFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateBucketFluentBuilder
impl !RefUnwindSafe for CreateBucketFluentBuilder
impl Send for CreateBucketFluentBuilder
impl Sync for CreateBucketFluentBuilder
impl Unpin for CreateBucketFluentBuilder
impl !UnwindSafe for CreateBucketFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)