Docs Home
oci.NetworkLoadBalancer.NetworkLoadBalancer
Explore with Pulumi AI
This resource provides the Network Load Balancer resource in Oracle Cloud Infrastructure Network Load Balancer service.
Creates a network load balancer.
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, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = 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,
security_attributes: Optional[Mapping[str, str]] = 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.
Constructor 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", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
AssignedIpv6 = "string",
IsPrivate = false,
IsSymmetricHashEnabled = false,
NetworkSecurityGroupIds = new[]
{
"string",
},
NlbIpVersion = "string",
ReservedIps = new[]
{
new Oci.NetworkLoadBalancer.Inputs.NetworkLoadBalancerReservedIpArgs
{
Id = "string",
},
},
SecurityAttributes =
{
{ "string", "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.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
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"),
},
},
SecurityAttributes: pulumi.StringMap{
"string": 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", "string"))
.freeformTags(Map.of("string", "string"))
.assignedIpv6("string")
.isPrivate(false)
.isSymmetricHashEnabled(false)
.networkSecurityGroupIds("string")
.nlbIpVersion("string")
.reservedIps(NetworkLoadBalancerReservedIpArgs.builder()
.id("string")
.build())
.securityAttributes(Map.of("string", "string"))
.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": "string",
},
freeform_tags={
"string": "string",
},
assigned_ipv6="string",
is_private=False,
is_symmetric_hash_enabled=False,
network_security_group_ids=["string"],
nlb_ip_version="string",
reserved_ips=[{
"id": "string",
}],
security_attributes={
"string": "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: "string",
},
freeformTags: {
string: "string",
},
assignedIpv6: "string",
isPrivate: false,
isSymmetricHashEnabled: false,
networkSecurityGroupIds: ["string"],
nlbIpVersion: "string",
reservedIps: [{
id: "string",
}],
securityAttributes: {
string: "string",
},
assignedPrivateIpv4: "string",
subnetIpv6cidr: "string",
});
type: oci:NetworkLoadBalancer:NetworkLoadBalancer
properties:
assignedIpv6: string
assignedPrivateIpv4: string
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
isPreserveSourceDestination: false
isPrivate: false
isSymmetricHashEnabled: false
networkSecurityGroupIds:
- string
nlbIpVersion: string
reservedIps:
- id: string
securityAttributes:
string: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NetworkLoadBalancer resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment containing the network load balancer.
- Display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- Assigned
Ipv6 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"
- Assigned
Private stringIpv4 - 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"
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Dictionary<string, string>
- (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 boolSource Destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- Is
Symmetric boolHash Enabled (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:
trueExample:true- Network
Security List<string>Group Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- Reserved
Ips List<NetworkLoad Balancer Reserved Ip> - An array of reserved Ips.
- Security
Attributes Dictionary<string, string> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - Subnet
Ipv6cidr 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 string - (Updatable) The OCID of the compartment containing the network load balancer.
- Display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- Assigned
Ipv6 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"
- Assigned
Private stringIpv4 - 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"
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - map[string]string
- (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 boolSource Destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- Is
Symmetric boolHash Enabled (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:
trueExample:true- Network
Security []stringGroup Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- Reserved
Ips []NetworkLoad Balancer Reserved Ip Args - An array of reserved Ips.
- Security
Attributes map[string]string - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - Subnet
Ipv6cidr 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 String - (Updatable) The OCID of the compartment containing the network load balancer.
- display
Name String - (Updatable) Network load balancer identifier, which can be renamed.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs.
- assigned
Ipv6 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"
- assigned
Private StringIpv4 - 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"
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Map<String,String>
- (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 BooleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric BooleanHash Enabled (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:
trueExample:true- network
Security List<String>Group Ids (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 StringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips List<ReservedIp> - An array of reserved Ips.
- security
Attributes Map<String,String> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - subnet
Ipv6cidr 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 string - (Updatable) The OCID of the compartment containing the network load balancer.
- display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- assigned
Ipv6 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"
- assigned
Private stringIpv4 - 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"
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - {[key: string]: string}
- (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 booleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric booleanHash Enabled (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:
trueExample:true- network
Security string[]Group Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips NetworkLoad Balancer Reserved Ip[] - An array of reserved Ips.
- security
Attributes {[key: string]: string} - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - subnet
Ipv6cidr 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_ stripv4 - 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"
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Mapping[str, str]
- (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_ boolsource_ destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- is_
symmetric_ boolhash_ enabled (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:
trueExample:true- network_
security_ Sequence[str]group_ ids (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_ strversion - (Updatable) IP version associated with the NLB.
- reserved_
ips Sequence[networkloadbalancer.Network Load Balancer Reserved Ip Args] - An array of reserved Ips.
- security_
attributes Mapping[str, str] - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - 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
- compartment
Id String - (Updatable) The OCID of the compartment containing the network load balancer.
- display
Name String - (Updatable) Network load balancer identifier, which can be renamed.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs.
- assigned
Ipv6 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"
- assigned
Private StringIpv4 - 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"
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Map<String>
- (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 BooleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric BooleanHash Enabled (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:
trueExample:true- network
Security List<String>Group Ids (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 StringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips List<Property Map> - An array of reserved Ips.
- security
Attributes Map<String> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - subnet
Ipv6cidr 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.
- Ip
Addresses List<NetworkLoad Balancer Ip Address> - An array of IP addresses.
- Lifecycle
Details 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.
- Dictionary<string, string>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - Time
Created string - 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 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.
- Ip
Addresses []NetworkLoad Balancer Ip Address - An array of IP addresses.
- Lifecycle
Details 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.
- map[string]string
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - Time
Created string - 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 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.
- ip
Addresses List<IpAddress> - An array of IP addresses.
- lifecycle
Details 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.
- Map<String,String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created String - 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 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.
- ip
Addresses NetworkLoad Balancer Ip Address[] - An array of IP addresses.
- lifecycle
Details 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.
- {[key: string]: string}
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created string - 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 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.Network Load Balancer Ip Address] - 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.
- Mapping[str, str]
- 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.
- ip
Addresses List<Property Map> - An array of IP addresses.
- lifecycle
Details 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.
- Map<String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created String - 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 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, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = 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,
security_attributes: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
subnet_id: Optional[str] = None,
subnet_ipv6cidr: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> NetworkLoadBalancerfunc 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)resources: _: type: oci:NetworkLoadBalancer:NetworkLoadBalancer get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Assigned
Ipv6 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"
- Assigned
Private stringIpv4 - 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 string - (Updatable) The OCID of the compartment containing the network load balancer.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- Dictionary<string, string>
- (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 List<NetworkLoad Balancer Ip Address> - An array of IP addresses.
- Is
Preserve boolSource Destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- Is
Symmetric boolHash Enabled (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:
trueExample:true- Lifecycle
Details 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.
- Network
Security List<string>Group Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- Reserved
Ips List<NetworkLoad Balancer Reserved Ip> - An array of reserved Ips.
- Security
Attributes Dictionary<string, string> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - State string
- The current state of the network load balancer.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- Subnet
Ipv6cidr 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
- Dictionary<string, string>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - Time
Created string - 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 string - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- Assigned
Ipv6 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"
- Assigned
Private stringIpv4 - 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 string - (Updatable) The OCID of the compartment containing the network load balancer.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- map[string]string
- (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 []NetworkLoad Balancer Ip Address Args - An array of IP addresses.
- Is
Preserve boolSource Destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- Is
Symmetric boolHash Enabled (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:
trueExample:true- Lifecycle
Details 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.
- Network
Security []stringGroup Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- Reserved
Ips []NetworkLoad Balancer Reserved Ip Args - An array of reserved Ips.
- Security
Attributes map[string]string - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - State string
- The current state of the network load balancer.
- Subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- Subnet
Ipv6cidr 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
- map[string]string
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - Time
Created string - 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 string - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- assigned
Ipv6 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"
- assigned
Private StringIpv4 - 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 String - (Updatable) The OCID of the compartment containing the network load balancer.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Network load balancer identifier, which can be renamed.
- Map<String,String>
- (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 List<IpAddress> - An array of IP addresses.
- is
Preserve BooleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric BooleanHash Enabled (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:
trueExample:true- lifecycle
Details 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.
- network
Security List<String>Group Ids (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 StringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips List<ReservedIp> - An array of reserved Ips.
- security
Attributes Map<String,String> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - state String
- The current state of the network load balancer.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs.
- subnet
Ipv6cidr 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
- Map<String,String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created String - 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 String - The time the network load balancer was updated. An RFC3339 formatted date-time string. Example:
2020-05-01T22:10:29.600Z
- assigned
Ipv6 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"
- assigned
Private stringIpv4 - 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 string - (Updatable) The OCID of the compartment containing the network load balancer.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name string - (Updatable) Network load balancer identifier, which can be renamed.
- {[key: string]: string}
- (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 NetworkLoad Balancer Ip Address[] - An array of IP addresses.
- is
Preserve booleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric booleanHash Enabled (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:
trueExample:true- lifecycle
Details 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.
- network
Security string[]Group Ids (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 stringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips NetworkLoad Balancer Reserved Ip[] - An array of reserved Ips.
- security
Attributes {[key: string]: string} - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - state string
- The current state of the network load balancer.
- subnet
Id string - The subnet in which the network load balancer is spawned OCIDs.
- subnet
Ipv6cidr 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
- {[key: string]: string}
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created string - 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 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_ stripv4 - 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.
- Mapping[str, str]
- (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.
- Mapping[str, str]
- (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.Network Load Balancer Ip Address Args] - An array of IP addresses.
- is_
preserve_ boolsource_ destination - (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 Network Load Balancer Types. This value is true by default.
Example:
true- is_
symmetric_ boolhash_ enabled (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:
trueExample: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_ Sequence[str]group_ ids (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_ strversion - (Updatable) IP version associated with the NLB.
- reserved_
ips Sequence[networkloadbalancer.Network Load Balancer Reserved Ip Args] - An array of reserved Ips.
- security_
attributes Mapping[str, str] - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - 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
- Mapping[str, str]
- 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
- assigned
Ipv6 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"
- assigned
Private StringIpv4 - 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 String - (Updatable) The OCID of the compartment containing the network load balancer.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) Network load balancer identifier, which can be renamed.
- Map<String>
- (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 List<Property Map> - An array of IP addresses.
- is
Preserve BooleanSource Destination - (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 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 Network Load Balancer Types. This value is true by default.
Example:
true- is
Symmetric BooleanHash Enabled (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:
trueExample:true- lifecycle
Details 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.
- network
Security List<String>Group Ids (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 StringVersion - (Updatable) IP version associated with the NLB.
- reserved
Ips List<Property Map> - An array of reserved Ips.
- security
Attributes Map<String> - (Updatable) ZPR 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:
{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}} - state String
- The current state of the network load balancer.
- subnet
Id String - The subnet in which the network load balancer is spawned OCIDs.
- subnet
Ipv6cidr 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
- Map<String>
- Key-value pair representing system tags' keys and values scoped to a namespace. Example:
{"bar-key": "value"} - time
Created String - 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 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
- Ip
Address string - An IP address. Example:
192.168.0.3 - Ip
Version string - IP version associated with the listener.
- Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips List<NetworkLoad Balancer Ip Address Reserved Ip> - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- Ip
Address string - An IP address. Example:
192.168.0.3 - Ip
Version string - IP version associated with the listener.
- Is
Public bool - Whether the IP address is public or private.
- Reserved
Ips []NetworkLoad Balancer Ip Address Reserved Ip - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String - An IP address. Example:
192.168.0.3 - ip
Version String - IP version associated with the listener.
- is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips List<IpAddress Reserved Ip> - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address string - An IP address. Example:
192.168.0.3 - ip
Version string - IP version associated with the listener.
- is
Public boolean - Whether the IP address is public or private.
- reserved
Ips NetworkLoad Balancer Ip Address Reserved Ip[] - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip_
address str - An IP address. Example:
192.168.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.Network Load Balancer Ip Address Reserved Ip] - An object representing a reserved IP address to be attached or that is already attached to a network load balancer.
- ip
Address String - An IP address. Example:
192.168.0.3 - ip
Version String - IP version associated with the listener.
- is
Public Boolean - Whether the IP address is public or private.
- reserved
Ips 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.
- Id string
- OCID of the reserved public IP address created with the virtual cloud network.
- id String
- OCID of the reserved public IP address created with the virtual cloud network.
- id string
- OCID of the reserved public IP address created with the virtual cloud network.
- id str
- OCID of the reserved public IP address created with the virtual cloud network.
- id String
- OCID of the reserved public IP address created with the virtual cloud network.
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
ociTerraform Provider.