AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PutBucket operation.
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
the s3.amazonaws.com
global endpoint, the request goes to the us-east-1
Region. So the signature calculations in Signature Version 4 must use us-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.
General purpose bucket permissions - In addition to the s3:CreateBucket
permission, the following permissions are required in a policy when your CreateBucket
request includes specific headers:
Access control lists (ACLs) - In your CreateBucket
request, if you
specify an access control list (ACL) and set it to public-read
, public-read-write
,
authenticated-read
, or if you explicitly specify any other custom ACLs, both
s3:CreateBucket
and s3:PutBucketAcl
permissions are required. In your
CreateBucket
request, if you set the ACL to private
, or if you don't
specify any ACLs, only the s3:CreateBucket
permission is required.
Object Lock - In your CreateBucket
request, if you set x-amz-bucket-object-lock-enabled
to true, the s3:PutBucketObjectLockConfiguration
and s3:PutBucketVersioning
permissions are required.
S3 Object Ownership - If your CreateBucket
request includes the x-amz-object-ownership
header, then the s3: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 using PutBucketAcl
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 the
s3: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.
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to CreateBucket
:
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
public class PutBucketRequest : PutWithACLRequest IAmazonWebServiceRequest
The PutBucketRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
PutBucketRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
BucketName | System.String |
Gets and sets the property BucketName. 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 |
![]() |
BucketRegion | Amazon.S3.S3Region |
The region locality for the bucket. |
![]() |
BucketRegionName | System.String |
The bucket region locality expressed using the name of the region. When set, this will determine where your data will reside in S3. Valid values: us-east-1, us-west-1, us-west-2, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1 |
![]() |
CannedACL | Amazon.S3.S3CannedACL |
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
|
![]() |
Grants | System.Collections.Generic.List<Amazon.S3.Model.S3Grant> | Inherited from Amazon.S3.Model.PutWithACLRequest. |
![]() |
ObjectLockEnabledForBucket | System.Boolean |
Gets and sets the property ObjectLockEnabledForBucket. Specifies whether you want S3 Object Lock to be enabled for the new bucket. This functionality is not supported for directory buckets. |
![]() |
ObjectOwnership | Amazon.S3.ObjectOwnership |
Gets and sets the property ObjectOwnership. |
![]() |
PutBucketConfiguration | Amazon.S3.Model.PutBucketConfiguration |
The additional configuration properties for a PutBucket operations |
![]() |
UseClientRegion | System.Boolean |
If set to true the bucket will be created in the same region as the configuration of the AmazonS3 client. If PutBucketRequest.BucketRegion or PutBucketRequest.BucketRegionName are set they take precedence over this property. Default: true. |
This example shows how to create a bucket in a specific region and with a canned ACL configuring the bucket to be public readable.
// Create a client AmazonS3Client client = new AmazonS3Client(); // Construct request PutBucketRequest request = new PutBucketRequest { BucketName = "SampleBucket", BucketRegion = S3Region.EU, // set region to EU CannedACL = S3CannedACL.PublicRead // make bucket publicly readable }; // Issue call PutBucketResponse response = client.PutBucket(request);
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5