import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { CreateBucketOutput, CreateBucketRequest } from "../models/models_0"; import { deserializeAws_restXmlCreateBucketCommand, serializeAws_restXmlCreateBucketCommand, } from "../protocols/Aws_restXml"; import { getLocationConstraintPlugin } from "@aws-sdk/middleware-location-constraint"; import { getSerdePlugin } from "@aws-sdk/middleware-serde"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { FinalizeHandlerArguments, Handler, HandlerExecutionContext, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, SerdeContext as __SerdeContext, } from "@aws-sdk/types"; export type CreateBucketCommandInput = CreateBucketRequest; export type CreateBucketCommandOutput = CreateBucketOutput & __MetadataBearer; /** *

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a * valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to * create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information about bucket naming * restrictions, see Working with Amazon S3 * buckets.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

By default, the bucket is created in the US East (N. Virginia) Region. You can * optionally specify a Region in the request body. You might choose a Region to optimize * latency, minimize costs, or address regulatory requirements. For example, if you reside in * Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) * Region. For more information, see Accessing a * bucket.

* *

If you send your create bucket request to the s3.amazonaws.com endpoint, * the request goes to the us-east-1 Region. Accordingly, 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.

* *

When creating a bucket using this operation, you can optionally specify the accounts or * groups that should be granted specific permissions on the bucket. There are two ways to * grant the appropriate permissions using the request headers.

*
Specify a canned ACL using the x-amz-acl request header. Amazon S3 * supports a set of predefined ACLs, known as canned ACLs. Each * canned ACL has a predefined set of grantees and permissions. For more information, * see Canned ACL.
*
*
Specify access permissions explicitly using the x-amz-grant-read, * x-amz-grant-write, x-amz-grant-read-acp, * x-amz-grant-write-acp, and x-amz-grant-full-control * headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For * more information, see Access control list * (ACL) overview.
*
You specify each grantee as a type=value pair, where the type is one of the * following:
*
- *
  * id – if the value specified is the canonical user ID of an AWS * account
  *
- *
  * uri – if you are granting permissions to a predefined * group
  *
- *
  * emailAddress – if the value specified is the email address of * an AWS account
  *
  *
  Using email addresses to specify a grantee is only supported in the following AWS Regions:
  *
  - *
    US East (N. Virginia)
    *
  - *
    US West (N. California)
    *
  - *
    US West (Oregon)
    *
  - *
    Asia Pacific (Singapore)
    *
  - *
    Asia Pacific (Sydney)
    *
  - *
    Asia Pacific (Tokyo)
    *
  - *
    Europe (Ireland)
    *
  - *
    South America (São Paulo)
    *
  *
  For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
  *
  *
*
For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
*
* x-amz-grant-read: id="11112222333", id="444455556666" *
*

* *

You can use either a canned ACL or specify access permissions explicitly. You cannot * do both.

* * * *

The following operations are related to CreateBucket:

*
* PutObject *
*
*
* DeleteBucket *
*

*/ export class CreateBucketCommand extends $Command< CreateBucketCommandInput, CreateBucketCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: CreateBucketCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getLocationConstraintPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "CreateBucketCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: CreateBucketRequest.filterSensitiveLog, outputFilterSensitiveLog: CreateBucketOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: CreateBucketCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlCreateBucketCommand(input, context); } private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { return deserializeAws_restXmlCreateBucketCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }