BackendSet¶
- class oci.load_balancer.models.BackendSet(**kwargs)¶
Bases:
objectThe configuration of a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets.
Note: The sessionPersistenceConfiguration (application cookie stickiness) and lbCookieSessionPersistenceConfiguration (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Methods:
__init__(**kwargs)Initializes a new BackendSet object with values from keyword arguments.
Attributes:
Gets the backend_max_connections of this BackendSet.
[Required] Gets the backends of this BackendSet.
[Required] Gets the health_checker of this BackendSet.
Gets the lb_cookie_session_persistence_configuration of this BackendSet.
[Required] Gets the name of this BackendSet.
[Required] Gets the policy of this BackendSet.
Gets the session_persistence_configuration of this BackendSet.
Gets the ssl_configuration of this BackendSet.
- __init__(**kwargs)¶
Initializes a new BackendSet object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this BackendSet.
policy (str) – The value to assign to the policy property of this BackendSet.
backends (list[oci.load_balancer.models.Backend]) – The value to assign to the backends property of this BackendSet.
backend_max_connections (int) – The value to assign to the backend_max_connections property of this BackendSet.
health_checker (oci.load_balancer.models.HealthChecker) – The value to assign to the health_checker property of this BackendSet.
ssl_configuration (oci.load_balancer.models.SSLConfiguration) – The value to assign to the ssl_configuration property of this BackendSet.
session_persistence_configuration (oci.load_balancer.models.SessionPersistenceConfigurationDetails) – The value to assign to the session_persistence_configuration property of this BackendSet.
lb_cookie_session_persistence_configuration (oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails) – The value to assign to the lb_cookie_session_persistence_configuration property of this BackendSet.
- property backend_max_connections¶
Gets the backend_max_connections of this BackendSet. The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited.
Example: 300
- Returns
The backend_max_connections of this BackendSet.
- Return type
int
- property backends¶
[Required] Gets the backends of this BackendSet.
- Returns
The backends of this BackendSet.
- Return type
- property health_checker¶
[Required] Gets the health_checker of this BackendSet.
- Returns
The health_checker of this BackendSet.
- Return type
- property lb_cookie_session_persistence_configuration¶
Gets the lb_cookie_session_persistence_configuration of this BackendSet.
- Returns
The lb_cookie_session_persistence_configuration of this BackendSet.
- Return type
oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails
- property name¶
[Required] Gets the name of this BackendSet. A friendly name for the backend set. It must be unique and it cannot be changed.
Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
Example: example_backend_set
- Returns
The name of this BackendSet.
- Return type
str
- property policy¶
[Required] Gets the policy of this BackendSet. The load balancer policy for the backend set. To get a list of available policies, use the
list_policies()operation.Example: LEAST_CONNECTIONS
- Returns
The policy of this BackendSet.
- Return type
str
- property session_persistence_configuration¶
Gets the session_persistence_configuration of this BackendSet.
- Returns
The session_persistence_configuration of this BackendSet.
- Return type
oci.load_balancer.models.SessionPersistenceConfigurationDetails
- property ssl_configuration¶
Gets the ssl_configuration of this BackendSet.
- Returns
The ssl_configuration of this BackendSet.
- Return type