LoadBalancerArgs

data class LoadBalancerArgs(val addressIpVersion: Output<String>? = null, val addressType: Output<String>? = null, val bandwidthPackageId: Output<String>? = null, val crossZoneEnabled: Output<Boolean>? = null, val deletionProtectionConfig: Output<LoadBalancerDeletionProtectionConfigArgs>? = null, val deletionProtectionEnabled: Output<Boolean>? = null, val deletionProtectionReason: Output<String>? = null, val ipv6AddressType: Output<String>? = null, val loadBalancerName: Output<String>? = null, val loadBalancerType: Output<String>? = null, val modificationProtectionConfig: Output<LoadBalancerModificationProtectionConfigArgs>? = null, val modificationProtectionReason: Output<String>? = null, val modificationProtectionStatus: Output<String>? = null, val resourceGroupId: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val tags: Output<Map<String, Any>>? = null, val vpcId: Output<String>? = null, val zoneMappings: Output<List<LoadBalancerZoneMappingArgs>>? = null) : ConvertibleToJava<LoadBalancerArgs>

Provides a NLB Load Balancer resource. For information about NLB Load Balancer and how to use it, see What is Load Balancer.

NOTE: Available since v1.191.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const default = alicloud.resourcemanager.getResourceGroups({});
const defaultGetZones = alicloud.nlb.getZones({});
const defaultNetwork = new alicloud.vpc.Network("default", {
vpcName: name,
cidrBlock: "10.4.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
vswitchName: name,
cidrBlock: "10.4.0.0/24",
vpcId: defaultNetwork.id,
zoneId: defaultGetZones.then(defaultGetZones => defaultGetZones.zones?.[0]?.id),
});
const default1 = new alicloud.vpc.Switch("default1", {
vswitchName: name,
cidrBlock: "10.4.1.0/24",
vpcId: defaultNetwork.id,
zoneId: defaultGetZones.then(defaultGetZones => defaultGetZones.zones?.[1]?.id),
});
const defaultLoadBalancer = new alicloud.nlb.LoadBalancer("default", {
loadBalancerName: name,
resourceGroupId: _default.then(_default => _default.ids?.[0]),
loadBalancerType: "Network",
addressType: "Internet",
addressIpVersion: "Ipv4",
vpcId: defaultNetwork.id,
tags: {
Created: "TF",
For: "example",
},
zoneMappings: [
{
vswitchId: defaultSwitch.id,
zoneId: defaultGetZones.then(defaultGetZones => defaultGetZones.zones?.[0]?.id),
},
{
vswitchId: default1.id,
zoneId: defaultGetZones.then(defaultGetZones => defaultGetZones.zones?.[1]?.id),
},
],
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default = alicloud.resourcemanager.get_resource_groups()
default_get_zones = alicloud.nlb.get_zones()
default_network = alicloud.vpc.Network("default",
vpc_name=name,
cidr_block="10.4.0.0/16")
default_switch = alicloud.vpc.Switch("default",
vswitch_name=name,
cidr_block="10.4.0.0/24",
vpc_id=default_network.id,
zone_id=default_get_zones.zones[0].id)
default1 = alicloud.vpc.Switch("default1",
vswitch_name=name,
cidr_block="10.4.1.0/24",
vpc_id=default_network.id,
zone_id=default_get_zones.zones[1].id)
default_load_balancer = alicloud.nlb.LoadBalancer("default",
load_balancer_name=name,
resource_group_id=default.ids[0],
load_balancer_type="Network",
address_type="Internet",
address_ip_version="Ipv4",
vpc_id=default_network.id,
tags={
"Created": "TF",
"For": "example",
},
zone_mappings=[
alicloud.nlb.LoadBalancerZoneMappingArgs(
vswitch_id=default_switch.id,
zone_id=default_get_zones.zones[0].id,
),
alicloud.nlb.LoadBalancerZoneMappingArgs(
vswitch_id=default1.id,
zone_id=default_get_zones.zones[1].id,
),
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
var defaultGetZones = AliCloud.Nlb.GetZones.Invoke();
var defaultNetwork = new AliCloud.Vpc.Network("default", new()
{
VpcName = name,
CidrBlock = "10.4.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
{
VswitchName = name,
CidrBlock = "10.4.0.0/24",
VpcId = defaultNetwork.Id,
ZoneId = defaultGetZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
});
var default1 = new AliCloud.Vpc.Switch("default1", new()
{
VswitchName = name,
CidrBlock = "10.4.1.0/24",
VpcId = defaultNetwork.Id,
ZoneId = defaultGetZones.Apply(getZonesResult => getZonesResult.Zones[1]?.Id),
});
var defaultLoadBalancer = new AliCloud.Nlb.LoadBalancer("default", new()
{
LoadBalancerName = name,
ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0])),
LoadBalancerType = "Network",
AddressType = "Internet",
AddressIpVersion = "Ipv4",
VpcId = defaultNetwork.Id,
Tags =
{
{ "Created", "TF" },
{ "For", "example" },
},
ZoneMappings = new[]
{
new AliCloud.Nlb.Inputs.LoadBalancerZoneMappingArgs
{
VswitchId = defaultSwitch.Id,
ZoneId = defaultGetZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
},
new AliCloud.Nlb.Inputs.LoadBalancerZoneMappingArgs
{
VswitchId = default1.Id,
ZoneId = defaultGetZones.Apply(getZonesResult => getZonesResult.Zones[1]?.Id),
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nlb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := resourcemanager.GetResourceGroups(ctx, nil, nil)
if err != nil {
return err
}
defaultGetZones, err := nlb.GetZones(ctx, nil, nil)
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
CidrBlock: pulumi.String("10.4.0.0/16"),
})
if err != nil {
return err
}
defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
VswitchName: pulumi.String(name),
CidrBlock: pulumi.String("10.4.0.0/24"),
VpcId: defaultNetwork.ID(),
ZoneId: pulumi.String(defaultGetZones.Zones[0].Id),
})
if err != nil {
return err
}
default1, err := vpc.NewSwitch(ctx, "default1", &vpc.SwitchArgs{
VswitchName: pulumi.String(name),
CidrBlock: pulumi.String("10.4.1.0/24"),
VpcId: defaultNetwork.ID(),
ZoneId: pulumi.String(defaultGetZones.Zones[1].Id),
})
if err != nil {
return err
}
_, err = nlb.NewLoadBalancer(ctx, "default", &nlb.LoadBalancerArgs{
LoadBalancerName: pulumi.String(name),
ResourceGroupId: pulumi.String(_default.Ids[0]),
LoadBalancerType: pulumi.String("Network"),
AddressType: pulumi.String("Internet"),
AddressIpVersion: pulumi.String("Ipv4"),
VpcId: defaultNetwork.ID(),
Tags: pulumi.Map{
"Created": pulumi.Any("TF"),
"For": pulumi.Any("example"),
},
ZoneMappings: nlb.LoadBalancerZoneMappingArray{
&nlb.LoadBalancerZoneMappingArgs{
VswitchId: defaultSwitch.ID(),
ZoneId: pulumi.String(defaultGetZones.Zones[0].Id),
},
&nlb.LoadBalancerZoneMappingArgs{
VswitchId: default1.ID(),
ZoneId: pulumi.String(defaultGetZones.Zones[1].Id),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.nlb.NlbFunctions;
import com.pulumi.alicloud.nlb.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.nlb.LoadBalancer;
import com.pulumi.alicloud.nlb.LoadBalancerArgs;
import com.pulumi.alicloud.nlb.inputs.LoadBalancerZoneMappingArgs;
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) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var default = ResourcemanagerFunctions.getResourceGroups();
final var defaultGetZones = NlbFunctions.getZones();
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("10.4.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vswitchName(name)
.cidrBlock("10.4.0.0/24")
.vpcId(defaultNetwork.id())
.zoneId(defaultGetZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.build());
var default1 = new Switch("default1", SwitchArgs.builder()
.vswitchName(name)
.cidrBlock("10.4.1.0/24")
.vpcId(defaultNetwork.id())
.zoneId(defaultGetZones.applyValue(getZonesResult -> getZonesResult.zones()[1].id()))
.build());
var defaultLoadBalancer = new LoadBalancer("defaultLoadBalancer", LoadBalancerArgs.builder()
.loadBalancerName(name)
.resourceGroupId(default_.ids()[0])
.loadBalancerType("Network")
.addressType("Internet")
.addressIpVersion("Ipv4")
.vpcId(defaultNetwork.id())
.tags(Map.ofEntries(
Map.entry("Created", "TF"),
Map.entry("For", "example")
))
.zoneMappings(
LoadBalancerZoneMappingArgs.builder()
.vswitchId(defaultSwitch.id())
.zoneId(defaultGetZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.build(),
LoadBalancerZoneMappingArgs.builder()
.vswitchId(default1.id())
.zoneId(defaultGetZones.applyValue(getZonesResult -> getZonesResult.zones()[1].id()))
.build())
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultNetwork:
type: alicloud:vpc:Network
name: default
properties:
vpcName: ${name}
cidrBlock: 10.4.0.0/16
defaultSwitch:
type: alicloud:vpc:Switch
name: default
properties:
vswitchName: ${name}
cidrBlock: 10.4.0.0/24
vpcId: ${defaultNetwork.id}
zoneId: ${defaultGetZones.zones[0].id}
default1:
type: alicloud:vpc:Switch
properties:
vswitchName: ${name}
cidrBlock: 10.4.1.0/24
vpcId: ${defaultNetwork.id}
zoneId: ${defaultGetZones.zones[1].id}
defaultLoadBalancer:
type: alicloud:nlb:LoadBalancer
name: default
properties:
loadBalancerName: ${name}
resourceGroupId: ${default.ids[0]}
loadBalancerType: Network
addressType: Internet
addressIpVersion: Ipv4
vpcId: ${defaultNetwork.id}
tags:
Created: TF
For: example
zoneMappings:
- vswitchId: ${defaultSwitch.id}
zoneId: ${defaultGetZones.zones[0].id}
- vswitchId: ${default1.id}
zoneId: ${defaultGetZones.zones[1].id}
variables:
default:
fn::invoke:
Function: alicloud:resourcemanager:getResourceGroups
Arguments: {}
defaultGetZones:
fn::invoke:
Function: alicloud:nlb:getZones
Arguments: {}

Import

NLB Load Balancer can be imported using the id, e.g.

$ pulumi import alicloud:nlb/loadBalancer:LoadBalancer example <id>

Constructors

Link copied to clipboard
constructor(addressIpVersion: Output<String>? = null, addressType: Output<String>? = null, bandwidthPackageId: Output<String>? = null, crossZoneEnabled: Output<Boolean>? = null, deletionProtectionConfig: Output<LoadBalancerDeletionProtectionConfigArgs>? = null, deletionProtectionEnabled: Output<Boolean>? = null, deletionProtectionReason: Output<String>? = null, ipv6AddressType: Output<String>? = null, loadBalancerName: Output<String>? = null, loadBalancerType: Output<String>? = null, modificationProtectionConfig: Output<LoadBalancerModificationProtectionConfigArgs>? = null, modificationProtectionReason: Output<String>? = null, modificationProtectionStatus: Output<String>? = null, resourceGroupId: Output<String>? = null, securityGroupIds: Output<List<String>>? = null, tags: Output<Map<String, Any>>? = null, vpcId: Output<String>? = null, zoneMappings: Output<List<LoadBalancerZoneMappingArgs>>? = null)

Properties

Link copied to clipboard
val addressIpVersion: Output<String>? = null

Protocol version. Value:

Link copied to clipboard
val addressType: Output<String>? = null

The network address type of IPv4 for network load balancing. Value:

Link copied to clipboard
val bandwidthPackageId: Output<String>? = null

The ID of the shared bandwidth package associated with the public network instance.

Link copied to clipboard
val crossZoneEnabled: Output<Boolean>? = null

Whether cross-zone is enabled for a network-based load balancing instance. Value:

Link copied to clipboard

Delete protection. See deletion_protection_config below.

Link copied to clipboard
val deletionProtectionEnabled: Output<Boolean>? = null

Specifies whether to enable deletion protection. Default value: false. Valid values:

Link copied to clipboard
val deletionProtectionReason: Output<String>? = null

The reason why the deletion protection feature is enabled or disabled. The deletion_protection_reason takes effect only when deletion_protection_enabled is set to true.

Link copied to clipboard
val ipv6AddressType: Output<String>? = null

The IPv6 address type of network load balancing. Value:

Link copied to clipboard
val loadBalancerName: Output<String>? = null

The name of the network-based load balancing instance. 2 to 128 English or Chinese characters in length, which must start with a letter or Chinese, and can contain numbers, half-width periods (.), underscores (_), and dashes (-).

Link copied to clipboard
val loadBalancerType: Output<String>? = null

Load balancing type. Only value: network, which indicates network-based load balancing.

Link copied to clipboard

Modify protection. See modification_protection_config below.

Link copied to clipboard

The reason why the configuration read-only mode is enabled. The modification_protection_reason takes effect only when modification_protection_status is set to ConsoleProtection.

Link copied to clipboard

Specifies whether to enable the configuration read-only mode. Default value: NonProtection. Valid values:

Link copied to clipboard
val resourceGroupId: Output<String>? = null

The ID of the resource group.

Link copied to clipboard
val securityGroupIds: Output<List<String>>? = null

The security group to which the network-based SLB instance belongs.

Link copied to clipboard
val tags: Output<Map<String, Any>>? = null

List of labels.

Link copied to clipboard
val vpcId: Output<String>? = null

The ID of the network-based SLB instance.

Link copied to clipboard

The list of zones and vSwitch mappings. You must add at least two zones and a maximum of 10 zones. See zone_mappings below.

Functions

Link copied to clipboard
open override fun toJava(): LoadBalancerArgs