com.amazonaws.services.elasticloadbalancing.model

Class CreateLBCookieStickinessPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest

All Implemented Interfaces:

Serializable

public class CreateLBCookieStickinessPolicyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateLBCookieStickinessPolicy operation.

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

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

See Also:

AmazonElasticLoadBalancing.createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getCookieExpirationPeriod() The time period in seconds after which the cookie should be considered stale.
String	getLoadBalancerName() The name associated with the load balancer.
String	getPolicyName() The name of the policy being created.
int	hashCode()
void	setCookieExpirationPeriod(Long cookieExpirationPeriod) The time period in seconds after which the cookie should be considered stale.
void	setLoadBalancerName(String loadBalancerName) The name associated with 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.
CreateLBCookieStickinessPolicyRequest	withCookieExpirationPeriod(Long cookieExpirationPeriod) The time period in seconds after which the cookie should be considered stale.
CreateLBCookieStickinessPolicyRequest	withLoadBalancerName(String loadBalancerName) The name associated with the load balancer.
CreateLBCookieStickinessPolicyRequest	withPolicyName(String policyName) The name of the policy being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateLBCookieStickinessPolicyRequest

public CreateLBCookieStickinessPolicyRequest()

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

CreateLBCookieStickinessPolicyRequest

public CreateLBCookieStickinessPolicyRequest(String loadBalancerName,
                                     String policyName)

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

Parameters:

loadBalancerName - The name associated with 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.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

The name associated with the load balancer.

Returns:

The name associated with the load balancer.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)

The name associated with the load balancer.

Parameters:

loadBalancerName - The name associated with the load balancer.

withLoadBalancerName

public CreateLBCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName)

The name associated with the load balancer.

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

Parameters:

loadBalancerName - The name associated with 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 CreateLBCookieStickinessPolicyRequest 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.

getCookieExpirationPeriod

public Long getCookieExpirationPeriod()

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

Returns:

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

setCookieExpirationPeriod

public void setCookieExpirationPeriod(Long cookieExpirationPeriod)

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

Parameters:

cookieExpirationPeriod - The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

withCookieExpirationPeriod

public CreateLBCookieStickinessPolicyRequest withCookieExpirationPeriod(Long cookieExpirationPeriod)

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

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

Parameters:

cookieExpirationPeriod - The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

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