Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LoadBalancer

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

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

For information about endpoints and signing API requests, see [About the API](https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](https://docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).

Properties

Optional backendSets

backendSets: undefined | object

Optional certificates

certificates: undefined | object

compartmentId

compartmentId: string

The OCID of the compartment containing 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.

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

id

id: string

The OCID of the load balancer.

Optional ipAddresses

ipAddresses: Array<IpAddress>

An array of IP addresses.

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 is not be enabled unless this field is set to \"true\". 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.

Example: {@code true}

lifecycleState

lifecycleState: LifecycleState

The current state of the load balancer.

Optional listeners

listeners: undefined | object

Optional networkSecurityGroupIds

networkSecurityGroupIds: Array<string>

An array of NSG OCIDs associated with the load balancer.

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

The benefits of associating the load balancer with NSGs 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\"]

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 this field is set to \"\" this field defaults to X-Request-Id.

Optional routingPolicies

routingPolicies: undefined | object

Optional ruleSets

ruleSets: undefined | object

Optional shapeDetails

shapeDetails: model.ShapeDetails

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 100Mbps}

Optional sslCipherSuites

sslCipherSuites: undefined | object

Optional subnetIds

subnetIds: Array<string>

An array of subnet OCIDs.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

timeCreated

timeCreated: Date

The date and time the load balancer was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj