public class CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable
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 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 Duration-Based Session Stickiness in the Classic Load Balancers Guide.
Constructor and Description |
---|
CreateLBCookieStickinessPolicyRequest()
Default constructor for CreateLBCookieStickinessPolicyRequest object.
|
CreateLBCookieStickinessPolicyRequest(String loadBalancerName,
String policyName)
Constructs a new CreateLBCookieStickinessPolicyRequest object.
|
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 of 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 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.
|
CreateLBCookieStickinessPolicyRequest |
withCookieExpirationPeriod(Long cookieExpirationPeriod)
The time period, in seconds, after which the cookie should be considered
stale.
|
CreateLBCookieStickinessPolicyRequest |
withLoadBalancerName(String loadBalancerName)
The name of the load balancer.
|
CreateLBCookieStickinessPolicyRequest |
withPolicyName(String policyName)
The name of the policy being created.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public CreateLBCookieStickinessPolicyRequest()
public CreateLBCookieStickinessPolicyRequest(String loadBalancerName, String policyName)
loadBalancerName
- The name of the load balancer.
policyName
- The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
public String getLoadBalancerName()
The name of the load balancer.
The name of the load balancer.
public void setLoadBalancerName(String loadBalancerName)
The name of the load balancer.
loadBalancerName
- The name of the load balancer.
public CreateLBCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName)
The name of the load balancer.
Returns a reference to this object so that method calls can be chained together.
loadBalancerName
- The name of the load balancer.
public String getPolicyName()
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
public void setPolicyName(String policyName)
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
policyName
- The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
public CreateLBCookieStickinessPolicyRequest withPolicyName(String policyName)
The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This 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.
policyName
- The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.
public Long getCookieExpirationPeriod()
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
public void setCookieExpirationPeriod(Long cookieExpirationPeriod)
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
cookieExpirationPeriod
- The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
public CreateLBCookieStickinessPolicyRequest withCookieExpirationPeriod(Long cookieExpirationPeriod)
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
Returns a reference to this object so that method calls can be chained together.
cookieExpirationPeriod
- The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2018. All rights reserved.