AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 Balancer Guide.

Note:

For PCL this operation is only available in asynchronous form. Please refer to CreateLBCookieStickinessPolicyAsync.

Namespace: Amazon.ElasticLoadBalancing
Assembly: AWSSDK.ElasticLoadBalancing.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateLBCookieStickinessPolicyResponse CreateLBCookieStickinessPolicy(
         CreateLBCookieStickinessPolicyRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest

Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method.

Return Value
The response from the CreateLBCookieStickinessPolicy service method, as returned by ElasticLoadBalancing.

Exceptions

ExceptionCondition
AccessPointNotFoundException The specified load balancer does not exist.
DuplicatePolicyNameException A policy with the specified name already exists for this load balancer.
InvalidConfigurationRequestException The requested configuration change is not valid.
TooManyPoliciesException The quota for the number of policies for this load balancer has been reached.

Examples

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

To generate a duration-based stickiness policy for your load balancer


var response = client.CreateLBCookieStickinessPolicy(new CreateLBCookieStickinessPolicyRequest 
{
    CookieExpirationPeriod = 60,
    LoadBalancerName = "my-load-balancer",
    PolicyName = "my-duration-cookie-policy"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also