CreateAppCookieStickinessPolicyRequest Class

Container for the parameters to the CreateAppCookieStickinessPolicy operation. Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

Inheritance Hierarchy

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

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

Syntax

public class CreateAppCookieStickinessPolicyRequest : AmazonElasticLoadBalancingRequest
         IAmazonWebServiceRequest

The CreateAppCookieStickinessPolicyRequest type exposes the following members

Constructors

	Name	Description
	CreateAppCookieStickinessPolicyRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	CreateAppCookieStickinessPolicyRequest(string, string, string)	Instantiates CreateAppCookieStickinessPolicyRequest with the parameterized properties

Properties

Name	Type	Description
CookieName	System.String	Gets and sets the property CookieName. The name of the application cookie used for stickiness.
LoadBalancerName	System.String	Gets and sets the property LoadBalancerName. The name of the load balancer.
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.

Name

Type

Description

CookieName

System.String

Gets and sets the property CookieName.

The name of the application cookie used for stickiness.

LoadBalancerName

System.String

Gets and sets the property LoadBalancerName.

The name of the load balancer.

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 that follows the sticky session lifetimes of the application-generated cookie.

To generate a stickiness policy for your load balancer


var client = new AmazonElasticLoadBalancingClient();
var response = client.CreateAppCookieStickinessPolicy(new CreateAppCookieStickinessPolicyRequest 
{
    CookieName = "my-app-cookie",
    LoadBalancerName = "my-load-balancer",
    PolicyName = "my-app-cookie-policy"
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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