Docs Home
oci.LoadBalancer.LoadBalancer
Explore with Pulumi AI
This resource provides the Load Balancer resource in Oracle Cloud Infrastructure Load Balancer service.
Creates a new load balancer in the specified compartment. For general information about load balancers, see Overview of the Load Balancing Service.
For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn’t have to be in the same compartment as the VCN or backend set. If you’re not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see Overview of the IAM Service.
You must specify a display name for the load balancer. It does not have to be unique, and you can change it.
For information about Availability Domains, see
Regions and Availability Domains.
To get a list of Availability Domains, use the ListAvailabilityDomains operation
in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers.
When you create a load balancer, the system assigns an IP address. To get the IP address, use the GetLoadBalancer operation.
Supported Aliases
oci_load_balancer
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testLoadBalancer = new oci.loadbalancer.LoadBalancer("test_load_balancer", {
compartmentId: compartmentId,
displayName: loadBalancerDisplayName,
shape: loadBalancerShape,
subnetIds: loadBalancerSubnetIds,
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
ipMode: loadBalancerIpMode,
isDeleteProtectionEnabled: loadBalancerIsDeleteProtectionEnabled,
isPrivate: loadBalancerIsPrivate,
isRequestIdEnabled: loadBalancerIsRequestIdEnabled,
networkSecurityGroupIds: loadBalancerNetworkSecurityGroupIds,
requestIdHeader: loadBalancerRequestIdHeader,
reservedIps: [{
id: loadBalancerReservedIpsId,
}],
shapeDetails: {
maximumBandwidthInMbps: loadBalancerShapeDetailsMaximumBandwidthInMbps,
minimumBandwidthInMbps: loadBalancerShapeDetailsMinimumBandwidthInMbps,
},
});
import pulumi
import pulumi_oci as oci
test_load_balancer = oci.load_balancer.LoadBalancer("test_load_balancer",
compartment_id=compartment_id,
display_name=load_balancer_display_name,
shape=load_balancer_shape,
subnet_ids=load_balancer_subnet_ids,
defined_tags={
"Operations.CostCenter": "42",
},
freeform_tags={
"Department": "Finance",
},
ip_mode=load_balancer_ip_mode,
is_delete_protection_enabled=load_balancer_is_delete_protection_enabled,
is_private=load_balancer_is_private,
is_request_id_enabled=load_balancer_is_request_id_enabled,
network_security_group_ids=load_balancer_network_security_group_ids,
request_id_header=load_balancer_request_id_header,
reserved_ips=[{
"id": load_balancer_reserved_ips_id,
}],
shape_details={
"maximum_bandwidth_in_mbps": load_balancer_shape_details_maximum_bandwidth_in_mbps,
"minimum_bandwidth_in_mbps": load_balancer_shape_details_minimum_bandwidth_in_mbps,
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loadbalancer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := loadbalancer.NewLoadBalancer(ctx, "test_load_balancer", &loadbalancer.LoadBalancerArgs{
CompartmentId: pulumi.Any(compartmentId),
DisplayName: pulumi.Any(loadBalancerDisplayName),
Shape: pulumi.Any(loadBalancerShape),
SubnetIds: pulumi.Any(loadBalancerSubnetIds),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
IpMode: pulumi.Any(loadBalancerIpMode),
IsDeleteProtectionEnabled: pulumi.Any(loadBalancerIsDeleteProtectionEnabled),
IsPrivate: pulumi.Any(loadBalancerIsPrivate),
IsRequestIdEnabled: pulumi.Any(loadBalancerIsRequestIdEnabled),
NetworkSecurityGroupIds: pulumi.Any(loadBalancerNetworkSecurityGroupIds),
RequestIdHeader: pulumi.Any(loadBalancerRequestIdHeader),
ReservedIps: loadbalancer.LoadBalancerReservedIpArray{
&loadbalancer.LoadBalancerReservedIpArgs{
Id: pulumi.Any(loadBalancerReservedIpsId),
},
},
ShapeDetails: &loadbalancer.LoadBalancerShapeDetailsArgs{
MaximumBandwidthInMbps: pulumi.Any(loadBalancerShapeDetailsMaximumBandwidthInMbps),
MinimumBandwidthInMbps: pulumi.Any(loadBalancerShapeDetailsMinimumBandwidthInMbps),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testLoadBalancer = new Oci.LoadBalancer.LoadBalancer("test_load_balancer", new()
{
CompartmentId = compartmentId,
DisplayName = loadBalancerDisplayName,
Shape = loadBalancerShape,
SubnetIds = loadBalancerSubnetIds,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
IpMode = loadBalancerIpMode,
IsDeleteProtectionEnabled = loadBalancerIsDeleteProtectionEnabled,
IsPrivate = loadBalancerIsPrivate,
IsRequestIdEnabled = loadBalancerIsRequestIdEnabled,
NetworkSecurityGroupIds = loadBalancerNetworkSecurityGroupIds,
RequestIdHeader = loadBalancerRequestIdHeader,
ReservedIps = new[]
{
new Oci.LoadBalancer.Inputs.LoadBalancerReservedIpArgs
{
Id = loadBalancerReservedIpsId,
},
},
ShapeDetails = new Oci.LoadBalancer.Inputs.LoadBalancerShapeDetailsArgs
{
MaximumBandwidthInMbps = loadBalancerShapeDetailsMaximumBandwidthInMbps,
MinimumBandwidthInMbps = loadBalancerShapeDetailsMinimumBandwidthInMbps,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LoadBalancer.LoadBalancer;
import com.pulumi.oci.LoadBalancer.LoadBalancerArgs;
import com.pulumi.oci.LoadBalancer.inputs.LoadBalancerReservedIpArgs;
import com.pulumi.oci.LoadBalancer.inputs.LoadBalancerShapeDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testLoadBalancer = new LoadBalancer("testLoadBalancer", LoadBalancerArgs.builder()
.compartmentId(compartmentId)
.displayName(loadBalancerDisplayName)
.shape(loadBalancerShape)
.subnetIds(loadBalancerSubnetIds)
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.ipMode(loadBalancerIpMode)
.isDeleteProtectionEnabled(loadBalancerIsDeleteProtectionEnabled)
.isPrivate(loadBalancerIsPrivate)
.isRequestIdEnabled(loadBalancerIsRequestIdEnabled)
.networkSecurityGroupIds(loadBalancerNetworkSecurityGroupIds)
.requestIdHeader(loadBalancerRequestIdHeader)
.reservedIps(LoadBalancerReservedIpArgs.builder()
.id(loadBalancerReservedIpsId)
.build())
.shapeDetails(LoadBalancerShapeDetailsArgs.builder()
.maximumBandwidthInMbps(loadBalancerShapeDetailsMaximumBandwidthInMbps)
.minimumBandwidthInMbps(loadBalancerShapeDetailsMinimumBandwidthInMbps)
.build())
.build());
}
}
resources:
testLoadBalancer:
type: oci:LoadBalancer:LoadBalancer
name: test_load_balancer
properties:
compartmentId: ${compartmentId}
displayName: ${loadBalancerDisplayName}
shape: ${loadBalancerShape}
subnetIds: ${loadBalancerSubnetIds}
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
ipMode: ${loadBalancerIpMode}
isDeleteProtectionEnabled: ${loadBalancerIsDeleteProtectionEnabled}
isPrivate: ${loadBalancerIsPrivate}
isRequestIdEnabled: ${loadBalancerIsRequestIdEnabled}
networkSecurityGroupIds: ${loadBalancerNetworkSecurityGroupIds}
requestIdHeader: ${loadBalancerRequestIdHeader}
reservedIps:
- id: ${loadBalancerReservedIpsId}
shapeDetails:
maximumBandwidthInMbps: ${loadBalancerShapeDetailsMaximumBandwidthInMbps}
minimumBandwidthInMbps: ${loadBalancerShapeDetailsMinimumBandwidthInMbps}
Create LoadBalancer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);@overload
def LoadBalancer(resource_name: str,
args: LoadBalancerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LoadBalancer(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
display_name: Optional[str] = None,
shape: Optional[str] = None,
is_private: Optional[bool] = None,
is_delete_protection_enabled: Optional[bool] = None,
ip_mode: Optional[str] = None,
is_request_id_enabled: Optional[bool] = None,
network_security_group_ids: Optional[Sequence[str]] = None,
request_id_header: Optional[str] = None,
reserved_ips: Optional[Sequence[_loadbalancer.LoadBalancerReservedIpArgs]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
shape_details: Optional[_loadbalancer.LoadBalancerShapeDetailsArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None)func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
public LoadBalancer(String name, LoadBalancerArgs args)
public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)
type: oci:LoadBalancer:LoadBalancer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LoadBalancerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var loadBalancerResource = new Oci.LoadBalancer.LoadBalancer("loadBalancerResource", new()
{
CompartmentId = "string",
SubnetIds = new[]
{
"string",
},
DisplayName = "string",
Shape = "string",
IsPrivate = false,
IsDeleteProtectionEnabled = false,
IpMode = "string",
IsRequestIdEnabled = false,
NetworkSecurityGroupIds = new[]
{
"string",
},
RequestIdHeader = "string",
ReservedIps = new[]
{
new Oci.LoadBalancer.Inputs.LoadBalancerReservedIpArgs
{
Id = "string",
},
},
FreeformTags =
{
{ "string", "string" },
},
ShapeDetails = new Oci.LoadBalancer.Inputs.LoadBalancerShapeDetailsArgs
{
MaximumBandwidthInMbps = 0,
MinimumBandwidthInMbps = 0,
},
DefinedTags =
{
{ "string", "string" },
},
});
example, err := LoadBalancer.NewLoadBalancer(ctx, "loadBalancerResource", &LoadBalancer.LoadBalancerArgs{
CompartmentId: pulumi.String("string"),
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
Shape: pulumi.String("string"),
IsPrivate: pulumi.Bool(false),
IsDeleteProtectionEnabled: pulumi.Bool(false),
IpMode: pulumi.String("string"),
IsRequestIdEnabled: pulumi.Bool(false),
NetworkSecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
RequestIdHeader: pulumi.String("string"),
ReservedIps: loadbalancer.LoadBalancerReservedIpArray{
&loadbalancer.LoadBalancerReservedIpArgs{
Id: pulumi.String("string"),
},
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ShapeDetails: &loadbalancer.LoadBalancerShapeDetailsArgs{
MaximumBandwidthInMbps: pulumi.Int(0),
MinimumBandwidthInMbps: pulumi.Int(0),
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()
.compartmentId("string")
.subnetIds("string")
.displayName("string")
.shape("string")
.isPrivate(false)
.isDeleteProtectionEnabled(false)
.ipMode("string")
.isRequestIdEnabled(false)
.networkSecurityGroupIds("string")
.requestIdHeader("string")
.reservedIps(LoadBalancerReservedIpArgs.builder()
.id("string")
.build())
.freeformTags(Map.of("string", "string"))
.shapeDetails(LoadBalancerShapeDetailsArgs.builder()
.maximumBandwidthInMbps(0)
.minimumBandwidthInMbps(0)
.build())
.definedTags(Map.of("string", "string"))
.build());
load_balancer_resource = oci.load_balancer.LoadBalancer("loadBalancerResource",
compartment_id="string",
subnet_ids=["string"],
display_name="string",
shape="string",
is_private=False,
is_delete_protection_enabled=False,
ip_mode="string",
is_request_id_enabled=False,
network_security_group_ids=["string"],
request_id_header="string",
reserved_ips=[{
"id": "string",
}],
freeform_tags={
"string": "string",
},
shape_details={
"maximum_bandwidth_in_mbps": 0,
"minimum_bandwidth_in_mbps": 0,
},
defined_tags={
"string": "string",
})
const loadBalancerResource = new oci.loadbalancer.LoadBalancer("loadBalancerResource", {
compartmentId: "string",
subnetIds: ["string"],
displayName: "string",
shape: "string",
isPrivate: false,
isDeleteProtectionEnabled: false,
ipMode: "string",
isRequestIdEnabled: false,
networkSecurityGroupIds: ["string"],
requestIdHeader: "string",
reservedIps: [{
id: "string",
}],
freeformTags: {
string: "string",
},
shapeDetails: {
maximumBandwidthInMbps: 0,
minimumBandwidthInMbps: 0,
},
definedTags: {
string: "string",
},
});
type: oci:LoadBalancer:LoadBalancer
properties:
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
ipMode: string
isDeleteProtectionEnabled: false
isPrivate: false
isRequestIdEnabled: false
networkSecurityGroupIds:
- string
requestIdHeader: string
reservedIps:
- id: string
shape: string
shapeDetails:
maximumBandwidthInMbps: 0
minimumBandwidthInMbps: 0
subnetIds:
- string
LoadBalancer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LoadBalancer resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- Display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - Subnet
Ids List<string> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Dictionary<string, string>
- (Updatable) 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"} - Ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- Is
Delete boolProtection Enabled (Updatable) 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- Is
Private bool 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- Is
Request boolId Enabled (Updatable) 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- Network
Security List<string>Group Ids (Updatable) 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"]- Request
Id stringHeader (Updatable) 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.
- Reserved
Ips List<LoadBalancer Reserved Ip> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- Shape
Details LoadBalancer Shape Details - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- Display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - Subnet
Ids []string An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - map[string]string
- (Updatable) 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"} - Ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- Is
Delete boolProtection Enabled (Updatable) 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- Is
Private bool 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- Is
Request boolId Enabled (Updatable) 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- Network
Security []stringGroup Ids (Updatable) 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"]- Request
Id stringHeader (Updatable) 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.
- Reserved
Ips []LoadBalancer Reserved Ip Args - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- Shape
Details LoadBalancer Shape Details Args - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the load balancer.
- display
Name String - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - shape String
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - subnet
Ids List<String> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Map<String,String>
- (Updatable) 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"} - ip
Mode String IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete BooleanProtection Enabled (Updatable) 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- is
Private Boolean 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- is
Request BooleanId Enabled (Updatable) 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- network
Security List<String>Group Ids (Updatable) 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"]- request
Id StringHeader (Updatable) 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.
- reserved
Ips List<ReservedIp> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape
Details ShapeDetails - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
- compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - subnet
Ids string[] An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - {[key: string]: string}
- (Updatable) 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"} - ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete booleanProtection Enabled (Updatable) 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- is
Private boolean 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- is
Request booleanId Enabled (Updatable) 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- network
Security string[]Group Ids (Updatable) 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"]- request
Id stringHeader (Updatable) 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.
- reserved
Ips LoadBalancer Reserved Ip[] - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape
Details LoadBalancer Shape Details - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
- compartment_
id str - (Updatable) The OCID of the compartment in which to create the load balancer.
- display_
name str - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - shape str
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - subnet_
ids Sequence[str] An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Mapping[str, str]
- (Updatable) 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"} - ip_
mode str IPv6 is currently supported only in the Government Cloud. 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"
- is_
delete_ boolprotection_ enabled (Updatable) 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- is_
private bool 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- is_
request_ boolid_ enabled (Updatable) 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- network_
security_ Sequence[str]group_ ids (Updatable) 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"]- request_
id_ strheader (Updatable) 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.
- reserved_
ips Sequence[loadbalancer.Load Balancer Reserved Ip Args] - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape_
details loadbalancer.Load Balancer Shape Details Args - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the load balancer.
- display
Name String - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - shape String
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - subnet
Ids List<String> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Map<String>
- (Updatable) 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"} - ip
Mode String IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete BooleanProtection Enabled (Updatable) 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- is
Private Boolean 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- is
Request BooleanId Enabled (Updatable) 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- network
Security List<String>Group Ids (Updatable) 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"]- request
Id StringHeader (Updatable) 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.
- reserved
Ips List<Property Map> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape
Details Property Map - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address List<LoadDetails Balancer Ip Address Detail> - An array of IP addresses.
- Ip
Addresses List<string> - An array of IP addresses. Deprecated: use ip_address_details instead
- State string
- The current state of the load balancer.
- Dictionary<string, string>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address []LoadDetails Balancer Ip Address Detail - An array of IP addresses.
- Ip
Addresses []string - An array of IP addresses. Deprecated: use ip_address_details instead
- State string
- The current state of the load balancer.
- map[string]string
- 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:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address List<IpDetails Address Detail> - An array of IP addresses.
- ip
Addresses List<String> - An array of IP addresses. Deprecated: use ip_address_details instead
- state String
- The current state of the load balancer.
- Map<String,String>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id string
- The provider-assigned unique ID for this managed resource.
- ip
Address LoadDetails Balancer Ip Address Detail[] - An array of IP addresses.
- ip
Addresses string[] - An array of IP addresses. Deprecated: use ip_address_details instead
- state string
- The current state of the load balancer.
- {[key: string]: string}
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id str
- The provider-assigned unique ID for this managed resource.
- ip_
address_ Sequence[loadbalancer.details Load Balancer Ip Address Detail] - An array of IP addresses.
- ip_
addresses Sequence[str] - An array of IP addresses. Deprecated: use ip_address_details instead
- state str
- The current state of the load balancer.
- Mapping[str, str]
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address List<Property Map>Details - An array of IP addresses.
- ip
Addresses List<String> - An array of IP addresses. Deprecated: use ip_address_details instead
- state String
- The current state of the load balancer.
- Map<String>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing LoadBalancer Resource
Get an existing LoadBalancer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
ip_address_details: Optional[Sequence[_loadbalancer.LoadBalancerIpAddressDetailArgs]] = None,
ip_addresses: Optional[Sequence[str]] = None,
ip_mode: Optional[str] = None,
is_delete_protection_enabled: Optional[bool] = None,
is_private: Optional[bool] = None,
is_request_id_enabled: Optional[bool] = None,
network_security_group_ids: Optional[Sequence[str]] = None,
request_id_header: Optional[str] = None,
reserved_ips: Optional[Sequence[_loadbalancer.LoadBalancerReservedIpArgs]] = None,
shape: Optional[str] = None,
shape_details: Optional[_loadbalancer.LoadBalancerShapeDetailsArgs] = None,
state: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None) -> LoadBalancerfunc GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)public static LoadBalancer get(String name, Output<String> id, LoadBalancerState state, CustomResourceOptions options)resources: _: type: oci:LoadBalancer:LoadBalancer get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Dictionary<string, string>
- (Updatable) 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"} - Ip
Address List<LoadDetails Balancer Ip Address Detail> - An array of IP addresses.
- Ip
Addresses List<string> - An array of IP addresses. Deprecated: use ip_address_details instead
- Ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- Is
Delete boolProtection Enabled (Updatable) 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- Is
Private bool 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- Is
Request boolId Enabled (Updatable) 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- Network
Security List<string>Group Ids (Updatable) 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"]- Request
Id stringHeader (Updatable) 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.
- Reserved
Ips List<LoadBalancer Reserved Ip> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- Shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - Shape
Details LoadBalancer Shape Details - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - State string
- The current state of the load balancer.
- Subnet
Ids List<string> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - map[string]string
- (Updatable) 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"} - Ip
Address []LoadDetails Balancer Ip Address Detail Args - An array of IP addresses.
- Ip
Addresses []string - An array of IP addresses. Deprecated: use ip_address_details instead
- Ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- Is
Delete boolProtection Enabled (Updatable) 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- Is
Private bool 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- Is
Request boolId Enabled (Updatable) 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- Network
Security []stringGroup Ids (Updatable) 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"]- Request
Id stringHeader (Updatable) 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.
- Reserved
Ips []LoadBalancer Reserved Ip Args - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- Shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - Shape
Details LoadBalancer Shape Details Args - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - State string
- The current state of the load balancer.
- Subnet
Ids []string An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- 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:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the load balancer.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Map<String,String>
- (Updatable) 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"} - ip
Address List<IpDetails Address Detail> - An array of IP addresses.
- ip
Addresses List<String> - An array of IP addresses. Deprecated: use ip_address_details instead
- ip
Mode String IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete BooleanProtection Enabled (Updatable) 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- is
Private Boolean 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- is
Request BooleanId Enabled (Updatable) 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- network
Security List<String>Group Ids (Updatable) 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"]- request
Id StringHeader (Updatable) 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.
- reserved
Ips List<ReservedIp> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape String
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - shape
Details ShapeDetails - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - state String
- The current state of the load balancer.
- subnet
Ids List<String> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id string - (Updatable) The OCID of the compartment in which to create the load balancer.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name string - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - {[key: string]: string}
- (Updatable) 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"} - ip
Address LoadDetails Balancer Ip Address Detail[] - An array of IP addresses.
- ip
Addresses string[] - An array of IP addresses. Deprecated: use ip_address_details instead
- ip
Mode string IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete booleanProtection Enabled (Updatable) 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- is
Private boolean 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- is
Request booleanId Enabled (Updatable) 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- network
Security string[]Group Ids (Updatable) 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"]- request
Id stringHeader (Updatable) 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.
- reserved
Ips LoadBalancer Reserved Ip[] - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape string
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - shape
Details LoadBalancer Shape Details - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - state string
- The current state of the load balancer.
- subnet
Ids string[] An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment_
id str - (Updatable) The OCID of the compartment in which to create the load balancer.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display_
name str - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Mapping[str, str]
- (Updatable) 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"} - ip_
address_ Sequence[loadbalancer.details Load Balancer Ip Address Detail Args] - An array of IP addresses.
- ip_
addresses Sequence[str] - An array of IP addresses. Deprecated: use ip_address_details instead
- ip_
mode str IPv6 is currently supported only in the Government Cloud. 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"
- is_
delete_ boolprotection_ enabled (Updatable) 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- is_
private bool 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- is_
request_ boolid_ enabled (Updatable) 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- network_
security_ Sequence[str]group_ ids (Updatable) 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"]- request_
id_ strheader (Updatable) 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.
- reserved_
ips Sequence[loadbalancer.Load Balancer Reserved Ip Args] - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape str
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - shape_
details loadbalancer.Load Balancer Shape Details Args - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - state str
- The current state of the load balancer.
- subnet_
ids Sequence[str] An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - (Updatable) The OCID of the compartment in which to create the load balancer.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example:
example_load_balancer - Map<String>
- (Updatable) 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"} - ip
Address List<Property Map>Details - An array of IP addresses.
- ip
Addresses List<String> - An array of IP addresses. Deprecated: use ip_address_details instead
- ip
Mode String IPv6 is currently supported only in the Government Cloud. 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"
- is
Delete BooleanProtection Enabled (Updatable) 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- is
Private Boolean 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- is
Request BooleanId Enabled (Updatable) 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- network
Security List<String>Group Ids (Updatable) 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"]- request
Id StringHeader (Updatable) 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.
- reserved
Ips List<Property Map> - An array of reserved Ips. Pre-created public IP that will be used as the IP of this load balancer. This reserved IP will not be deleted when load balancer is deleted. This ip should not be already mapped to any other resource.
- shape String
- (Updatable) A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the ListShapes operation. Example:
flexibleNOTE: After May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would beFlexible*Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also10Mbps-Microshape cannot be updated to any other shape nor can any other shape be updated to10Mbps-Micro. - shape
Details Property Map - (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is
Flexible. - state String
- The current state of the load balancer.
- subnet
Ids List<String> An array of subnet OCIDs.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- 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:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the load balancer was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Supporting Types
LoadBalancerIpAddressDetail, LoadBalancerIpAddressDetailArgs
- Ip
Address string - An IP address. Example:
192.168.0.3 - Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips List<LoadBalancer Ip Address Detail Reserved Ip>
- Ip
Address string - An IP address. Example:
192.168.0.3 - Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips []LoadBalancer Ip Address Detail Reserved Ip
- ip
Address String - An IP address. Example:
192.168.0.3 - is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips List<IpAddress Detail Reserved Ip>
- ip
Address string - An IP address. Example:
192.168.0.3 - is
Public boolean - Whether the IP address is public or private.
- reserved
Ips LoadBalancer Ip Address Detail Reserved Ip[]
- ip_
address str - An IP address. Example:
192.168.0.3 - is_
public bool - Whether the IP address is public or private.
- reserved_
ips Sequence[loadbalancer.Load Balancer Ip Address Detail Reserved Ip]
- ip
Address String - An IP address. Example:
192.168.0.3 - is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips List<Property Map>
LoadBalancerIpAddressDetailReservedIp, LoadBalancerIpAddressDetailReservedIpArgs
- Id string
- Ocid of the Reserved IP/Public Ip created with VCN.
- Id string
- Ocid of the Reserved IP/Public Ip created with VCN.
- id String
- Ocid of the Reserved IP/Public Ip created with VCN.
- id string
- Ocid of the Reserved IP/Public Ip created with VCN.
- id str
- Ocid of the Reserved IP/Public Ip created with VCN.
- id String
- Ocid of the Reserved IP/Public Ip created with VCN.
LoadBalancerReservedIp, LoadBalancerReservedIpArgs
- Id string
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
- Id string
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
- id String
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
- id string
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
- id str
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
- id String
Ocid of the Reserved IP/Public Ip created with VCN.
Reserved IPs are IPs which already registered using VCN API.
Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP.
Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer.
Example: "ocid1.publicip.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. Note If public IP resource is present in the config, the pulumi preview will throw
After applying this step and refreshing, the plan was not emptyerror, andprivate_ip_idneeds to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error.
LoadBalancerShapeDetails, LoadBalancerShapeDetailsArgs
- Maximum
Bandwidth intIn Mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- Minimum
Bandwidth intIn Mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
- Maximum
Bandwidth intIn Mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- Minimum
Bandwidth intIn Mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
- maximum
Bandwidth IntegerIn Mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- minimum
Bandwidth IntegerIn Mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
- maximum
Bandwidth numberIn Mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- minimum
Bandwidth numberIn Mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
- maximum_
bandwidth_ intin_ mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- minimum_
bandwidth_ intin_ mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
- maximum
Bandwidth NumberIn Mbps (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter.
The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
Example:
1500- minimum
Bandwidth NumberIn Mbps - (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example:
150
Import
LoadBalancers can be imported using the id, e.g.
$ pulumi import oci:LoadBalancer/loadBalancer:LoadBalancer test_load_balancer "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.