CreateBackendSetDetails¶

class oci.network_load_balancer.models.CreateBackendSetDetails(**kwargs)¶

Bases: object

The configuration details for creating a backend set in a network load balancer. For more information about backend set configuration, see Backend Sets for Network Load Balancers.

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

Attributes

`IP_VERSION_IPV4`	A constant which can be used with the ip_version property of a CreateBackendSetDetails.
`IP_VERSION_IPV6`	A constant which can be used with the ip_version property of a CreateBackendSetDetails.
`POLICY_FIVE_TUPLE`	A constant which can be used with the policy property of a CreateBackendSetDetails.
`POLICY_THREE_TUPLE`	A constant which can be used with the policy property of a CreateBackendSetDetails.
`POLICY_TWO_TUPLE`	A constant which can be used with the policy property of a CreateBackendSetDetails.
`are_operationally_active_backends_preferred`	Gets the are_operationally_active_backends_preferred of this CreateBackendSetDetails.
`backends`	Gets the backends of this CreateBackendSetDetails.
`health_checker`	[Required] Gets the health_checker of this CreateBackendSetDetails.
`ip_version`	Gets the ip_version of this CreateBackendSetDetails.
`is_fail_open`	Gets the is_fail_open of this CreateBackendSetDetails.
`is_instant_failover_enabled`	Gets the is_instant_failover_enabled of this CreateBackendSetDetails.
`is_instant_failover_tcp_reset_enabled`	Gets the is_instant_failover_tcp_reset_enabled of this CreateBackendSetDetails.
`is_preserve_source`	Gets the is_preserve_source of this CreateBackendSetDetails.
`name`	[Required] Gets the name of this CreateBackendSetDetails.
`policy`	[Required] Gets the policy of this CreateBackendSetDetails.

Methods

__init__(**kwargs) Initializes a new CreateBackendSetDetails object with values from keyword arguments.

IP_VERSION_IPV4 = 'IPV4'¶: A constant which can be used with the ip_version property of a CreateBackendSetDetails. This constant has a value of “IPV4”

IP_VERSION_IPV6 = 'IPV6'¶: A constant which can be used with the ip_version property of a CreateBackendSetDetails. This constant has a value of “IPV6”

POLICY_FIVE_TUPLE = 'FIVE_TUPLE'¶: A constant which can be used with the policy property of a CreateBackendSetDetails. This constant has a value of “FIVE_TUPLE”

POLICY_THREE_TUPLE = 'THREE_TUPLE'¶: A constant which can be used with the policy property of a CreateBackendSetDetails. This constant has a value of “THREE_TUPLE”

POLICY_TWO_TUPLE = 'TWO_TUPLE'¶: A constant which can be used with the policy property of a CreateBackendSetDetails. This constant has a value of “TWO_TUPLE”

__init__(**kwargs)¶

Initializes a new CreateBackendSetDetails 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 CreateBackendSetDetails.
policy (str) – The value to assign to the policy property of this CreateBackendSetDetails. Allowed values for this property are: “TWO_TUPLE”, “THREE_TUPLE”, “FIVE_TUPLE”
is_preserve_source (bool) – The value to assign to the is_preserve_source property of this CreateBackendSetDetails.
is_fail_open (bool) – The value to assign to the is_fail_open property of this CreateBackendSetDetails.
is_instant_failover_enabled (bool) – The value to assign to the is_instant_failover_enabled property of this CreateBackendSetDetails.
is_instant_failover_tcp_reset_enabled (bool) – The value to assign to the is_instant_failover_tcp_reset_enabled property of this CreateBackendSetDetails.
are_operationally_active_backends_preferred (bool) – The value to assign to the are_operationally_active_backends_preferred property of this CreateBackendSetDetails.
ip_version (str) – The value to assign to the ip_version property of this CreateBackendSetDetails. Allowed values for this property are: “IPV4”, “IPV6”
backends (list[oci.network_load_balancer.models.BackendDetails]) – The value to assign to the backends property of this CreateBackendSetDetails.
health_checker (oci.network_load_balancer.models.HealthCheckerDetails) – The value to assign to the health_checker property of this CreateBackendSetDetails.

are_operationally_active_backends_preferred¶

Gets the are_operationally_active_backends_preferred of this CreateBackendSetDetails. If enabled, NLB supports active-standby backends. The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.

Returns:	The are_operationally_active_backends_preferred of this CreateBackendSetDetails.
Return type:	bool

backends¶

Gets the backends of this CreateBackendSetDetails. An array of backends to be associated with the backend set.

Returns:	The backends of this CreateBackendSetDetails.
Return type:	list[oci.network_load_balancer.models.BackendDetails]

health_checker¶

[Required] Gets the health_checker of this CreateBackendSetDetails.

Returns:	The health_checker of this CreateBackendSetDetails.
Return type:	oci.network_load_balancer.models.HealthCheckerDetails

ip_version¶

Gets the ip_version of this CreateBackendSetDetails. IP version associated with the backend set.

Allowed values for this property are: “IPV4”, “IPV6”

Returns:	The ip_version of this CreateBackendSetDetails.
Return type:	str

is_fail_open¶

Gets the is_fail_open of this CreateBackendSetDetails. If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.

Returns:	The is_fail_open of this CreateBackendSetDetails.
Return type:	bool

is_instant_failover_enabled¶

Gets the is_instant_failover_enabled of this CreateBackendSetDetails. If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.

Returns:	The is_instant_failover_enabled of this CreateBackendSetDetails.
Return type:	bool

is_instant_failover_tcp_reset_enabled¶

Gets the is_instant_failover_tcp_reset_enabled of this CreateBackendSetDetails. If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend. This only applies when using the instant failover. By default, TCP RST is enabled.

Returns:	The is_instant_failover_tcp_reset_enabled of this CreateBackendSetDetails.
Return type:	bool

is_preserve_source¶

Gets the is_preserve_source of this CreateBackendSetDetails. If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

Returns:	The is_preserve_source of this CreateBackendSetDetails.
Return type:	bool

name¶

[Required] Gets the name of this CreateBackendSetDetails. A user-friendly name for the backend set that must be unique and 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 CreateBackendSetDetails.
Return type:	str

policy¶

[Required] Gets the policy of this CreateBackendSetDetails. The network load balancer policy for the backend set.

Example: FIVE_TUPLE`

Allowed values for this property are: “TWO_TUPLE”, “THREE_TUPLE”, “FIVE_TUPLE”

Returns:	The policy of this CreateBackendSetDetails.
Return type:	str