com.amazonaws.services.lightsail.model

Class CookieObject

java.lang.Object

com.amazonaws.services.lightsail.model.CookieObject

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CookieObject
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CookieObject()

Method Summary

Modifier and Type	Method and Description
CookieObject	clone()
boolean	equals(Object obj)
List<String>	getCookiesAllowList() The specific cookies to forward to your distribution's origin.
String	getOption() Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCookiesAllowList(Collection<String> cookiesAllowList) The specific cookies to forward to your distribution's origin.
void	setOption(String option) Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
String	toString() Returns a string representation of this object.
CookieObject	withCookiesAllowList(Collection<String> cookiesAllowList) The specific cookies to forward to your distribution's origin.
CookieObject	withCookiesAllowList(String... cookiesAllowList) The specific cookies to forward to your distribution's origin.
CookieObject	withOption(ForwardValues option) Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
CookieObject	withOption(String option) Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CookieObject

public CookieObject()

Method Detail

setOption

public void setOption(String option)

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Parameters:

option - Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

See Also:

ForwardValues

getOption

public String getOption()

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Returns:

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

See Also:

ForwardValues

withOption

public CookieObject withOption(String option)

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Parameters:

option - Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForwardValues

withOption

public CookieObject withOption(ForwardValues option)

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Parameters:

option - Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForwardValues

getCookiesAllowList

public List<String> getCookiesAllowList()

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

Returns:

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

setCookiesAllowList

public void setCookiesAllowList(Collection<String> cookiesAllowList)

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

Parameters:

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

withCookiesAllowList

public CookieObject withCookiesAllowList(String... cookiesAllowList)

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

NOTE: This method appends the values to the existing list (if any). Use setCookiesAllowList(java.util.Collection) or withCookiesAllowList(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withCookiesAllowList

public CookieObject withCookiesAllowList(Collection<String> cookiesAllowList)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CookieObject clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.