Menu
Elastic Load Balancing
API Reference (API Version 2012-06-01)

CreateLBCookieStickinessPolicy

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 back-end 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 Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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.

Type: Long

Required: No

LoadBalancerName

The name of the load balancer.

Type: String

Required: Yes

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.

Type: String

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicatePolicyName

A policy with the specified name already exists for this load balancer.

HTTP Status Code: 400

InvalidConfigurationRequest

The requested configuration change is not valid.

HTTP Status Code: 409

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400

TooManyPolicies

The quota for the number of policies for this load balancer has been reached.

HTTP Status Code: 400

Example

Generate a Stickiness Policy

This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=CreateLBCookieStickinessPolicy
&LoadBalancerName=my-loadbalancer
&PolicyName=my-duration-sticky-policy
&CookieExpirationPeriod=60
&Version=2012-06-01
&AUTHPARAMS