Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaStore.Types.CorsRule

Description

Synopsis

data CorsRule = CorsRule' {
- allowedMethods :: Maybe (NonEmpty MethodName)
- exposeHeaders :: Maybe [Text]
- maxAgeSeconds :: Maybe Natural
- allowedOrigins :: NonEmpty Text
- allowedHeaders :: [Text]
}
newCorsRule :: NonEmpty Text -> CorsRule
corsRule_allowedMethods :: Lens' CorsRule (Maybe (NonEmpty MethodName))
corsRule_exposeHeaders :: Lens' CorsRule (Maybe [Text])
corsRule_maxAgeSeconds :: Lens' CorsRule (Maybe Natural)
corsRule_allowedOrigins :: Lens' CorsRule (NonEmpty Text)
corsRule_allowedHeaders :: Lens' CorsRule [Text]

Documentation

data CorsRule Source #

A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

See: newCorsRule smart constructor.

Constructors

CorsRule'

Fields

allowedMethods :: Maybe (NonEmpty MethodName)
Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.
exposeHeaders :: Maybe [Text]
One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
This element is optional for each rule.
maxAgeSeconds :: Maybe Natural
The time in seconds that your browser caches the preflight response for the specified resource.
A CORS rule can have only one MaxAgeSeconds element.
allowedOrigins :: NonEmpty Text
One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.
allowedHeaders :: [Text]
Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.
This element can contain only one wildcard character (*).

Instances

Instances details

FromJSON CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods parseJSON :: Value -> Parser CorsRule # parseJSONList :: Value -> Parser [CorsRule] #
ToJSON CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods toJSON :: CorsRule -> Value # toEncoding :: CorsRule -> Encoding # toJSONList :: [CorsRule] -> Value # toEncodingList :: [CorsRule] -> Encoding #
Generic CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Associated Types type Rep CorsRule :: Type -> Type # Methods from :: CorsRule -> Rep CorsRule x # to :: Rep CorsRule x -> CorsRule #
Read CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods readsPrec :: Int -> ReadS CorsRule # readList :: ReadS [CorsRule] # readPrec :: ReadPrec CorsRule # readListPrec :: ReadPrec [CorsRule] #
Show CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods showsPrec :: Int -> CorsRule -> ShowS # show :: CorsRule -> String # showList :: [CorsRule] -> ShowS #
NFData CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods rnf :: CorsRule -> () #
Eq CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods (==) :: CorsRule -> CorsRule -> Bool # (/=) :: CorsRule -> CorsRule -> Bool #
Hashable CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule Methods hashWithSalt :: Int -> CorsRule -> Int # hash :: CorsRule -> Int #
type Rep CorsRule Source #
Instance details Defined in Amazonka.MediaStore.Types.CorsRule type Rep CorsRule = D1 ('MetaData "CorsRule" "Amazonka.MediaStore.Types.CorsRule" "amazonka-mediastore-2.0-BBurv4SFAUa5diuD6Q5z4D" 'False) (C1 ('MetaCons "CorsRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MethodName))) :: S1 ('MetaSel ('Just "exposeHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "maxAgeSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "allowedOrigins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "allowedHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCorsRule Source #

Arguments

:: NonEmpty Text	`$sel:allowedOrigins:CorsRule'`
-> 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:allowedMethods:CorsRule', corsRule_allowedMethods - Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

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

This element is optional for each rule.

$sel:maxAgeSeconds:CorsRule', corsRule_maxAgeSeconds - The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

$sel:allowedOrigins:CorsRule', corsRule_allowedOrigins - One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

$sel:allowedHeaders:CorsRule', corsRule_allowedHeaders - Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

corsRule_allowedMethods :: Lens' CorsRule (Maybe (NonEmpty MethodName)) Source #

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

corsRule_exposeHeaders :: Lens' CorsRule (Maybe [Text]) Source #

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

This element is optional for each rule.

corsRule_maxAgeSeconds :: Lens' CorsRule (Maybe Natural) Source #

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

corsRule_allowedOrigins :: Lens' CorsRule (NonEmpty Text) Source #

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

Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

corsRule_allowedHeaders :: Lens' CorsRule [Text] Source #

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).