Skip to content

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie

Description

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 create_lb_cookie_stickiness_policy, 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.

Usage

elb_create_app_cookie_stickiness_policy(LoadBalancerName, PolicyName,
  CookieName)

Arguments

  • LoadBalancerName

    [required] The name of the load balancer.

  • PolicyName

    [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.

  • CookieName

    [required] The name of the application cookie used for stickiness.

Value

An empty list.

Request syntax

svc$create_app_cookie_stickiness_policy(
  LoadBalancerName = "string",
  PolicyName = "string",
  CookieName = "string"
)

Examples

# This example generates a stickiness policy that follows the sticky
# session lifetimes of the application-generated cookie.
svc$create_app_cookie_stickiness_policy(
  CookieName = "my-app-cookie",
  LoadBalancerName = "my-load-balancer",
  PolicyName = "my-app-cookie-policy"
)