CreateBackendDetails

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

Bases: object

The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers.

__init__(**kwargs)

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

Parameters:
  • ip_address (str) -- The value to assign to the ip_address property of this CreateBackendDetails.
  • port (int) -- The value to assign to the port property of this CreateBackendDetails.
  • weight (int) -- The value to assign to the weight property of this CreateBackendDetails.
  • backup (bool) -- The value to assign to the backup property of this CreateBackendDetails.
  • drain (bool) -- The value to assign to the drain property of this CreateBackendDetails.
  • offline (bool) -- The value to assign to the offline property of this CreateBackendDetails.
backup

Gets the backup of this CreateBackendDetails. Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

Example: false

Returns:The backup of this CreateBackendDetails.
Return type:bool
drain

Gets the drain of this CreateBackendDetails. Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.

Example: false

Returns:The drain of this CreateBackendDetails.
Return type:bool
ip_address

[Required] Gets the ip_address of this CreateBackendDetails. The IP address of the backend server.

Example: 10.0.0.3

Returns:The ip_address of this CreateBackendDetails.
Return type:str
offline

Gets the offline of this CreateBackendDetails. Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.

Example: false

Returns:The offline of this CreateBackendDetails.
Return type:bool
port

[Required] Gets the port of this CreateBackendDetails. The communication port for the backend server.

Example: 8080

Returns:The port of this CreateBackendDetails.
Return type:int
weight

Gets the weight of this CreateBackendDetails. The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work.

Example: 3

Returns:The weight of this CreateBackendDetails.
Return type:int