Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFront.Types.CookiePreference

Description

Synopsis

data CookiePreference = CookiePreference' {
- whitelistedNames :: Maybe CookieNames
- forward :: ItemSelection
}
newCookiePreference :: ItemSelection -> CookiePreference
cookiePreference_whitelistedNames :: Lens' CookiePreference (Maybe CookieNames)
cookiePreference_forward :: Lens' CookiePreference ItemSelection

Documentation

data CookiePreference Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy.

If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy.

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.

See: newCookiePreference smart constructor.

Constructors

CookiePreference'

Fields

whitelistedNames :: Maybe CookieNames
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.
If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.
For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.
forward :: ItemSelection
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.
Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

Instances

Instances details

Eq CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods (==) :: CookiePreference -> CookiePreference -> Bool # (/=) :: CookiePreference -> CookiePreference -> Bool #
Read CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods readsPrec :: Int -> ReadS CookiePreference # readList :: ReadS [CookiePreference] # readPrec :: ReadPrec CookiePreference # readListPrec :: ReadPrec [CookiePreference] #
Show CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods showsPrec :: Int -> CookiePreference -> ShowS # show :: CookiePreference -> String # showList :: [CookiePreference] -> ShowS #
Generic CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Associated Types type Rep CookiePreference :: Type -> Type # Methods from :: CookiePreference -> Rep CookiePreference x # to :: Rep CookiePreference x -> CookiePreference #
NFData CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods rnf :: CookiePreference -> () #
Hashable CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods hashWithSalt :: Int -> CookiePreference -> Int # hash :: CookiePreference -> Int #
FromXML CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods parseXML :: [Node] -> Either String CookiePreference #
ToXML CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference Methods toXML :: CookiePreference -> XML #
type Rep CookiePreference Source #
Instance details Defined in Amazonka.CloudFront.Types.CookiePreference type Rep CookiePreference = D1 ('MetaData "CookiePreference" "Amazonka.CloudFront.Types.CookiePreference" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "CookiePreference'" 'PrefixI 'True) (S1 ('MetaSel ('Just "whitelistedNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CookieNames)) :*: S1 ('MetaSel ('Just "forward") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ItemSelection)))

newCookiePreference Source #

Arguments

:: ItemSelection	`$sel:forward:CookiePreference'`
-> CookiePreference

Create a value of CookiePreference 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:whitelistedNames:CookiePreference', cookiePreference_whitelistedNames - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.

$sel:forward:CookiePreference', cookiePreference_forward - This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

cookiePreference_whitelistedNames :: Lens' CookiePreference (Maybe CookieNames) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.

cookiePreference_forward :: Lens' CookiePreference ItemSelection Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.