- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateBucketCommand
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 about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones 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-code.amazonaws.com
.
The following operations are related to CreateBucket
:
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { S3Client, CreateBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, CreateBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // CreateBucketRequest
ACL: "private" || "public-read" || "public-read-write" || "authenticated-read",
Bucket: "STRING_VALUE", // required
CreateBucketConfiguration: { // CreateBucketConfiguration
LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-4" || "ap-southeast-5" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-central-2" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "il-central-1" || "me-central-1" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
Location: { // LocationInfo
Type: "AvailabilityZone" || "LocalZone",
Name: "STRING_VALUE",
},
Bucket: { // BucketInfo
DataRedundancy: "SingleAvailabilityZone" || "SingleLocalZone",
Type: "Directory",
},
},
GrantFullControl: "STRING_VALUE",
GrantRead: "STRING_VALUE",
GrantReadACP: "STRING_VALUE",
GrantWrite: "STRING_VALUE",
GrantWriteACP: "STRING_VALUE",
ObjectLockEnabledForBucket: true || false,
ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced",
};
const command = new CreateBucketCommand(input);
const response = await client.send(command);
// { // CreateBucketOutput
// Location: "STRING_VALUE",
// };
Example Usage
CreateBucketCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Bucket Required | string | undefined | 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 |
ACL | BucketCannedACL | undefined | The canned ACL to apply to the bucket. This functionality is not supported for directory buckets. |
CreateBucketConfiguration | CreateBucketConfiguration | undefined | The configuration information for the bucket. |
GrantFullControl | string | undefined | Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This functionality is not supported for directory buckets. |
GrantRead | string | undefined | Allows grantee to list the objects in the bucket. This functionality is not supported for directory buckets. |
GrantReadACP | string | undefined | Allows grantee to read the bucket ACL. This functionality is not supported for directory buckets. |
GrantWrite | string | undefined | 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 | string | undefined | Allows grantee to write the ACL for the applicable bucket. This functionality is not supported for directory buckets. |
ObjectLockEnabledForBucket | boolean | undefined | Specifies whether you want S3 Object Lock to be enabled for the new bucket. This functionality is not supported for directory buckets. |
ObjectOwnership | ObjectOwnership | undefined | The container element for object ownership for a bucket's ownership controls. By default, This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership. |
CreateBucketCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Location | string | undefined | A forward slash followed by the name of the bucket. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BucketAlreadyExists | client | The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again. |
BucketAlreadyOwnedByYou | client | The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs). |
S3ServiceException | Base exception class for all service exceptions from S3 service. |