1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. NetworkLoadBalancer
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

oci.NetworkLoadBalancer.NetworkLoadBalancer

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

    This resource provides the Network Load Balancer resource in Oracle Cloud Infrastructure Network Load Balancer service.

    Creates a network load balancer.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancer;
    import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancerArgs;
    import com.pulumi.oci.NetworkLoadBalancer.inputs.NetworkLoadBalancerReservedIpArgs;
    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 testNetworkLoadBalancer = new NetworkLoadBalancer("testNetworkLoadBalancer", NetworkLoadBalancerArgs.builder()        
                .compartmentId(var_.compartment_id())
                .displayName(var_.network_load_balancer_display_name())
                .subnetId(oci_core_subnet.test_subnet().id())
                .backendSets(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .assignedIpv6(var_.network_load_balancer_assigned_ipv6())
                .assignedPrivateIpv4(var_.network_load_balancer_assigned_private_ipv4())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .freeformTags(Map.of("Department", "Finance"))
                .isPreserveSourceDestination(var_.network_load_balancer_is_preserve_source_destination())
                .isPrivate(var_.network_load_balancer_is_private())
                .isSymmetricHashEnabled(var_.network_load_balancer_is_symmetric_hash_enabled())
                .networkSecurityGroupIds(var_.network_load_balancer_network_security_group_ids())
                .nlbIpVersion(var_.network_load_balancer_nlb_ip_version())
                .reservedIps(NetworkLoadBalancerReservedIpArgs.builder()
                    .id(var_.network_load_balancer_reserved_ips_id())
                    .build())
                .subnetIpv6cidr(var_.network_load_balancer_subnet_ipv6cidr())
                .build());
    
        }
    }
    
    resources:
      testNetworkLoadBalancer:
        type: oci:NetworkLoadBalancer:NetworkLoadBalancer
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          displayName: ${var.network_load_balancer_display_name}
          subnetId: ${oci_core_subnet.test_subnet.id}
          #Optional
          backendSets:
            - healthChecker:
                - protocol: ${var.network_load_balancer_backend_sets_health_checker_protocol}
                  dns:
                    - domainName: ${oci_identity_domain.test_domain.name}
                      queryClass: ${var.network_load_balancer_backend_sets_health_checker_dns_query_class}
                      queryType: ${var.network_load_balancer_backend_sets_health_checker_dns_query_type}
                      rcodes: ${var.network_load_balancer_backend_sets_health_checker_dns_rcodes}
                      transportProtocol: ${var.network_load_balancer_backend_sets_health_checker_dns_transport_protocol}
                  intervalInMillis: ${var.network_load_balancer_backend_sets_health_checker_interval_in_millis}
                  port: ${var.network_load_balancer_backend_sets_health_checker_port}
                  requestData: ${var.network_load_balancer_backend_sets_health_checker_request_data}
                  responseBodyRegex: ${var.network_load_balancer_backend_sets_health_checker_response_body_regex}
                  responseData: ${var.network_load_balancer_backend_sets_health_checker_response_data}
                  retries: ${var.network_load_balancer_backend_sets_health_checker_retries}
                  returnCode: ${var.network_load_balancer_backend_sets_health_checker_return_code}
                  timeoutInMillis: ${var.network_load_balancer_backend_sets_health_checker_timeout_in_millis}
                  urlPath: ${var.network_load_balancer_backend_sets_health_checker_url_path}
              backends:
                - port: ${var.network_load_balancer_backend_sets_backends_port}
                  ipAddress: ${var.network_load_balancer_backend_sets_backends_ip_address}
                  isBackup: ${var.network_load_balancer_backend_sets_backends_is_backup}
                  isDrain: ${var.network_load_balancer_backend_sets_backends_is_drain}
                  isOffline: ${var.network_load_balancer_backend_sets_backends_is_offline}
                  name: ${var.network_load_balancer_backend_sets_backends_name}
                  targetId: ${oci_cloud_guard_target.test_target.id}
                  weight: ${var.network_load_balancer_backend_sets_backends_weight}
              ipVersion: ${var.network_load_balancer_backend_sets_ip_version}
              isFailOpen: ${var.network_load_balancer_backend_sets_is_fail_open}
              isPreserveSource: ${var.network_load_balancer_backend_sets_is_preserve_source}
              policy: ${var.network_load_balancer_backend_sets_policy}
          #Optional
          assignedIpv6: ${var.network_load_balancer_assigned_ipv6}
          assignedPrivateIpv4: ${var.network_load_balancer_assigned_private_ipv4}
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
          isPreserveSourceDestination: ${var.network_load_balancer_is_preserve_source_destination}
          isPrivate: ${var.network_load_balancer_is_private}
          isSymmetricHashEnabled: ${var.network_load_balancer_is_symmetric_hash_enabled}
          networkSecurityGroupIds: ${var.network_load_balancer_network_security_group_ids}
          nlbIpVersion: ${var.network_load_balancer_nlb_ip_version}
          reservedIps:
            - id: ${var.network_load_balancer_reserved_ips_id}
          subnetIpv6cidr: ${var.network_load_balancer_subnet_ipv6cidr}
    

    Create NetworkLoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NetworkLoadBalancer(name: string, args: NetworkLoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkLoadBalancer(resource_name: str,
                            args: NetworkLoadBalancerArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkLoadBalancer(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            subnet_id: Optional[str] = None,
                            compartment_id: Optional[str] = None,
                            is_preserve_source_destination: Optional[bool] = None,
                            defined_tags: Optional[Mapping[str, Any]] = None,
                            freeform_tags: Optional[Mapping[str, Any]] = None,
                            assigned_ipv6: Optional[str] = None,
                            is_private: Optional[bool] = None,
                            is_symmetric_hash_enabled: Optional[bool] = None,
                            network_security_group_ids: Optional[Sequence[str]] = None,
                            nlb_ip_version: Optional[str] = None,
                            reserved_ips: Optional[Sequence[_networkloadbalancer.NetworkLoadBalancerReservedIpArgs]] = None,
                            assigned_private_ipv4: Optional[str] = None,
                            subnet_ipv6cidr: Optional[str] = None)
    func NewNetworkLoadBalancer(ctx *Context, name string, args NetworkLoadBalancerArgs, opts ...ResourceOption) (*NetworkLoadBalancer, error)
    public NetworkLoadBalancer(string name, NetworkLoadBalancerArgs args, CustomResourceOptions? opts = null)
    public NetworkLoadBalancer(String name, NetworkLoadBalancerArgs args)
    public NetworkLoadBalancer(String name, NetworkLoadBalancerArgs args, CustomResourceOptions options)
    
    type: oci:NetworkLoadBalancer:NetworkLoadBalancer
    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 NetworkLoadBalancerArgs
    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 NetworkLoadBalancerArgs
    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 NetworkLoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkLoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkLoadBalancerArgs
    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 networkLoadBalancerResource = new Oci.NetworkLoadBalancer.NetworkLoadBalancer("networkLoadBalancerResource", new()
    {
        DisplayName = "string",
        SubnetId = "string",
        CompartmentId = "string",
        IsPreserveSourceDestination = false,
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
        AssignedIpv6 = "string",
        IsPrivate = false,
        IsSymmetricHashEnabled = false,
        NetworkSecurityGroupIds = new[]
        {
            "string",
        },
        NlbIpVersion = "string",
        ReservedIps = new[]
        {
            new Oci.NetworkLoadBalancer.Inputs.NetworkLoadBalancerReservedIpArgs
            {
                Id = "string",
            },
        },
        AssignedPrivateIpv4 = "string",
        SubnetIpv6cidr = "string",
    });
    
    example, err := NetworkLoadBalancer.NewNetworkLoadBalancer(ctx, "networkLoadBalancerResource", &NetworkLoadBalancer.NetworkLoadBalancerArgs{
    	DisplayName:                 pulumi.String("string"),
    	SubnetId:                    pulumi.String("string"),
    	CompartmentId:               pulumi.String("string"),
    	IsPreserveSourceDestination: pulumi.Bool(false),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	AssignedIpv6:           pulumi.String("string"),
    	IsPrivate:              pulumi.Bool(false),
    	IsSymmetricHashEnabled: pulumi.Bool(false),
    	NetworkSecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	NlbIpVersion: pulumi.String("string"),
    	ReservedIps: networkloadbalancer.NetworkLoadBalancerReservedIpArray{
    		&networkloadbalancer.NetworkLoadBalancerReservedIpArgs{
    			Id: pulumi.String("string"),
    		},
    	},
    	AssignedPrivateIpv4: pulumi.String("string"),
    	SubnetIpv6cidr:      pulumi.String("string"),
    })
    
    var networkLoadBalancerResource = new NetworkLoadBalancer("networkLoadBalancerResource", NetworkLoadBalancerArgs.builder()        
        .displayName("string")
        .subnetId("string")
        .compartmentId("string")
        .isPreserveSourceDestination(false)
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .assignedIpv6("string")
        .isPrivate(false)
        .isSymmetricHashEnabled(false)
        .networkSecurityGroupIds("string")
        .nlbIpVersion("string")
        .reservedIps(NetworkLoadBalancerReservedIpArgs.builder()
            .id("string")
            .build())
        .assignedPrivateIpv4("string")
        .subnetIpv6cidr("string")
        .build());
    
    network_load_balancer_resource = oci.network_load_balancer.NetworkLoadBalancer("networkLoadBalancerResource",
        display_name="string",
        subnet_id="string",
        compartment_id="string",
        is_preserve_source_destination=False,
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        },
        assigned_ipv6="string",
        is_private=False,
        is_symmetric_hash_enabled=False,
        network_security_group_ids=["string"],
        nlb_ip_version="string",
        reserved_ips=[oci.network_load_balancer.NetworkLoadBalancerReservedIpArgs(
            id="string",
        )],
        assigned_private_ipv4="string",
        subnet_ipv6cidr="string")
    
    const networkLoadBalancerResource = new oci.networkloadbalancer.NetworkLoadBalancer("networkLoadBalancerResource", {
        displayName: "string",
        subnetId: "string",
        compartmentId: "string",
        isPreserveSourceDestination: false,
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
        assignedIpv6: "string",
        isPrivate: false,
        isSymmetricHashEnabled: false,
        networkSecurityGroupIds: ["string"],
        nlbIpVersion: "string",
        reservedIps: [{
            id: "string",
        }],
        assignedPrivateIpv4: "string",
        subnetIpv6cidr: "string",
    });
    
    type: oci:NetworkLoadBalancer:NetworkLoadBalancer
    properties:
        assignedIpv6: string
        assignedPrivateIpv4: string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        isPreserveSourceDestination: false
        isPrivate: false
        isSymmetricHashEnabled: false
        networkSecurityGroupIds:
            - string
        nlbIpVersion: string
        reservedIps:
            - id: string
        subnetId: string
        subnetIpv6cidr: string
    

    NetworkLoadBalancer 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 NetworkLoadBalancer resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    DisplayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    SubnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    AssignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    AssignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsPreserveSourceDestination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    IsPrivate bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    IsSymmetricHashEnabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    NetworkSecurityGroupIds List<string>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    NlbIpVersion string
    (Updatable) IP version associated with the NLB.
    ReservedIps List<NetworkLoadBalancerReservedIp>
    An array of reserved Ips.
    SubnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    DisplayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    SubnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    AssignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    AssignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsPreserveSourceDestination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    IsPrivate bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    IsSymmetricHashEnabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    NetworkSecurityGroupIds []string

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    NlbIpVersion string
    (Updatable) IP version associated with the NLB.
    ReservedIps []NetworkLoadBalancerReservedIpArgs
    An array of reserved Ips.
    SubnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the network load balancer.
    displayName String
    (Updatable) Network load balancer identifier, which can be renamed.
    subnetId String
    The subnet in which the network load balancer is spawned OCIDs.
    assignedIpv6 String
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 String
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isPreserveSourceDestination Boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate Boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled Boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    networkSecurityGroupIds List<String>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion String
    (Updatable) IP version associated with the NLB.
    reservedIps List<ReservedIp>
    An array of reserved Ips.
    subnetIpv6cidr String

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    compartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    displayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    subnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    assignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isPreserveSourceDestination boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    networkSecurityGroupIds string[]

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion string
    (Updatable) IP version associated with the NLB.
    reservedIps NetworkLoadBalancerReservedIp[]
    An array of reserved Ips.
    subnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    compartment_id str
    (Updatable) The OCID of the compartment containing the network load balancer.
    display_name str
    (Updatable) Network load balancer identifier, which can be renamed.
    subnet_id str
    The subnet in which the network load balancer is spawned OCIDs.
    assigned_ipv6 str
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assigned_private_ipv4 str
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_preserve_source_destination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    is_private bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    is_symmetric_hash_enabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    network_security_group_ids Sequence[str]

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlb_ip_version str
    (Updatable) IP version associated with the NLB.
    reserved_ips Sequence[networkloadbalancer.NetworkLoadBalancerReservedIpArgs]
    An array of reserved Ips.
    subnet_ipv6cidr str

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment containing the network load balancer.
    displayName String
    (Updatable) Network load balancer identifier, which can be renamed.
    subnetId String
    The subnet in which the network load balancer is spawned OCIDs.
    assignedIpv6 String
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 String
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isPreserveSourceDestination Boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate Boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled Boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    networkSecurityGroupIds List<String>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion String
    (Updatable) IP version associated with the NLB.
    reservedIps List<Property Map>
    An array of reserved Ips.
    subnetIpv6cidr String

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NetworkLoadBalancer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses List<NetworkLoadBalancerIpAddress>
    An array of IP addresses.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the network load balancer.
    SystemTags Dictionary<string, object>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    TimeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    TimeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddresses []NetworkLoadBalancerIpAddress
    An array of IP addresses.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    State string
    The current state of the network load balancer.
    SystemTags map[string]interface{}
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    TimeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    TimeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<IpAddress>
    An array of IP addresses.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the network load balancer.
    systemTags Map<String,Object>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated String
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated String
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddresses NetworkLoadBalancerIpAddress[]
    An array of IP addresses.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state string
    The current state of the network load balancer.
    systemTags {[key: string]: any}
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    ip_addresses Sequence[networkloadbalancer.NetworkLoadBalancerIpAddress]
    An array of IP addresses.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state str
    The current state of the network load balancer.
    system_tags Mapping[str, Any]
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    time_created str
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    time_updated str
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddresses List<Property Map>
    An array of IP addresses.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    state String
    The current state of the network load balancer.
    systemTags Map<Any>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated String
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated String
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

    Look up Existing NetworkLoadBalancer Resource

    Get an existing NetworkLoadBalancer 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?: NetworkLoadBalancerState, opts?: CustomResourceOptions): NetworkLoadBalancer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            assigned_ipv6: Optional[str] = None,
            assigned_private_ipv4: Optional[str] = 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_addresses: Optional[Sequence[_networkloadbalancer.NetworkLoadBalancerIpAddressArgs]] = None,
            is_preserve_source_destination: Optional[bool] = None,
            is_private: Optional[bool] = None,
            is_symmetric_hash_enabled: Optional[bool] = None,
            lifecycle_details: Optional[str] = None,
            network_security_group_ids: Optional[Sequence[str]] = None,
            nlb_ip_version: Optional[str] = None,
            reserved_ips: Optional[Sequence[_networkloadbalancer.NetworkLoadBalancerReservedIpArgs]] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            subnet_ipv6cidr: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> NetworkLoadBalancer
    func GetNetworkLoadBalancer(ctx *Context, name string, id IDInput, state *NetworkLoadBalancerState, opts ...ResourceOption) (*NetworkLoadBalancer, error)
    public static NetworkLoadBalancer Get(string name, Input<string> id, NetworkLoadBalancerState? state, CustomResourceOptions? opts = null)
    public static NetworkLoadBalancer get(String name, Output<String> id, NetworkLoadBalancerState 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:
    AssignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    AssignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    CompartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddresses List<NetworkLoadBalancerIpAddress>
    An array of IP addresses.
    IsPreserveSourceDestination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    IsPrivate bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    IsSymmetricHashEnabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    NetworkSecurityGroupIds List<string>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    NlbIpVersion string
    (Updatable) IP version associated with the NLB.
    ReservedIps List<NetworkLoadBalancerReservedIp>
    An array of reserved Ips.
    State string
    The current state of the network load balancer.
    SubnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    SubnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    TimeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    TimeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    AssignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    AssignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    CompartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IpAddresses []NetworkLoadBalancerIpAddressArgs
    An array of IP addresses.
    IsPreserveSourceDestination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    IsPrivate bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    IsSymmetricHashEnabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    NetworkSecurityGroupIds []string

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    NlbIpVersion string
    (Updatable) IP version associated with the NLB.
    ReservedIps []NetworkLoadBalancerReservedIpArgs
    An array of reserved Ips.
    State string
    The current state of the network load balancer.
    SubnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    SubnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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{}
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    TimeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    TimeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    assignedIpv6 String
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 String
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    compartmentId String
    (Updatable) The OCID of the compartment containing the network load balancer.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Network load balancer identifier, which can be renamed.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddresses List<IpAddress>
    An array of IP addresses.
    isPreserveSourceDestination Boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate Boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled Boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    networkSecurityGroupIds List<String>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion String
    (Updatable) IP version associated with the NLB.
    reservedIps List<ReservedIp>
    An array of reserved Ips.
    state String
    The current state of the network load balancer.
    subnetId String
    The subnet in which the network load balancer is spawned OCIDs.
    subnetIpv6cidr String

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated String
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated String
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    assignedIpv6 string
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 string
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    compartmentId string
    (Updatable) The OCID of the compartment containing the network load balancer.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) Network load balancer identifier, which can be renamed.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddresses NetworkLoadBalancerIpAddress[]
    An array of IP addresses.
    isPreserveSourceDestination boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    networkSecurityGroupIds string[]

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion string
    (Updatable) IP version associated with the NLB.
    reservedIps NetworkLoadBalancerReservedIp[]
    An array of reserved Ips.
    state string
    The current state of the network load balancer.
    subnetId string
    The subnet in which the network load balancer is spawned OCIDs.
    subnetIpv6cidr string

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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}
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated string
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated string
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    assigned_ipv6 str
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assigned_private_ipv4 str
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    compartment_id str
    (Updatable) The OCID of the compartment containing the network load balancer.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) Network load balancer identifier, which can be renamed.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ip_addresses Sequence[networkloadbalancer.NetworkLoadBalancerIpAddressArgs]
    An array of IP addresses.
    is_preserve_source_destination bool
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    is_private bool

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    is_symmetric_hash_enabled bool

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    network_security_group_ids Sequence[str]

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlb_ip_version str
    (Updatable) IP version associated with the NLB.
    reserved_ips Sequence[networkloadbalancer.NetworkLoadBalancerReservedIpArgs]
    An array of reserved Ips.
    state str
    The current state of the network load balancer.
    subnet_id str
    The subnet in which the network load balancer is spawned OCIDs.
    subnet_ipv6cidr str

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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]
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    time_created str
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    time_updated str
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z
    assignedIpv6 String
    IPv6 address to be assigned to the network load balancer being created. This IP address has to be part of one of the prefixes supported by the subnet. Example: "2607:9b80:9a0a:9a7e:abcd:ef01:2345:6789"
    assignedPrivateIpv4 String
    Private IP address to be assigned to the network load balancer being created. This IP address has to be in the CIDR range of the subnet where network load balancer is being created Example: "10.0.0.1"
    compartmentId String
    (Updatable) The OCID of the compartment containing the network load balancer.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) Network load balancer identifier, which can be renamed.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ipAddresses List<Property Map>
    An array of IP addresses.
    isPreserveSourceDestination Boolean
    (Updatable) This parameter can be enabled only if backends are compute OCIDs. When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC, and packets are sent to the backend with the entire IP header intact.
    isPrivate Boolean

    Whether the network load balancer has a virtual cloud network-local (private) IP address.

    If "true", then the service assigns a private IP address to the network load balancer.

    If "false", then the service assigns a public IP address to the network load balancer.

    A public network load balancer is accessible from the internet, depending on the security list rules for your virtual cloud network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.

    Example: true

    isSymmetricHashEnabled Boolean

    (Updatable) This can only be enabled when NLB is working in transparent mode with source destination header preservation enabled. This removes the additional dependency from NLB backends(like Firewalls) to perform SNAT.

    Example: true Example: true

    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    networkSecurityGroupIds List<String>

    (Updatable) An array of network security groups OCIDs associated with the network load balancer.

    During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.

    The benefits of associating the network load balancer with network security groups include:

    • Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
    • The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.

    Example: ["ocid1.nsg.oc1.phx.unique_ID"]

    nlbIpVersion String
    (Updatable) IP version associated with the NLB.
    reservedIps List<Property Map>
    An array of reserved Ips.
    state String
    The current state of the network load balancer.
    subnetId String
    The subnet in which the network load balancer is spawned OCIDs.
    subnetIpv6cidr String

    IPv6 subnet prefix selection. If Ipv6 subnet prefix is passed, Nlb Ipv6 Address would be assign within the cidr block. NLB has to be dual or single stack ipv6 to support this.

    ** 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>
    Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
    timeCreated String
    The date and time the network load balancer was created, in the format defined by RFC3339. Example: 2020-05-01T21:10:29.600Z
    timeUpdated String
    The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: 2020-05-01T22:10:29.600Z

    Supporting Types

    NetworkLoadBalancerIpAddress, NetworkLoadBalancerIpAddressArgs

    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IpVersion string
    IP version associated with the listener.
    IsPublic bool
    Whether the IP address is public or private.
    ReservedIps List<NetworkLoadBalancerIpAddressReservedIp>
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IpVersion string
    IP version associated with the listener.
    IsPublic bool
    Whether the IP address is public or private.
    ReservedIps []NetworkLoadBalancerIpAddressReservedIp
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    ipVersion String
    IP version associated with the listener.
    isPublic Boolean
    Whether the IP address is public or private.
    reservedIps List<IpAddressReservedIp>
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    ipVersion string
    IP version associated with the listener.
    isPublic boolean
    Whether the IP address is public or private.
    reservedIps NetworkLoadBalancerIpAddressReservedIp[]
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
    ip_address str
    The IP address of the backend server. Example: 10.0.0.3
    ip_version str
    IP version associated with the listener.
    is_public bool
    Whether the IP address is public or private.
    reserved_ips Sequence[networkloadbalancer.NetworkLoadBalancerIpAddressReservedIp]
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    ipVersion String
    IP version associated with the listener.
    isPublic Boolean
    Whether the IP address is public or private.
    reservedIps List<Property Map>
    An object representing a reserved IP address to be attached or that is already attached to a network load balancer.

    NetworkLoadBalancerIpAddressReservedIp, NetworkLoadBalancerIpAddressReservedIpArgs

    Id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    Id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id String

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id str

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id String

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    NetworkLoadBalancerReservedIp, NetworkLoadBalancerReservedIpArgs

    Id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    Id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id String

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id string

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id str

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    id String

    OCID of the reserved public IP address created with the virtual cloud network.

    Reserved public IP addresses are IP addresses that are registered using the virtual cloud network API.

    Create a reserved public IP address. When you create the network load balancer, enter the OCID of the reserved public IP address in the reservedIp field to attach the IP address to the network load balancer. This task configures the network load balancer to listen to traffic on this IP address.

    Reserved public IP addresses are not deleted when the network load balancer is deleted. The IP addresses become unattached from the network load balancer.

    Example: "ocid1.publicip.oc1.phx.unique_ID"

    Import

    NetworkLoadBalancers can be imported using the id, e.g.

    $ pulumi import oci:NetworkLoadBalancer/networkLoadBalancer:NetworkLoadBalancer test_network_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.32.0 published on Thursday, Apr 18, 2024 by Pulumi