ElasticLoadBalancing / Client / create_lb_cookie_stickiness_policy

create_lb_cookie_stickiness_policy

ElasticLoadBalancing.Client.create_lb_cookie_stickiness_policy(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_lb_cookie_stickiness_policy(
    LoadBalancerName='string',
    PolicyName='string',
    CookieExpirationPeriod=123
)

Parameters:

• LoadBalancerName (string) –

  [REQUIRED]

  The name of the load balancer.

• PolicyName (string) –

  [REQUIRED]

  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.

• CookieExpirationPeriod (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  Contains the output for CreateLBCookieStickinessPolicy.

Exceptions

• ElasticLoadBalancing.Client.exceptions.AccessPointNotFoundException

• ElasticLoadBalancing.Client.exceptions.DuplicatePolicyNameException

• ElasticLoadBalancing.Client.exceptions.TooManyPoliciesException

• ElasticLoadBalancing.Client.exceptions.InvalidConfigurationRequestException

Examples

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

response = client.create_lb_cookie_stickiness_policy(
    CookieExpirationPeriod=60,
    LoadBalancerName='my-load-balancer',
    PolicyName='my-duration-cookie-policy',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}