Amazonka.S3.CreateBucket

Creates a new S3 bucket. To create a bucket, you must register with 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.

Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.

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.

Access control lists (ACLs)

When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or groups that should be granted specific permissions on the bucket.

If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAclWithObjectOwnership error code. For more information, see Controlling object ownership in the Amazon S3 User Guide.

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 Amazon Web Services account
  • uri – if you are granting permissions to a predefined group

  • emailAddress – if the value specified is the email address of an Amazon Web Services account

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services 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 Amazon Web Services General Reference.

  For example, the following x-amz-grant-read header grants the Amazon Web Services 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.

Permissions

In addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:

• ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.
• Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.
• S3 Object Ownership - If your CreateBucket request includes the the x-amz-object-ownership header, s3:PutBucketOwnershipControls permission is required.

The following operations are related to CreateBucket:

• PutObject
• DeleteBucket

Creating a Request

data CreateBucket

See: newCreateBucket smart constructor.

Constructors

CreateBucket'

Fields

• acl :: Maybe BucketCannedACL

  The canned ACL to apply to the bucket.

• createBucketConfiguration :: Maybe CreateBucketConfiguration

  The configuration information for the bucket.

• grantFullControl :: Maybe Text

  Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

• grantRead :: Maybe Text

  Allows grantee to list the objects in the bucket.

• grantReadACP :: Maybe Text

  Allows grantee to read the bucket ACL.

• grantWrite :: Maybe Text

  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.

• grantWriteACP :: Maybe Text

  Allows grantee to write the ACL for the applicable bucket.

• objectLockEnabledForBucket :: Maybe Bool

  Specifies whether you want S3 Object Lock to be enabled for the new bucket.

• objectOwnership :: Maybe ObjectOwnership
• bucket :: BucketName

  The name of the bucket to create.

Instances

ToHeaders CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

toHeaders :: CreateBucket -> [Header]

ToPath CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

toPath :: CreateBucket -> ByteString

ToQuery CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

toQuery :: CreateBucket -> QueryString

ToElement CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

toElement :: CreateBucket -> Element

AWSRequest CreateBucket

Defined in Amazonka.S3.CreateBucket

Associated Types

type AWSResponse CreateBucket

Methods

request :: (Service -> Service) -> CreateBucket -> Request CreateBucket

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBucket -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBucket)))

Generic CreateBucket

Defined in Amazonka.S3.CreateBucket

Associated Types

type Rep CreateBucket :: Type -> Type

Methods

from :: CreateBucket -> Rep CreateBucket x

to :: Rep CreateBucket x -> CreateBucket

Read CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

readsPrec :: Int -> ReadS CreateBucket

readList :: ReadS [CreateBucket]

readPrec :: ReadPrec CreateBucket

readListPrec :: ReadPrec [CreateBucket]

Show CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

showsPrec :: Int -> CreateBucket -> ShowS

show :: CreateBucket -> String

showList :: [CreateBucket] -> ShowS

NFData CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

rnf :: CreateBucket -> ()

Eq CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

(==) :: CreateBucket -> CreateBucket -> Bool

(/=) :: CreateBucket -> CreateBucket -> Bool

Hashable CreateBucket

Defined in Amazonka.S3.CreateBucket

Methods

hashWithSalt :: Int -> CreateBucket -> Int

hash :: CreateBucket -> Int

type AWSResponse CreateBucket

Defined in Amazonka.S3.CreateBucket

type AWSResponse CreateBucket = CreateBucketResponse

type Rep CreateBucket

Defined in Amazonka.S3.CreateBucket

type Rep CreateBucket = D1 ('MetaData "CreateBucket" "Amazonka.S3.CreateBucket" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "CreateBucket'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketCannedACL)) :*: S1 ('MetaSel ('Just "createBucketConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBucketConfiguration))) :*: (S1 ('MetaSel ('Just "grantFullControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "grantRead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "grantReadACP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "grantWrite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "grantWriteACP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "objectLockEnabledForBucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "objectOwnership") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectOwnership)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName))))))

newCreateBucket

Arguments

:: BucketName

CreateBucket

-> CreateBucket

Create a value of CreateBucket with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acl:CreateBucket', createBucket_acl - The canned ACL to apply to the bucket.

$sel:createBucketConfiguration:CreateBucket', createBucket_createBucketConfiguration - The configuration information for the bucket.

$sel:grantFullControl:CreateBucket', createBucket_grantFullControl - Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

$sel:grantRead:CreateBucket', createBucket_grantRead - Allows grantee to list the objects in the bucket.

$sel:grantReadACP:CreateBucket', createBucket_grantReadACP - Allows grantee to read the bucket ACL.

$sel:grantWrite:CreateBucket', createBucket_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.

$sel:grantWriteACP:CreateBucket', createBucket_grantWriteACP - Allows grantee to write the ACL for the applicable bucket.

$sel:objectLockEnabledForBucket:CreateBucket', createBucket_objectLockEnabledForBucket - Specifies whether you want S3 Object Lock to be enabled for the new bucket.

CreateBucket, createBucket_objectOwnership - Undocumented member.

CreateBucket, createBucket_bucket - The name of the bucket to create.

Request Lenses

createBucket_acl :: Lens' CreateBucket (Maybe BucketCannedACL)

The canned ACL to apply to the bucket.

createBucket_createBucketConfiguration :: Lens' CreateBucket (Maybe CreateBucketConfiguration)

The configuration information for the bucket.

createBucket_grantFullControl :: Lens' CreateBucket (Maybe Text)

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

createBucket_grantRead :: Lens' CreateBucket (Maybe Text)

Allows grantee to list the objects in the bucket.

createBucket_grantReadACP :: Lens' CreateBucket (Maybe Text)

Allows grantee to read the bucket ACL.

createBucket_grantWrite :: Lens' CreateBucket (Maybe Text)

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.

createBucket_grantWriteACP :: Lens' CreateBucket (Maybe Text)

Allows grantee to write the ACL for the applicable bucket.

createBucket_objectLockEnabledForBucket :: Lens' CreateBucket (Maybe Bool)

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

createBucket_objectOwnership :: Lens' CreateBucket (Maybe ObjectOwnership)

Undocumented member.

createBucket_bucket :: Lens' CreateBucket BucketName

The name of the bucket to create.

Destructuring the Response

data CreateBucketResponse

See: newCreateBucketResponse smart constructor.

Constructors

CreateBucketResponse'

Fields

• location :: Maybe Text

  A forward slash followed by the name of the bucket.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

Associated Types

type Rep CreateBucketResponse :: Type -> Type

Methods

from :: CreateBucketResponse -> Rep CreateBucketResponse x

to :: Rep CreateBucketResponse x -> CreateBucketResponse

Read CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

Methods

readsPrec :: Int -> ReadS CreateBucketResponse

readList :: ReadS [CreateBucketResponse]

readPrec :: ReadPrec CreateBucketResponse

readListPrec :: ReadPrec [CreateBucketResponse]

Show CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

Methods

showsPrec :: Int -> CreateBucketResponse -> ShowS

show :: CreateBucketResponse -> String

showList :: [CreateBucketResponse] -> ShowS

NFData CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

Methods

rnf :: CreateBucketResponse -> ()

Eq CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

Methods

(==) :: CreateBucketResponse -> CreateBucketResponse -> Bool

(/=) :: CreateBucketResponse -> CreateBucketResponse -> Bool

type Rep CreateBucketResponse

Defined in Amazonka.S3.CreateBucket

type Rep CreateBucketResponse = D1 ('MetaData "CreateBucketResponse" "Amazonka.S3.CreateBucket" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "CreateBucketResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBucketResponse

Arguments

:: Int

$sel:httpStatus:CreateBucketResponse'

-> CreateBucketResponse

Create a value of CreateBucketResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:location:CreateBucketResponse', createBucketResponse_location - A forward slash followed by the name of the bucket.

$sel:httpStatus:CreateBucketResponse', createBucketResponse_httpStatus - The response's http status code.

Response Lenses

createBucketResponse_location :: Lens' CreateBucketResponse (Maybe Text)

A forward slash followed by the name of the bucket.

createBucketResponse_httpStatus :: Lens' CreateBucketResponse Int

The response's http status code.