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.

Attributes:

`IP_MODE_IPV4`	A constant which can be used with the ip_mode property of a CreateLoadBalancerDetails.
`IP_MODE_IPV6`	A constant which can be used with the ip_mode property of a CreateLoadBalancerDetails.
`backend_sets`	Gets the backend_sets of this CreateLoadBalancerDetails.
`certificates`	Gets the certificates of this CreateLoadBalancerDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateLoadBalancerDetails.
`defined_tags`	Gets the defined_tags of this CreateLoadBalancerDetails.
`display_name`	[Required] Gets the display_name of this CreateLoadBalancerDetails.
`freeform_tags`	Gets the freeform_tags of this CreateLoadBalancerDetails.
`hostnames`	Gets the hostnames of this CreateLoadBalancerDetails.
`ip_mode`	Gets the ip_mode of this CreateLoadBalancerDetails.
`ipv6_subnet_cidr`	Gets the ipv6_subnet_cidr of this CreateLoadBalancerDetails.
`is_delete_protection_enabled`	Gets the is_delete_protection_enabled of this CreateLoadBalancerDetails.
`is_private`	Gets the is_private of this CreateLoadBalancerDetails.
`is_request_id_enabled`	Gets the is_request_id_enabled of this CreateLoadBalancerDetails.
`listeners`	Gets the listeners of this CreateLoadBalancerDetails.
`network_security_group_ids`	Gets the network_security_group_ids of this CreateLoadBalancerDetails.
`path_route_sets`	Gets the path_route_sets of this CreateLoadBalancerDetails.
`request_id_header`	Gets the request_id_header of this CreateLoadBalancerDetails.
`reserved_ips`	Gets the reserved_ips of this CreateLoadBalancerDetails.
`rule_sets`	Gets the rule_sets of this CreateLoadBalancerDetails.
`security_attributes`	Gets the security_attributes of this CreateLoadBalancerDetails.
`shape_details`	Gets the shape_details of this CreateLoadBalancerDetails.
`shape_name`	[Required] Gets the shape_name of this CreateLoadBalancerDetails.
`ssl_cipher_suites`	Gets the ssl_cipher_suites of this CreateLoadBalancerDetails.
`subnet_ids`	[Required] Gets the subnet_ids of this CreateLoadBalancerDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateLoadBalancerDetails object with values from keyword arguments.

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.
shape_details (oci.load_balancer.models.ShapeDetails) – The value to assign to the shape_details property of this CreateLoadBalancerDetails.
is_private (bool) – The value to assign to the is_private property of this CreateLoadBalancerDetails.
is_delete_protection_enabled (bool) – The value to assign to the is_delete_protection_enabled 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”
ipv6_subnet_cidr (str) – The value to assign to the ipv6_subnet_cidr property of this CreateLoadBalancerDetails.
is_request_id_enabled (bool) – The value to assign to the is_request_id_enabled property of this CreateLoadBalancerDetails.
request_id_header (str) – The value to assign to the request_id_header property of this CreateLoadBalancerDetails.
reserved_ips (list[oci.load_balancer.models.ReservedIP]) – The value to assign to the reserved_ips property of this CreateLoadBalancerDetails.
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.
ssl_cipher_suites (dict(str, SSLCipherSuiteDetails)) – The value to assign to the ssl_cipher_suites 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.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateLoadBalancerDetails.
rule_sets (dict(str, RuleSetDetails)) – The value to assign to the rule_sets property of this CreateLoadBalancerDetails.

property backend_sets¶

Gets the backend_sets of this CreateLoadBalancerDetails.

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

property certificates¶

Gets the certificates of this CreateLoadBalancerDetails.

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

property 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

property 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))

property 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

property 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)

property hostnames¶

Gets the hostnames of this CreateLoadBalancerDetails.

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

property 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

property ipv6_subnet_cidr¶

Gets the ipv6_subnet_cidr of this CreateLoadBalancerDetails. Applies to IPV6 LB creation only.

Used to disambiguate which subnet prefix should be used to create an IPv6 LB.

Example: “2002::1234:abcd:ffff:c0a8:101/64”

Returns: The ipv6_subnet_cidr of this CreateLoadBalancerDetails.
Return type: str

property is_delete_protection_enabled¶

Gets the is_delete_protection_enabled of this CreateLoadBalancerDetails. Whether or not the load balancer has delete protection enabled.

If “true”, the loadbalancer will be protected against deletion if configured to accept traffic.

If “false”, the loadbalancer will not be protected against deletion.

Delete protection will not be enabled unless a value of “true” is provided. Example: true

Returns: The is_delete_protection_enabled of this CreateLoadBalancerDetails.
Return type: bool

property 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

property is_request_id_enabled¶

Gets the is_request_id_enabled of this CreateLoadBalancerDetails. Whether or not the load balancer has the Request Id feature enabled for HTTP listeners.

If “true”, the load balancer will attach a unique request id header to every request passed through from the load balancer to load balancer backends. This same request id header also will be added to the response the lb received from the backend handling the request before the load balancer returns the response to the requestor. The name of the unique request id header is set the by value of requestIdHeader.

If “false”, the loadbalancer not add this unique request id header to either the request passed through to the load balancer backends nor to the reponse returned to the user.

New load balancers have the Request Id feature disabled unless isRequestIdEnabled is set to true.

Example: true

Returns: The is_request_id_enabled of this CreateLoadBalancerDetails.
Return type: bool

property listeners¶

Gets the listeners of this CreateLoadBalancerDetails.

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

property 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]

property path_route_sets¶

Gets the path_route_sets of this CreateLoadBalancerDetails.

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

property request_id_header¶

Gets the request_id_header of this CreateLoadBalancerDetails. If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer.

If a request to the load balancer already contains a header with same name as specified in requestIdHeader then the load balancer will not change the value of that field.

If isRequestIdEnabled is false then this field is ignored.

If this field is not set or is set to “” then this field defaults to X-Request-Id

Notes: * Unless the header name is “” it must start with “X-” prefix. * Setting the header name to “” will set it to the default: X-Request-Id.

Returns: The request_id_header of this CreateLoadBalancerDetails.
Return type: str

property reserved_ips¶

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

Returns: The reserved_ips of this CreateLoadBalancerDetails.
Return type: list[oci.load_balancer.models.ReservedIP]

property rule_sets¶

Gets the rule_sets of this CreateLoadBalancerDetails.

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

property security_attributes¶

Gets the security_attributes of this CreateLoadBalancerDetails. Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”:”42”,”mode”:”audit”, “usagetype” : “zpr”}}}

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

property shape_details¶

Gets the shape_details of this CreateLoadBalancerDetails. The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.

Returns: The shape_details of this CreateLoadBalancerDetails.
Return type: oci.load_balancer.models.ShapeDetails

property 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: flexible NOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape

allowed would be Flexible

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

property ssl_cipher_suites¶

Gets the ssl_cipher_suites of this CreateLoadBalancerDetails.

Returns: The ssl_cipher_suites of this CreateLoadBalancerDetails.
Return type: dict(str, SSLCipherSuiteDetails)

property 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]