Amazonka.S3.Types.CORSRule

Documentation

data CORSRule

Specifies a cross-origin access rule for an Amazon S3 bucket.

See: newCORSRule smart constructor.

Constructors

CORSRule'

Fields

• allowedHeaders :: Maybe [Text]

  Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

• exposeHeaders :: Maybe [Text]

  One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

• id :: Maybe Text

  Unique identifier for the rule. The value cannot be longer than 255 characters.

• maxAgeSeconds :: Maybe Int

  The time in seconds that your browser is to cache the preflight response for the specified resource.

• allowedMethods :: [Text]

  An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

• allowedOrigins :: [Text]

  One or more origins you want customers to be able to access the bucket from.

Instances

FromXML CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

parseXML :: [Node] -> Either String CORSRule

ToXML CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

toXML :: CORSRule -> XML

Generic CORSRule

Defined in Amazonka.S3.Types.CORSRule

Associated Types

type Rep CORSRule :: Type -> Type

Methods

from :: CORSRule -> Rep CORSRule x

to :: Rep CORSRule x -> CORSRule

Read CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

readsPrec :: Int -> ReadS CORSRule

readList :: ReadS [CORSRule]

readPrec :: ReadPrec CORSRule

readListPrec :: ReadPrec [CORSRule]

Show CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

showsPrec :: Int -> CORSRule -> ShowS

show :: CORSRule -> String

showList :: [CORSRule] -> ShowS

NFData CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

rnf :: CORSRule -> ()

Eq CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

(==) :: CORSRule -> CORSRule -> Bool

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

Hashable CORSRule

Defined in Amazonka.S3.Types.CORSRule

Methods

hashWithSalt :: Int -> CORSRule -> Int

hash :: CORSRule -> Int

type Rep CORSRule

Defined in Amazonka.S3.Types.CORSRule

type Rep CORSRule = D1 ('MetaData "CORSRule" "Amazonka.S3.Types.CORSRule" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "CORSRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "exposeHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxAgeSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "allowedMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "allowedOrigins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCORSRule :: CORSRule

Create a value of CORSRule 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:allowedHeaders:CORSRule', cORSRule_allowedHeaders - Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

$sel:exposeHeaders:CORSRule', cORSRule_exposeHeaders - One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

$sel:id:CORSRule', cORSRule_id - Unique identifier for the rule. The value cannot be longer than 255 characters.

$sel:maxAgeSeconds:CORSRule', cORSRule_maxAgeSeconds - The time in seconds that your browser is to cache the preflight response for the specified resource.

$sel:allowedMethods:CORSRule', cORSRule_allowedMethods - An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

$sel:allowedOrigins:CORSRule', cORSRule_allowedOrigins - One or more origins you want customers to be able to access the bucket from.

cORSRule_allowedHeaders :: Lens' CORSRule (Maybe [Text])

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

cORSRule_exposeHeaders :: Lens' CORSRule (Maybe [Text])

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

cORSRule_id :: Lens' CORSRule (Maybe Text)

Unique identifier for the rule. The value cannot be longer than 255 characters.

cORSRule_maxAgeSeconds :: Lens' CORSRule (Maybe Int)

The time in seconds that your browser is to cache the preflight response for the specified resource.

cORSRule_allowedMethods :: Lens' CORSRule [Text]

An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

cORSRule_allowedOrigins :: Lens' CORSRule [Text]

One or more origins you want customers to be able to access the bucket from.