@Generated(value="software.amazon.awssdk:codegen") public class CookiePreference extends Object implements ToCopyableBuilder<CookiePreference.Builder,CookiePreference>
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 How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
CookiePreference.Builder |
Modifier and Type | Method and Description |
---|---|
static CookiePreference.Builder |
builder() |
boolean |
equals(Object obj) |
ItemSelection |
forward()
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. |
String |
forwardString()
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. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
static Class<? extends CookiePreference.Builder> |
serializableBuilderClass() |
CookiePreference.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
CookieNames |
whitelistedNames()
Required if you specify
whitelist for the value of Forward: . |
copy
public ItemSelection forward()
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.
If the service returns an enum value that is not available in the current SDK version, forward
will
return ItemSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
forwardString()
.
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.
ItemSelection
public String forwardString()
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.
If the service returns an enum value that is not available in the current SDK version, forward
will
return ItemSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
forwardString()
.
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.
ItemSelection
public CookieNames whitelistedNames()
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 Amazon CloudFront Limits in the AWS General Reference.
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 Amazon CloudFront Limits in the AWS General Reference.
public CookiePreference.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CookiePreference.Builder,CookiePreference>
public static CookiePreference.Builder builder()
public static Class<? extends CookiePreference.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.