software.amazon.awscdk.services.lightsail

Interface CfnDistribution.CookieObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.CookieObjectProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(value=Stable)
public static interface CfnDistribution.CookieObjectProperty
extends software.amazon.jsii.JsiiSerializable

`CookieObject` is a property of the [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) property. It describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

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.lightsail.*;
 CookieObjectProperty cookieObjectProperty = CookieObjectProperty.builder()
         .cookiesAllowList(List.of("cookiesAllowList"))
         .option("option")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDistribution.CookieObjectProperty.Builder A builder for CfnDistribution.CookieObjectProperty
static class	CfnDistribution.CookieObjectProperty.Jsii$Proxy An implementation for CfnDistribution.CookieObjectProperty

Method Summary

Modifier and Type	Method and Description
static CfnDistribution.CookieObjectProperty.Builder	builder()
default List<String>	getCookiesAllowList() The specific cookies to forward to your distribution's origin.
default String	getOption() Specifies which cookies to forward to the distribution's origin for a cache behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCookiesAllowList

@Stability(value=Stable)
 @Nullable
default List<String> getCookiesAllowList()

The specific cookies to forward to your distribution's origin.

getOption

@Stability(value=Stable)
 @Nullable
default String getOption()

Specifies which cookies to forward to the distribution's origin for a cache behavior.

Use one of the following configurations for your distribution:

• all - Forwards all cookies to your origin.
• none - Doesn’t forward cookies to your origin.
• allow-list - Forwards only the cookies that you specify using the CookiesAllowList parameter.

builder

@Stability(value=Stable)
static CfnDistribution.CookieObjectProperty.Builder builder()

Returns:

a CfnDistribution.CookieObjectProperty.Builder of CfnDistribution.CookieObjectProperty