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.

Container for the parameters to the CreateLBCookieStickinessPolicy operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingRequest
      Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest

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

Syntax

C#
public class CreateLBCookieStickinessPolicyRequest : AmazonElasticLoadBalancingRequest
         IAmazonWebServiceRequest

The CreateLBCookieStickinessPolicyRequest type exposes the following members

Constructors

NameDescription
Public Method CreateLBCookieStickinessPolicyRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateLBCookieStickinessPolicyRequest(string, string)

Instantiates CreateLBCookieStickinessPolicyRequest with the parameterized properties

Properties

NameTypeDescription
Public Property CookieExpirationPeriod System.Int64

Gets and sets the property 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 Property LoadBalancerName System.String

Gets and sets the property LoadBalancerName.

The name of the load balancer.

Public Property PolicyName System.String

Gets and sets the property 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.

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 Standard:
Supported in: 1.3

.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