Amazonka.S3.PutBucketCors

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

• The request's Origin header must match AllowedOrigin elements.
• The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.
• Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

• GetBucketCors
• DeleteBucketCors
• RESTOPTIONSobject

Creating a Request

data PutBucketCors

See: newPutBucketCors smart constructor.

Constructors

PutBucketCors'

Fields

• checksumAlgorithm :: Maybe ChecksumAlgorithm

  Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

  If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

• contentMD5 :: Maybe Text

  The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

  For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

• expectedBucketOwner :: Maybe Text

  The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• bucket :: BucketName

  Specifies the bucket impacted by the corsconfiguration.

• cORSConfiguration :: CORSConfiguration

  Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Instances

ToHeaders PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

toHeaders :: PutBucketCors -> [Header]

ToPath PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

toPath :: PutBucketCors -> ByteString

ToQuery PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

toQuery :: PutBucketCors -> QueryString

ToElement PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

toElement :: PutBucketCors -> Element

AWSRequest PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Associated Types

type AWSResponse PutBucketCors

Methods

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

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

Generic PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Associated Types

type Rep PutBucketCors :: Type -> Type

Methods

from :: PutBucketCors -> Rep PutBucketCors x

to :: Rep PutBucketCors x -> PutBucketCors

Read PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

readsPrec :: Int -> ReadS PutBucketCors

readList :: ReadS [PutBucketCors]

readPrec :: ReadPrec PutBucketCors

readListPrec :: ReadPrec [PutBucketCors]

Show PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

showsPrec :: Int -> PutBucketCors -> ShowS

show :: PutBucketCors -> String

showList :: [PutBucketCors] -> ShowS

NFData PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

rnf :: PutBucketCors -> ()

Eq PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

(==) :: PutBucketCors -> PutBucketCors -> Bool

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

Hashable PutBucketCors

Defined in Amazonka.S3.PutBucketCors

Methods

hashWithSalt :: Int -> PutBucketCors -> Int

hash :: PutBucketCors -> Int

type AWSResponse PutBucketCors

Defined in Amazonka.S3.PutBucketCors

type AWSResponse PutBucketCors = PutBucketCorsResponse

type Rep PutBucketCors

Defined in Amazonka.S3.PutBucketCors

type Rep PutBucketCors = D1 ('MetaData "PutBucketCors" "Amazonka.S3.PutBucketCors" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketCors'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :*: S1 ('MetaSel ('Just "contentMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "cORSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CORSConfiguration)))))

newPutBucketCors

Arguments

:: BucketName

PutBucketCors

-> CORSConfiguration

$sel:cORSConfiguration:PutBucketCors'

-> PutBucketCors

Create a value of PutBucketCors 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:

PutBucketCors, putBucketCors_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

$sel:contentMD5:PutBucketCors', putBucketCors_contentMD5 - The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

$sel:expectedBucketOwner:PutBucketCors', putBucketCors_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

PutBucketCors, putBucketCors_bucket - Specifies the bucket impacted by the corsconfiguration.

$sel:cORSConfiguration:PutBucketCors', putBucketCors_cORSConfiguration - Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Request Lenses

putBucketCors_checksumAlgorithm :: Lens' PutBucketCors (Maybe ChecksumAlgorithm)

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketCors_contentMD5 :: Lens' PutBucketCors (Maybe Text)

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putBucketCors_expectedBucketOwner :: Lens' PutBucketCors (Maybe Text)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketCors_bucket :: Lens' PutBucketCors BucketName

Specifies the bucket impacted by the corsconfiguration.

putBucketCors_cORSConfiguration :: Lens' PutBucketCors CORSConfiguration

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Destructuring the Response

data PutBucketCorsResponse

See: newPutBucketCorsResponse smart constructor.

Constructors

PutBucketCorsResponse'

Instances

Generic PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

Associated Types

type Rep PutBucketCorsResponse :: Type -> Type

Methods

from :: PutBucketCorsResponse -> Rep PutBucketCorsResponse x

to :: Rep PutBucketCorsResponse x -> PutBucketCorsResponse

Read PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

Methods

readsPrec :: Int -> ReadS PutBucketCorsResponse

readList :: ReadS [PutBucketCorsResponse]

readPrec :: ReadPrec PutBucketCorsResponse

readListPrec :: ReadPrec [PutBucketCorsResponse]

Show PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

Methods

showsPrec :: Int -> PutBucketCorsResponse -> ShowS

show :: PutBucketCorsResponse -> String

showList :: [PutBucketCorsResponse] -> ShowS

NFData PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

Methods

rnf :: PutBucketCorsResponse -> ()

Eq PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

Methods

(==) :: PutBucketCorsResponse -> PutBucketCorsResponse -> Bool

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

type Rep PutBucketCorsResponse

Defined in Amazonka.S3.PutBucketCors

type Rep PutBucketCorsResponse = D1 ('MetaData "PutBucketCorsResponse" "Amazonka.S3.PutBucketCors" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketCorsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBucketCorsResponse :: PutBucketCorsResponse

Create a value of PutBucketCorsResponse with all optional fields omitted.

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