CreateNetworkLoadBalancerDetails

class oci.network_load_balancer.models.CreateNetworkLoadBalancerDetails(**kwargs)

Bases: object

The properties that define a network load balancer. For more information, see Managing a network load balancer.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, then contact an administrator. If you are an administrator who writes policies to give users access, then see Getting Started with Policies.

For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Methods

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

Attributes

backend_sets Gets the backend_sets of this CreateNetworkLoadBalancerDetails.
compartment_id [Required] Gets the compartment_id of this CreateNetworkLoadBalancerDetails.
defined_tags Gets the defined_tags of this CreateNetworkLoadBalancerDetails.
display_name [Required] Gets the display_name of this CreateNetworkLoadBalancerDetails.
freeform_tags Gets the freeform_tags of this CreateNetworkLoadBalancerDetails.
is_preserve_source_destination Gets the is_preserve_source_destination of this CreateNetworkLoadBalancerDetails.
is_private Gets the is_private of this CreateNetworkLoadBalancerDetails.
listeners Gets the listeners of this CreateNetworkLoadBalancerDetails.
network_security_group_ids Gets the network_security_group_ids of this CreateNetworkLoadBalancerDetails.
reserved_ips Gets the reserved_ips of this CreateNetworkLoadBalancerDetails.
subnet_id [Required] Gets the subnet_id of this CreateNetworkLoadBalancerDetails.
__init__(**kwargs)

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

Parameters:
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateNetworkLoadBalancerDetails.
  • display_name (str) – The value to assign to the display_name property of this CreateNetworkLoadBalancerDetails.
  • is_preserve_source_destination (bool) – The value to assign to the is_preserve_source_destination property of this CreateNetworkLoadBalancerDetails.
  • reserved_ips (list[oci.network_load_balancer.models.ReservedIP]) – The value to assign to the reserved_ips property of this CreateNetworkLoadBalancerDetails.
  • is_private (bool) – The value to assign to the is_private property of this CreateNetworkLoadBalancerDetails.
  • subnet_id (str) – The value to assign to the subnet_id property of this CreateNetworkLoadBalancerDetails.
  • network_security_group_ids (list[str]) – The value to assign to the network_security_group_ids property of this CreateNetworkLoadBalancerDetails.
  • listeners (dict(str, ListenerDetails)) – The value to assign to the listeners property of this CreateNetworkLoadBalancerDetails.
  • backend_sets (dict(str, BackendSetDetails)) – The value to assign to the backend_sets property of this CreateNetworkLoadBalancerDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateNetworkLoadBalancerDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateNetworkLoadBalancerDetails.
backend_sets

Gets the backend_sets of this CreateNetworkLoadBalancerDetails. Backend sets associated with the network load balancer.

Returns:The backend_sets of this CreateNetworkLoadBalancerDetails.
Return type:dict(str, BackendSetDetails)
compartment_id

[Required] Gets the compartment_id of this CreateNetworkLoadBalancerDetails. The OCID of the compartment containing the network load balancer.

Returns:The compartment_id of this CreateNetworkLoadBalancerDetails.
Return type:str
defined_tags

Gets the defined_tags of this CreateNetworkLoadBalancerDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this CreateNetworkLoadBalancerDetails.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this CreateNetworkLoadBalancerDetails. Network load balancer identifier, which can be renamed.

Returns:The display_name of this CreateNetworkLoadBalancerDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateNetworkLoadBalancerDetails. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this CreateNetworkLoadBalancerDetails.
Return type:dict(str, str)
is_preserve_source_destination

Gets the is_preserve_source_destination of this CreateNetworkLoadBalancerDetails. This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.

Returns:The is_preserve_source_destination of this CreateNetworkLoadBalancerDetails.
Return type:bool
is_private

Gets the is_private of this CreateNetworkLoadBalancerDetails. Whether the network load balancer has a virtual cloud network-local (private) IP address.

If “true”, then the service assigns a private IP address to the network load balancer.

If “false”, then the service assigns a public IP address to the network load balancer.

A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

Example: true

Returns:The is_private of this CreateNetworkLoadBalancerDetails.
Return type:bool
listeners

Gets the listeners of this CreateNetworkLoadBalancerDetails. Listeners associated with the network load balancer.

Returns:The listeners of this CreateNetworkLoadBalancerDetails.
Return type:dict(str, ListenerDetails)
network_security_group_ids

Gets the network_security_group_ids of this CreateNetworkLoadBalancerDetails. An array of network security groups OCIDs associated with the network load balancer.

During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

The benefits of associating the network load balancer with network security groups include:

  • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
  • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

Example: [“ocid1.nsg.oc1.phx.unique_ID”]

Returns:The network_security_group_ids of this CreateNetworkLoadBalancerDetails.
Return type:list[str]
reserved_ips

Gets the reserved_ips of this CreateNetworkLoadBalancerDetails. An array of reserved Ips.

Returns:The reserved_ips of this CreateNetworkLoadBalancerDetails.
Return type:list[oci.network_load_balancer.models.ReservedIP]
subnet_id

[Required] Gets the subnet_id of this CreateNetworkLoadBalancerDetails. The subnet in which the network load balancer is spawned OCIDs.

Returns:The subnet_id of this CreateNetworkLoadBalancerDetails.
Return type:str