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

Note:

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

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

Syntax

C#
public abstract CreateAppCookieStickinessPolicyResponse CreateAppCookieStickinessPolicy(
         CreateAppCookieStickinessPolicyRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest

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

Return Value
The response from the CreateAppCookieStickinessPolicy 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 that follows the sticky session lifetimes of the application-generated cookie.

To generate a stickiness policy for your load balancer


var response = client.CreateAppCookieStickinessPolicy(new CreateAppCookieStickinessPolicyRequest 
{
    CookieName = "my-app-cookie",
    LoadBalancerName = "my-load-balancer",
    PolicyName = "my-app-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