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 Managing Backend Sets.

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

Attributes

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.
backends Gets the backends of this CreateBackendSetDetails.
health_checker [Required] Gets the health_checker 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.
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.
  • 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.
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
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