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

Bases: object

The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).

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

With application cookie stickiness, the load balancer enables session persistence only when the response from a backend application server includes a Set-cookie header with the user-specified cookie name.

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

Example: SessionPersistenceConfigurationDetails: 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.


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

  • cookie_name (str) -- The value to assign to the cookie_name property of this SessionPersistenceConfigurationDetails.
  • disable_fallback (bool) -- The value to assign to the disable_fallback property of this SessionPersistenceConfigurationDetails.

[Required] Gets the cookie_name of this SessionPersistenceConfigurationDetails. The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist.

Example: example_cookie

Returns:The cookie_name of this SessionPersistenceConfigurationDetails.
Return type:str

Gets the disable_fallback of this SessionPersistenceConfigurationDetails. 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 SessionPersistenceConfigurationDetails.
Return type:bool