LBCookieSessionPersistenceConfigurationDetails

class oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails(**kwargs)

Bases: object

The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).

Session persistence enables the Load Balancing service to direct all requests that originate from a single logical client to a single backend web server. For more information, see Session Persistence.

When you configure LB cookie stickiness, the load balancer inserts a cookie into the response. The parameters configured in the cookie enable session stickiness. This method is useful when you have applications and Web backend services that cannot generate their own cookies.

Path route rules take precedence to determine the target backend server. The load balancer verifies that session stickiness is enabled for the backend server and that the cookie configuration (domain, path, and cookie hash) is valid for the target. The system ignores invalid cookies.

To disable LB cookie stickiness on a running load balancer, use the update_backend_set() operation and specify null for the LBCookieSessionPersistenceConfigurationDetails object.

Example: LBCookieSessionPersistenceConfigurationDetails: null

Note: SessionPersistenceConfigurationDetails (application cookie stickiness) and LBCookieSessionPersistenceConfigurationDetails (LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

__init__(**kwargs)

Initializes a new LBCookieSessionPersistenceConfigurationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • cookie_name (str) -- The value to assign to the cookie_name property of this LBCookieSessionPersistenceConfigurationDetails.
  • disable_fallback (bool) -- The value to assign to the disable_fallback property of this LBCookieSessionPersistenceConfigurationDetails.
  • domain (str) -- The value to assign to the domain property of this LBCookieSessionPersistenceConfigurationDetails.
  • path (str) -- The value to assign to the path property of this LBCookieSessionPersistenceConfigurationDetails.
  • max_age_in_seconds (int) -- The value to assign to the max_age_in_seconds property of this LBCookieSessionPersistenceConfigurationDetails.
  • is_secure (bool) -- The value to assign to the is_secure property of this LBCookieSessionPersistenceConfigurationDetails.
  • is_http_only (bool) -- The value to assign to the is_http_only property of this LBCookieSessionPersistenceConfigurationDetails.
cookie_name

Gets the cookie_name of this LBCookieSessionPersistenceConfigurationDetails. The name of the cookie inserted by the load balancer. If this field is not configured, the cookie name defaults to "X-Oracle-BMC-LBS-Route".

Example: example_cookie

Notes:

  • Ensure that the cookie name used at the backend application servers is different from the cookie name used at the load balancer. To minimize the chance of name collision, Oracle recommends that you use a prefix such as "X-Oracle-OCI-" for this field.
  • If a backend server and the load balancer both insert cookies with the same name, the client or browser behavior can vary depending on the domain and path values associated with the cookie. If the name, domain, and path values of the Set-cookie generated by a backend server and the Set-cookie generated by the load balancer are all the same, the client or browser treats them as one cookie and returns only one of the cookie values in subsequent requests. If both Set-cookie names are the same, but the domain and path names are different, the client or browser treats them as two different cookies.
Returns:The cookie_name of this LBCookieSessionPersistenceConfigurationDetails.
Return type:str
disable_fallback

Gets the disable_fallback of this LBCookieSessionPersistenceConfigurationDetails. Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false.

Example: false

Returns:The disable_fallback of this LBCookieSessionPersistenceConfigurationDetails.
Return type:bool
domain

Gets the domain of this LBCookieSessionPersistenceConfigurationDetails. The domain in which the cookie is valid. The Set-cookie header inserted by the load balancer contains a domain attribute with the specified value.

This attribute has no default value. If you do not specify a value, the load balancer does not insert the domain attribute into the Set-cookie header.

Notes:

  • RFC 6265 - HTTP State Management Mechanism describes client and browser behavior when the domain attribute is present or not present in the Set-cookie header.

    If the value of the Domain attribute is example.com in the Set-cookie header, the client includes the same cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.abc.example.com. If the Domain attribute is not present, the client returns the cookie only for the domain to which the original request was made.

  • Ensure that this attribute specifies the correct domain value. If the Domain attribute in the Set-cookie header does not include the domain to which the original request was made, the client or browser might reject the cookie. As specified in RFC 6265, the client accepts a cookie with the Domain attribute value example.com or www.example.com sent from www.example.com. It does not accept a cookie with the Domain attribute abc.example.com or www.abc.example.com sent from www.example.com.

Example: example.com

Returns:The domain of this LBCookieSessionPersistenceConfigurationDetails.
Return type:str
is_http_only

Gets the is_http_only of this LBCookieSessionPersistenceConfigurationDetails. Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels.

Example: true

Returns:The is_http_only of this LBCookieSessionPersistenceConfigurationDetails.
Return type:bool
is_secure

Gets the is_secure of this LBCookieSessionPersistenceConfigurationDetails. Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.

Note: If you set this field to true, you cannot associate the corresponding backend set with an HTTP listener.

Example: true

Returns:The is_secure of this LBCookieSessionPersistenceConfigurationDetails.
Return type:bool
max_age_in_seconds

Gets the max_age_in_seconds of this LBCookieSessionPersistenceConfigurationDetails. The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-Age attribute with the specified value.

The specified value must be at least one second. There is no default value for this attribute. If you do not specify a value, the load balancer does not include the Max-Age attribute in the Set-cookie header. In most cases, the client or browser retains the cookie until the current session ends, as defined by the client.

Example: 3600

Returns:The max_age_in_seconds of this LBCookieSessionPersistenceConfigurationDetails.
Return type:int
path

Gets the path of this LBCookieSessionPersistenceConfigurationDetails. The path in which the cookie is valid. The Set-cookie header inserted by the load balancer contains a Path attribute with the specified value.

Clients include the cookie in an HTTP request only if the path portion of the request-uri matches, or is a subdirectory of, the cookie's Path attribute.

The default value is /.

Example: /example

Returns:The path of this LBCookieSessionPersistenceConfigurationDetails.
Return type:str