import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Network Load Balancer resource in Oracle Cloud Infrastructure Network Load Balancer service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/networkloadbalancer/latest/NetworkLoadBalancer * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/network_load_balancer * * Creates a network load balancer. * * ## Import * * NetworkLoadBalancers can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:NetworkLoadBalancer/networkLoadBalancer:NetworkLoadBalancer test_network_load_balancer "id" * ``` */ export declare class NetworkLoadBalancer extends pulumi.CustomResource { /** * Get an existing NetworkLoadBalancer resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: NetworkLoadBalancerState, opts?: pulumi.CustomResourceOptions): NetworkLoadBalancer; /** * Returns true if the given object is an instance of NetworkLoadBalancer. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is NetworkLoadBalancer; /** * 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" */ readonly assignedIpv6: pulumi.Output; /** * 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" */ readonly assignedPrivateIpv4: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Network load balancer identifier, which can be renamed. */ readonly displayName: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * An array of IP addresses. */ readonly ipAddresses: pulumi.Output; /** * (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. */ readonly isPreserveSourceDestination: pulumi.Output; /** * 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](https://docs.cloud.oracle.com/iaas/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and private network load balancers, see [Network Load Balancer Types](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. * * Example: `true` */ readonly isPrivate: pulumi.Output; /** * (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` */ readonly isSymmetricHashEnabled: pulumi.Output; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ readonly lifecycleDetails: pulumi.Output; /** * (Updatable) An array of network security groups [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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"] */ readonly networkSecurityGroupIds: pulumi.Output; /** * (Updatable) IP version associated with the NLB. */ readonly nlbIpVersion: pulumi.Output; /** * An array of reserved Ips. NLB supports reserved public ip, reserved private IP and reserved IPv6. Customer can pass 3 reserved IP ocids, with all items unique, and a maximum of 1 allowed for each entity type: public-ip, private-ip and IPv6 Note that NLB does not support changing an IP’s lifecycle state between ephemeral and reserved if the IP is already assigned to the NLB. While this type of lifecycle state change is supported by VCN IPs even when the IP is assigned to a resource, such changes will not be recognized or reflected by NLB. */ readonly reservedIps: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` */ readonly securityAttributes: pulumi.Output<{ [key: string]: string; }>; /** * The current state of the network load balancer. */ readonly state: pulumi.Output; /** * The subnet in which the network load balancer is spawned [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ readonly subnetId: pulumi.Output; /** * 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 */ readonly subnetIpv6cidr: pulumi.Output; /** * Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the network load balancer was created, in the format defined by RFC3339. Example: `2020-05-01T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: `2020-05-01T22:10:29.600Z` */ readonly timeUpdated: pulumi.Output; /** * Create a NetworkLoadBalancer resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: NetworkLoadBalancerArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering NetworkLoadBalancer resources. */ export interface NetworkLoadBalancerState { /** * 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" */ assignedIpv6?: pulumi.Input; /** * 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" */ assignedPrivateIpv4?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Network load balancer identifier, which can be renamed. */ displayName?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * An array of IP addresses. */ ipAddresses?: pulumi.Input[] | undefined>; /** * (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. */ isPreserveSourceDestination?: pulumi.Input; /** * 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](https://docs.cloud.oracle.com/iaas/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and private network load balancers, see [Network Load Balancer Types](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. * * Example: `true` */ isPrivate?: pulumi.Input; /** * (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` */ isSymmetricHashEnabled?: pulumi.Input; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails?: pulumi.Input; /** * (Updatable) An array of network security groups [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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"] */ networkSecurityGroupIds?: pulumi.Input[] | undefined>; /** * (Updatable) IP version associated with the NLB. */ nlbIpVersion?: pulumi.Input; /** * An array of reserved Ips. NLB supports reserved public ip, reserved private IP and reserved IPv6. Customer can pass 3 reserved IP ocids, with all items unique, and a maximum of 1 allowed for each entity type: public-ip, private-ip and IPv6 Note that NLB does not support changing an IP’s lifecycle state between ephemeral and reserved if the IP is already assigned to the NLB. While this type of lifecycle state change is supported by VCN IPs even when the IP is assigned to a resource, such changes will not be recognized or reflected by NLB. */ reservedIps?: pulumi.Input[] | undefined>; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` */ securityAttributes?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The current state of the network load balancer. */ state?: pulumi.Input; /** * The subnet in which the network load balancer is spawned [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ subnetId?: pulumi.Input; /** * 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 */ subnetIpv6cidr?: pulumi.Input; /** * Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the network load balancer was created, in the format defined by RFC3339. Example: `2020-05-01T21:10:29.600Z` */ timeCreated?: pulumi.Input; /** * The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: `2020-05-01T22:10:29.600Z` */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a NetworkLoadBalancer resource. */ export interface NetworkLoadBalancerArgs { /** * 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" */ assignedIpv6?: pulumi.Input; /** * 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" */ assignedPrivateIpv4?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancer. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Network load balancer identifier, which can be renamed. */ displayName: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (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. */ isPreserveSourceDestination?: pulumi.Input; /** * 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](https://docs.cloud.oracle.com/iaas/Content/network/Concepts/securitylists.htm) for your virtual cloud network. For more information about public and private network load balancers, see [Network Load Balancer Types](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#NetworkLoadBalancerTypes). This value is true by default. * * Example: `true` */ isPrivate?: pulumi.Input; /** * (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` */ isSymmetricHashEnabled?: pulumi.Input; /** * (Updatable) An array of network security groups [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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"] */ networkSecurityGroupIds?: pulumi.Input[] | undefined>; /** * (Updatable) IP version associated with the NLB. */ nlbIpVersion?: pulumi.Input; /** * An array of reserved Ips. NLB supports reserved public ip, reserved private IP and reserved IPv6. Customer can pass 3 reserved IP ocids, with all items unique, and a maximum of 1 allowed for each entity type: public-ip, private-ip and IPv6 Note that NLB does not support changing an IP’s lifecycle state between ephemeral and reserved if the IP is already assigned to the NLB. While this type of lifecycle state change is supported by VCN IPs even when the IP is assigned to a resource, such changes will not be recognized or reflected by NLB. */ reservedIps?: pulumi.Input[] | undefined>; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}` */ securityAttributes?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The subnet in which the network load balancer is spawned [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ subnetId: pulumi.Input; /** * 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 */ subnetIpv6cidr?: pulumi.Input; } //# sourceMappingURL=networkLoadBalancer.d.ts.map