Package software.amazon.awscdk.services.cloudfront

Interface CfnCachePolicy.CookiesConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCachePolicy.CookiesConfigProperty.Jsii$Proxy

Enclosing class:

CfnCachePolicy

@Stability(Stable)
public static interface CfnCachePolicy.CookiesConfigProperty
extends software.amazon.jsii.JsiiSerializable

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CookiesConfigProperty cookiesConfigProperty = CookiesConfigProperty.builder()
         .cookieBehavior("cookieBehavior")
         // the properties below are optional
         .cookies(List.of("cookies"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCachePolicy.CookiesConfigProperty.Builder	A builder for CfnCachePolicy.CookiesConfigProperty
static final class	CfnCachePolicy.CookiesConfigProperty.Jsii$Proxy	An implementation for CfnCachePolicy.CookiesConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnCachePolicy.CookiesConfigProperty.Builder	builder()
String	getCookieBehavior()	Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
default List<String>	getCookies()	Contains a list of cookie names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCookieBehavior

@Stability(Stable)
@NotNull
String getCookieBehavior()

Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

Valid values are:

• none – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
• whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in the cache key and in requests that CloudFront sends to the origin.
• allExcept – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except for those that are listed in the CookieNames type, which are not included.
• all – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html#cfn-cloudfront-cachepolicy-cookiesconfig-cookiebehavior

getCookies

@Stability(Stable)
@Nullable
default List<String> getCookies()

Contains a list of cookie names.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html#cfn-cloudfront-cachepolicy-cookiesconfig-cookies

builder

@Stability(Stable)
static CfnCachePolicy.CookiesConfigProperty.Builder builder()

Returns:

a CfnCachePolicy.CookiesConfigProperty.Builder of CfnCachePolicy.CookiesConfigProperty