Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateLoadBalancerDetails

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.

Properties

Optional backendSets

backendSets: undefined | object

Optional certificates

certificates: undefined | object

compartmentId

compartmentId: string

The OCID of the compartment in which to create the load balancer.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: {@code example_load_balancer}

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

Optional hostnames

hostnames: undefined | object

Optional ipMode

ipMode: IpMode

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\"

Optional isDeleteProtectionEnabled

isDeleteProtectionEnabled: undefined | false | true

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: {@code true}

Optional isPrivate

isPrivate: undefined | false | true

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](https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).

Example: {@code true}

Optional isRequestIdEnabled

isRequestIdEnabled: undefined | false | true

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: {@code true}

Optional listeners

listeners: undefined | object

Optional networkSecurityGroupIds

networkSecurityGroupIds: Array<string>

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: {@code [\"ocid1.nsg.oc1.phx.unique_ID\"]}

Optional pathRouteSets

pathRouteSets: undefined | object

Optional requestIdHeader

requestIdHeader: undefined | string

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.

Optional reservedIps

reservedIps: Array<ReservedIP>

An array of reserved Ips.

Optional ruleSets

ruleSets: undefined | object

Optional shapeDetails

shapeDetails: model.ShapeDetails

The configuration details to create load balancer using Flexible shape. This is required only if shapeName is {@code Flexible}.

shapeName

shapeName: string

A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the {@link #listShapes(ListShapesRequest) listShapes} operation.

Example: {@code flexible} NOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be {@code Flexible}

Optional sslCipherSuites

sslCipherSuites: undefined | object

subnetIds

subnetIds: Array<string>

An array of subnet OCIDs.

Functions

getDeserializedJsonObj

getJsonObj