Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. LoadBalancer
Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi
pulumi/pulumi-oci

oci.LoadBalancer.LoadBalancer

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi
pulumi/pulumi-oci

    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,
    isPrivate: loadBalancerIsPrivate,
    networkSecurityGroupIds: loadBalancerNetworkSecurityGroupIds,
    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_private=load_balancer_is_private,
    network_security_group_ids=load_balancer_network_security_group_ids,
    reserved_ips=[oci.load_balancer.LoadBalancerReservedIpArgs(
        id=load_balancer_reserved_ips_id,
    )],
    shape_details=oci.load_balancer.LoadBalancerShapeDetailsArgs(
        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/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.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
			IpMode:                  pulumi.Any(loadBalancerIpMode),
			IsPrivate:               pulumi.Any(loadBalancerIsPrivate),
			NetworkSecurityGroupIds: pulumi.Any(loadBalancerNetworkSecurityGroupIds),
			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,
        IsPrivate = loadBalancerIsPrivate,
        NetworkSecurityGroupIds = loadBalancerNetworkSecurityGroupIds,
        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)
            .isPrivate(loadBalancerIsPrivate)
            .networkSecurityGroupIds(loadBalancerNetworkSecurityGroupIds)
            .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}
      isPrivate: ${loadBalancerIsPrivate}
      networkSecurityGroupIds: ${loadBalancerNetworkSecurityGroupIds}
      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,
                 display_name: Optional[str] = None,
                 shape: Optional[str] = None,
                 subnet_ids: Optional[Sequence[str]] = None,
                 defined_tags: Optional[Mapping[str, Any]] = None,
                 freeform_tags: Optional[Mapping[str, Any]] = None,
                 ip_mode: Optional[str] = None,
                 is_private: Optional[bool] = None,
                 network_security_group_ids: Optional[Sequence[str]] = None,
                 reserved_ips: Optional[Sequence[_loadbalancer.LoadBalancerReservedIpArgs]] = None,
                 shape_details: Optional[_loadbalancer.LoadBalancerShapeDetailsArgs] = 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var loadBalancerResource = new Oci.LoadBalancer.LoadBalancer("loadBalancerResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    Shape = "string",
    SubnetIds = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "any" },
    },
    FreeformTags = 
    {
        { "string", "any" },
    },
    IpMode = "string",
    IsPrivate = false,
    NetworkSecurityGroupIds = new[]
    {
        "string",
    },
    ReservedIps = new[]
    {
        new Oci.LoadBalancer.Inputs.LoadBalancerReservedIpArgs
        {
            Id = "string",
        },
    },
    ShapeDetails = new Oci.LoadBalancer.Inputs.LoadBalancerShapeDetailsArgs
    {
        MaximumBandwidthInMbps = 0,
        MinimumBandwidthInMbps = 0,
    },
});

    example, err := LoadBalancer.NewLoadBalancer(ctx, "loadBalancerResource", &LoadBalancer.LoadBalancerArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	Shape:         pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	IpMode:    pulumi.String("string"),
	IsPrivate: pulumi.Bool(false),
	NetworkSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReservedIps: loadbalancer.LoadBalancerReservedIpArray{
		&loadbalancer.LoadBalancerReservedIpArgs{
			Id: pulumi.String("string"),
		},
	},
	ShapeDetails: &loadbalancer.LoadBalancerShapeDetailsArgs{
		MaximumBandwidthInMbps: pulumi.Int(0),
		MinimumBandwidthInMbps: pulumi.Int(0),
	},
})

    var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()        
    .compartmentId("string")
    .displayName("string")
    .shape("string")
    .subnetIds("string")
    .definedTags(Map.of("string", "any"))
    .freeformTags(Map.of("string", "any"))
    .ipMode("string")
    .isPrivate(false)
    .networkSecurityGroupIds("string")
    .reservedIps(LoadBalancerReservedIpArgs.builder()
        .id("string")
        .build())
    .shapeDetails(LoadBalancerShapeDetailsArgs.builder()
        .maximumBandwidthInMbps(0)
        .minimumBandwidthInMbps(0)
        .build())
    .build());

    load_balancer_resource = oci.load_balancer.LoadBalancer("loadBalancerResource",
    compartment_id="string",
    display_name="string",
    shape="string",
    subnet_ids=["string"],
    defined_tags={
        "string": "any",
    },
    freeform_tags={
        "string": "any",
    },
    ip_mode="string",
    is_private=False,
    network_security_group_ids=["string"],
    reserved_ips=[oci.load_balancer.LoadBalancerReservedIpArgs(
        id="string",
    )],
    shape_details=oci.load_balancer.LoadBalancerShapeDetailsArgs(
        maximum_bandwidth_in_mbps=0,
        minimum_bandwidth_in_mbps=0,
    ))

    const loadBalancerResource = new oci.loadbalancer.LoadBalancer("loadBalancerResource", {
    compartmentId: "string",
    displayName: "string",
    shape: "string",
    subnetIds: ["string"],
    definedTags: {
        string: "any",
    },
    freeformTags: {
        string: "any",
    },
    ipMode: "string",
    isPrivate: false,
    networkSecurityGroupIds: ["string"],
    reservedIps: [{
        id: "string",
    }],
    shapeDetails: {
        maximumBandwidthInMbps: 0,
        minimumBandwidthInMbps: 0,
    },
});

    type: oci:LoadBalancer:LoadBalancer
properties:
    compartmentId: string
    definedTags:
        string: any
    displayName: string
    freeformTags:
        string: any
    ipMode: string
    isPrivate: false
    networkSecurityGroupIds:
        - 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

    The LoadBalancer resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    DisplayName 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    SubnetIds 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

    DefinedTags Dictionary<string, object>
    (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"}
    FreeformTags Dictionary<string, object>
    (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"}
    IpMode 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"

    IsPrivate 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

    NetworkSecurityGroupIds List<string>

    (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"]

    ReservedIps List<LoadBalancerReservedIp>
    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.
    ShapeDetails LoadBalancerShapeDetails
    (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    DisplayName 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    SubnetIds []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

    DefinedTags map[string]interface{}
    (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"}
    FreeformTags map[string]interface{}
    (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"}
    IpMode 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"

    IsPrivate 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

    NetworkSecurityGroupIds []string

    (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"]

    ReservedIps []LoadBalancerReservedIpArgs
    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.
    ShapeDetails LoadBalancerShapeDetailsArgs
    (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the load balancer.
    displayName 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    subnetIds 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

    definedTags Map<String,Object>
    (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"}
    freeformTags Map<String,Object>
    (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"}
    ipMode 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"

    isPrivate 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

    networkSecurityGroupIds List<String>

    (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"]

    reservedIps 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.
    shapeDetails ShapeDetails
    (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.
    compartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    displayName 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    subnetIds 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

    definedTags {[key: string]: any}
    (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"}
    freeformTags {[key: string]: any}
    (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"}
    ipMode 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"

    isPrivate 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

    networkSecurityGroupIds string[]

    (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"]

    reservedIps LoadBalancerReservedIp[]
    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.
    shapeDetails LoadBalancerShapeDetails
    (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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-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

    defined_tags Mapping[str, Any]
    (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"}
    freeform_tags Mapping[str, Any]
    (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_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

    network_security_group_ids Sequence[str]

    (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"]

    reserved_ips Sequence[loadbalancer.LoadBalancerReservedIpArgs]
    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.LoadBalancerShapeDetailsArgs
    (Updatable) The configuration details to create load balancer using Flexible shape. This is required only if shapeName is Flexible.
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the load balancer.
    displayName 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    subnetIds 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

    definedTags Map<Any>
    (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"}
    freeformTags Map<Any>
    (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"}
    ipMode 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"

    isPrivate 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

    networkSecurityGroupIds List<String>

    (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"]

    reservedIps 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.
    shapeDetails 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.
    IpAddressDetails List<LoadBalancerIpAddressDetail>
    An array of IP addresses.
    IpAddresses List<string>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    State string
    The current state of the load balancer.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated 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.
    IpAddressDetails []LoadBalancerIpAddressDetail
    An array of IP addresses.
    IpAddresses []string
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    State string
    The current state of the load balancer.
    SystemTags map[string]interface{}
    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"}
    TimeCreated 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.
    ipAddressDetails List<IpAddressDetail>
    An array of IP addresses.
    ipAddresses List<String>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    state String
    The current state of the load balancer.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated 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.
    ipAddressDetails LoadBalancerIpAddressDetail[]
    An array of IP addresses.
    ipAddresses string[]
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    state string
    The current state of the load balancer.
    systemTags {[key: string]: any}
    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"}
    timeCreated 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_details Sequence[loadbalancer.LoadBalancerIpAddressDetail]
    An array of IP addresses.
    ip_addresses Sequence[str]
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    state str
    The current state of the load balancer.
    system_tags Mapping[str, Any]
    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.
    ipAddressDetails List<Property Map>
    An array of IP addresses.
    ipAddresses List<String>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

    state String
    The current state of the load balancer.
    systemTags Map<Any>
    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"}
    timeCreated 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, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        ip_address_details: Optional[Sequence[_loadbalancer.LoadBalancerIpAddressDetailArgs]] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ip_mode: Optional[str] = None,
        is_private: Optional[bool] = None,
        network_security_group_ids: Optional[Sequence[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, Any]] = None,
        time_created: Optional[str] = None) -> LoadBalancer
    func 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)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    DefinedTags Dictionary<string, object>
    (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"}
    DisplayName 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
    FreeformTags Dictionary<string, object>
    (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"}
    IpAddressDetails List<LoadBalancerIpAddressDetail>
    An array of IP addresses.
    IpAddresses List<string>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

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

    IsPrivate 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

    NetworkSecurityGroupIds List<string>

    (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"]

    ReservedIps List<LoadBalancerReservedIp>
    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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    ShapeDetails LoadBalancerShapeDetails
    (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.
    SubnetIds 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

    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the load balancer was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    DefinedTags map[string]interface{}
    (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"}
    DisplayName 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
    FreeformTags map[string]interface{}
    (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"}
    IpAddressDetails []LoadBalancerIpAddressDetailArgs
    An array of IP addresses.
    IpAddresses []string
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

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

    IsPrivate 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

    NetworkSecurityGroupIds []string

    (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"]

    ReservedIps []LoadBalancerReservedIpArgs
    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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    ShapeDetails LoadBalancerShapeDetailsArgs
    (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.
    SubnetIds []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

    SystemTags map[string]interface{}
    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"}
    TimeCreated string
    The date and time the load balancer was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the load balancer.
    definedTags Map<String,Object>
    (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"}
    displayName 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
    freeformTags Map<String,Object>
    (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"}
    ipAddressDetails List<IpAddressDetail>
    An array of IP addresses.
    ipAddresses List<String>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

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

    isPrivate 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

    networkSecurityGroupIds List<String>

    (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"]

    reservedIps 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    shapeDetails 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.
    subnetIds 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

    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the load balancer was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    (Updatable) The OCID of the compartment in which to create the load balancer.
    definedTags {[key: string]: any}
    (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"}
    displayName 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
    freeformTags {[key: string]: any}
    (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"}
    ipAddressDetails LoadBalancerIpAddressDetail[]
    An array of IP addresses.
    ipAddresses string[]
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

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

    isPrivate 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

    networkSecurityGroupIds string[]

    (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"]

    reservedIps LoadBalancerReservedIp[]
    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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    shapeDetails LoadBalancerShapeDetails
    (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.
    subnetIds 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

    systemTags {[key: string]: any}
    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"}
    timeCreated 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.
    defined_tags Mapping[str, Any]
    (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
    freeform_tags Mapping[str, Any]
    (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_details Sequence[loadbalancer.LoadBalancerIpAddressDetailArgs]
    An array of IP addresses.
    ip_addresses Sequence[str]
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please 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_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

    network_security_group_ids Sequence[str]

    (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"]

    reserved_ips Sequence[loadbalancer.LoadBalancerReservedIpArgs]
    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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    shape_details loadbalancer.LoadBalancerShapeDetailsArgs
    (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

    system_tags Mapping[str, Any]
    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
    compartmentId String
    (Updatable) The OCID of the compartment in which to create the load balancer.
    definedTags Map<Any>
    (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"}
    displayName 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
    freeformTags Map<Any>
    (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"}
    ipAddressDetails List<Property Map>
    An array of IP addresses.
    ipAddresses List<String>
    An array of IP addresses. Deprecated: use ip_address_details instead

    Deprecated: The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead.

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

    isPrivate 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

    networkSecurityGroupIds List<String>

    (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"]

    reservedIps 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: flexible NOTE: Starting May 2023, Fixed shapes - 10Mbps, 100Mbps, 400Mbps, 8000Mbps would be deprecated and only shape allowed would be Flexible *Note: When updating shape for a load balancer, all existing connections to the load balancer will be reset during the update process. Also 10Mbps-Micro shape cannot be updated to any other shape nor can any other shape be updated to 10Mbps-Micro.
    shapeDetails 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.
    subnetIds 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

    systemTags Map<Any>
    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"}
    timeCreated 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

    IpAddress string
    An IP address. Example: 192.168.0.3
    IsPublic bool
    Whether the IP address is public or private.
    ReservedIps List<LoadBalancerIpAddressDetailReservedIp>
    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.
    IpAddress string
    An IP address. Example: 192.168.0.3
    IsPublic bool
    Whether the IP address is public or private.
    ReservedIps []LoadBalancerIpAddressDetailReservedIp
    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.
    ipAddress String
    An IP address. Example: 192.168.0.3
    isPublic Boolean
    Whether the IP address is public or private.
    reservedIps List<IpAddressDetailReservedIp>
    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.
    ipAddress string
    An IP address. Example: 192.168.0.3
    isPublic boolean
    Whether the IP address is public or private.
    reservedIps LoadBalancerIpAddressDetailReservedIp[]
    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.
    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.LoadBalancerIpAddressDetailReservedIp]
    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.
    ipAddress String
    An IP address. Example: 192.168.0.3
    isPublic Boolean
    Whether the IP address is public or private.
    reservedIps List<Property Map>
    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.

    LoadBalancerIpAddressDetailReservedIp, LoadBalancerIpAddressDetailReservedIpArgs

    Id string
    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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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.

    LoadBalancerReservedIp, LoadBalancerReservedIpArgs

    Id string
    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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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 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 empty error, and private_ip_id needs 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

    MaximumBandwidthInMbps int

    (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

    MinimumBandwidthInMbps int
    (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
    MaximumBandwidthInMbps int

    (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

    MinimumBandwidthInMbps int
    (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
    maximumBandwidthInMbps Integer

    (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

    minimumBandwidthInMbps Integer
    (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
    maximumBandwidthInMbps number

    (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

    minimumBandwidthInMbps number
    (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_in_mbps int

    (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_in_mbps int
    (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
    maximumBandwidthInMbps Number

    (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

    minimumBandwidthInMbps Number
    (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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi
    pulumi/pulumi-oci