com.amazonaws.services.elasticloadbalancing.model

Class CreateAppCookieStickinessPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest

All Implemented Interfaces:

Serializable

public class CreateAppCookieStickinessPolicyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateAppCookieStickinessPolicy operation.

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

NOTE: An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.

For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide .

See Also:

AmazonElasticLoadBalancing.createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAppCookieStickinessPolicyRequest() Default constructor for a new CreateAppCookieStickinessPolicyRequest object.
CreateAppCookieStickinessPolicyRequest(String loadBalancerName, String policyName, String cookieName) Constructs a new CreateAppCookieStickinessPolicyRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCookieName() Name of the application cookie used for stickiness.
String	getLoadBalancerName() The name of the load balancer.
String	getPolicyName() The name of the policy being created.
int	hashCode()
void	setCookieName(String cookieName) Name of the application cookie used for stickiness.
void	setLoadBalancerName(String loadBalancerName) The name of the load balancer.
void	setPolicyName(String policyName) The name of the policy being created.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateAppCookieStickinessPolicyRequest	withCookieName(String cookieName) Name of the application cookie used for stickiness.
CreateAppCookieStickinessPolicyRequest	withLoadBalancerName(String loadBalancerName) The name of the load balancer.
CreateAppCookieStickinessPolicyRequest	withPolicyName(String policyName) The name of the policy being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAppCookieStickinessPolicyRequest

public CreateAppCookieStickinessPolicyRequest()

Default constructor for a new CreateAppCookieStickinessPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateAppCookieStickinessPolicyRequest

public CreateAppCookieStickinessPolicyRequest(String loadBalancerName,
                                      String policyName,
                                      String cookieName)

Constructs a new CreateAppCookieStickinessPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

loadBalancerName - The name of the load balancer.

policyName - The name of the policy being created. The name must be unique within the set of policies for this load balancer.

cookieName - Name of the application cookie used for stickiness.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

The name of the load balancer.

Returns:

The name of the load balancer.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)

The name of the load balancer.

Parameters:

loadBalancerName - The name of the load balancer.

withLoadBalancerName

public CreateAppCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName)

The name of the load balancer.

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

Parameters:

loadBalancerName - The name of the load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyName

public String getPolicyName()

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

Returns:

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

setPolicyName

public void setPolicyName(String policyName)

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

Parameters:

policyName - The name of the policy being created. The name must be unique within the set of policies for this load balancer.

withPolicyName

public CreateAppCookieStickinessPolicyRequest withPolicyName(String policyName)

The name of the policy being created. The name must be unique within the set of policies for this load balancer.

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

Parameters:

policyName - The name of the policy being created. The name must be unique within the set of policies for this load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

getCookieName

public String getCookieName()

Name of the application cookie used for stickiness.

Returns:

Name of the application cookie used for stickiness.

setCookieName

public void setCookieName(String cookieName)

Name of the application cookie used for stickiness.

Parameters:

cookieName - Name of the application cookie used for stickiness.

withCookieName

public CreateAppCookieStickinessPolicyRequest withCookieName(String cookieName)

Name of the application cookie used for stickiness.

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

Parameters:

cookieName - Name of the application cookie used for stickiness.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object