CreateLoadBalancerDetails

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

Bases: object

The configuration details for creating a load balancer.

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

IP_MODE_IPV4 = 'IPV4'

A constant which can be used with the ip_mode property of a CreateLoadBalancerDetails. This constant has a value of "IPV4"

IP_MODE_IPV6 = 'IPV6'

A constant which can be used with the ip_mode property of a CreateLoadBalancerDetails. This constant has a value of "IPV6"

__init__(**kwargs)

Initializes a new CreateLoadBalancerDetails 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 CreateLoadBalancerDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreateLoadBalancerDetails.
  • shape_name (str) -- The value to assign to the shape_name property of this CreateLoadBalancerDetails.
  • is_private (bool) -- The value to assign to the is_private property of this CreateLoadBalancerDetails.
  • ip_mode (str) -- The value to assign to the ip_mode property of this CreateLoadBalancerDetails. Allowed values for this property are: "IPV4", "IPV6"
  • listeners (dict(str, ListenerDetails)) -- The value to assign to the listeners property of this CreateLoadBalancerDetails.
  • hostnames (dict(str, HostnameDetails)) -- The value to assign to the hostnames property of this CreateLoadBalancerDetails.
  • backend_sets (dict(str, BackendSetDetails)) -- The value to assign to the backend_sets property of this CreateLoadBalancerDetails.
  • network_security_group_ids (list[str]) -- The value to assign to the network_security_group_ids property of this CreateLoadBalancerDetails.
  • subnet_ids (list[str]) -- The value to assign to the subnet_ids property of this CreateLoadBalancerDetails.
  • certificates (dict(str, CertificateDetails)) -- The value to assign to the certificates property of this CreateLoadBalancerDetails.
  • path_route_sets (dict(str, PathRouteSetDetails)) -- The value to assign to the path_route_sets property of this CreateLoadBalancerDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateLoadBalancerDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateLoadBalancerDetails.
  • rule_sets (dict(str, RuleSetDetails)) -- The value to assign to the rule_sets property of this CreateLoadBalancerDetails.
backend_sets

Gets the backend_sets of this CreateLoadBalancerDetails.

Returns:The backend_sets of this CreateLoadBalancerDetails.
Return type:dict(str, BackendSetDetails)
certificates

Gets the certificates of this CreateLoadBalancerDetails.

Returns:The certificates of this CreateLoadBalancerDetails.
Return type:dict(str, CertificateDetails)
compartment_id

[Required] Gets the compartment_id of this CreateLoadBalancerDetails. The OCID of the compartment in which to create the load balancer.

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

Gets the defined_tags of this CreateLoadBalancerDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

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

[Required] Gets the display_name of this CreateLoadBalancerDetails. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: example_load_balancer

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

Gets the freeform_tags of this CreateLoadBalancerDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:The freeform_tags of this CreateLoadBalancerDetails.
Return type:dict(str, str)
hostnames

Gets the hostnames of this CreateLoadBalancerDetails.

Returns:The hostnames of this CreateLoadBalancerDetails.
Return type:dict(str, HostnameDetails)
ip_mode

Gets the ip_mode of this CreateLoadBalancerDetails. Whether the load balancer has an IPv4 or IPv6 IP address.

If "IPV4", the service assigns an IPv4 address and the load balancer supports IPv4 traffic.

If "IPV6", the service assigns an IPv6 address and the load balancer supports IPv6 traffic.

Example: "ipMode":"IPV6"

Allowed values for this property are: "IPV4", "IPV6"

Returns:The ip_mode of this CreateLoadBalancerDetails.
Return type:str
is_private

Gets the is_private of this CreateLoadBalancerDetails. Whether the load balancer has a VCN-local (private) IP address.

If "true", the service assigns a private IP address to the load balancer.

If "false", the service assigns a public IP address to the load balancer.

A public load balancer is accessible from the internet, depending on your VCN's security list rules. For more information about public and private load balancers, see How Load Balancing Works.

Example: true

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

Gets the listeners of this CreateLoadBalancerDetails.

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

Gets the network_security_group_ids of this CreateLoadBalancerDetails. An array of NSG OCIDs associated with this load balancer.

During the load balancer's creation, the service adds the new load balancer to the specified NSGs.

The benefits of using NSGs with the load balancer include:

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

Example: ["ocid1.nsg.oc1.phx.unique_ID"]

Returns:The network_security_group_ids of this CreateLoadBalancerDetails.
Return type:list[str]
path_route_sets

Gets the path_route_sets of this CreateLoadBalancerDetails.

Returns:The path_route_sets of this CreateLoadBalancerDetails.
Return type:dict(str, PathRouteSetDetails)
rule_sets

Gets the rule_sets of this CreateLoadBalancerDetails.

Returns:The rule_sets of this CreateLoadBalancerDetails.
Return type:dict(str, RuleSetDetails)
shape_name

[Required] Gets the shape_name of this CreateLoadBalancerDetails. A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the list_shapes() operation.

Example: 100Mbps

Returns:The shape_name of this CreateLoadBalancerDetails.
Return type:str
subnet_ids

[Required] Gets the subnet_ids of this CreateLoadBalancerDetails. An array of subnet OCIDs.

Returns:The subnet_ids of this CreateLoadBalancerDetails.
Return type:list[str]