Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateBackendDetails

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

Properties

Optional backup

backup: undefined | false | true

Whether the load balancer should treat this server as a backup unit. If {@code 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 {@code backup} to a backend set that uses the IP Hash policy.

Example: {@code false}

Optional drain

drain: undefined | false | true

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

Example: {@code false}

ipAddress

ipAddress: string

The IP address of the backend server.

Example: {@code 10.0.0.3}

Optional offline

offline: undefined | false | true

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

Example: {@code false}

port

port: number

The communication port for the backend server.

Example: {@code 8080} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional weight

weight: undefined | number

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: {@code 3} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj