com.amazonaws.services.elasticloadbalancing.model
Class CreateAppCookieStickinessPolicyRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest

public class CreateAppCookieStickinessPolicyRequest
extends AmazonWebServiceRequest

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 LoadBalancer 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.

See Also:
AmazonElasticLoadBalancing.createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest)

Constructor Summary
CreateAppCookieStickinessPolicyRequest()
          Default constructor for a new CreateAppCookieStickinessPolicyRequest object.
CreateAppCookieStickinessPolicyRequest(String loadBalancerName, String policyName, String cookieName)
          Constructs a new CreateAppCookieStickinessPolicyRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 String getCookieName()
          Name of the application cookie used for stickiness.
 String getLoadBalancerName()
          The name associated with the LoadBalancer.
 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 associated with the LoadBalancer.
 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 associated with the LoadBalancer.
 CreateAppCookieStickinessPolicyRequest withPolicyName(String policyName)
          The name of the policy being created.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 associated with the LoadBalancer. The name must be unique within the client AWS account.
policyName - The name of the policy being created. The name must be unique within the set of policies for this LoadBalancer.
cookieName - Name of the application cookie used for stickiness.
Method Detail

getLoadBalancerName

public String getLoadBalancerName()
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Returns:
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.

withLoadBalancerName

public CreateAppCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName)
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

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

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.
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 LoadBalancer.

Returns:
The name of the policy being created. The name must be unique within the set of policies for this LoadBalancer.

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 LoadBalancer.

Parameters:
policyName - The name of the policy being created. The name must be unique within the set of policies for this LoadBalancer.

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 LoadBalancer.

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 LoadBalancer.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.