1. Packages
  2. Packages
  3. Volcengine
  4. API Docs
  5. clb
  6. Clb
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.getZones({});
    // create vpc
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-vpc",
        cidrBlock: "172.16.0.0/16",
    });
    // create subnet
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-test-subnet",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    // create ipv4 public clb
    const publicClb = new volcengine.clb.Clb("publicClb", {
        type: "public",
        subnetId: fooSubnet.id,
        loadBalancerName: "acc-test-clb-public",
        loadBalancerSpec: "small_1",
        description: "acc-test-demo",
        projectName: "default",
        eipBillingConfig: {
            isp: "BGP",
            eipBillingType: "PostPaidByBandwidth",
            bandwidth: 1,
        },
        tags: [{
            key: "k1",
            value: "v1",
        }],
    });
    // create ipv4 private clb
    const privateClb = new volcengine.clb.Clb("privateClb", {
        type: "private",
        subnetId: fooSubnet.id,
        loadBalancerName: "acc-test-clb-private",
        loadBalancerSpec: "small_1",
        description: "acc-test-demo",
        projectName: "default",
    });
    // create eip
    const eip = new volcengine.eip.Address("eip", {
        billingType: "PostPaidByBandwidth",
        bandwidth: 1,
        isp: "BGP",
        description: "tf-test",
        projectName: "default",
    });
    // associate eip to clb
    const associate = new volcengine.eip.Associate("associate", {
        allocationId: eip.id,
        instanceId: privateClb.id,
        instanceType: "ClbInstance",
    });
    // create ipv6 vpc
    const vpcIpv6 = new volcengine.vpc.Vpc("vpcIpv6", {
        vpcName: "acc-test-vpc-ipv6",
        cidrBlock: "172.16.0.0/16",
        enableIpv6: true,
    });
    // create ipv6 subnet
    const subnetIpv6 = new volcengine.vpc.Subnet("subnetIpv6", {
        subnetName: "acc-test-subnet-ipv6",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[1]?.id),
        vpcId: vpcIpv6.id,
        ipv6CidrBlock: 1,
    });
    // create ipv6 private clb
    const privateClbIpv6 = new volcengine.clb.Clb("privateClbIpv6", {
        type: "private",
        subnetId: subnetIpv6.id,
        loadBalancerName: "acc-test-clb-ipv6",
        loadBalancerSpec: "small_1",
        description: "acc-test-demo",
        projectName: "default",
        addressIpVersion: "DualStack",
    });
    // create ipv6 gateway
    const ipv6Gateway = new volcengine.vpc.Ipv6Gateway("ipv6Gateway", {vpcId: vpcIpv6.id});
    const fooIpv6AddressBandwidth = new volcengine.vpc.Ipv6AddressBandwidth("fooIpv6AddressBandwidth", {
        ipv6Address: privateClbIpv6.eniIpv6Address,
        billingType: "PostPaidByBandwidth",
        bandwidth: 5,
    }, {
        dependsOn: [ipv6Gateway],
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.get_zones()
    # create vpc
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-vpc",
        cidr_block="172.16.0.0/16")
    # create subnet
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-test-subnet",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    # create ipv4 public clb
    public_clb = volcengine.clb.Clb("publicClb",
        type="public",
        subnet_id=foo_subnet.id,
        load_balancer_name="acc-test-clb-public",
        load_balancer_spec="small_1",
        description="acc-test-demo",
        project_name="default",
        eip_billing_config=volcengine.clb.ClbEipBillingConfigArgs(
            isp="BGP",
            eip_billing_type="PostPaidByBandwidth",
            bandwidth=1,
        ),
        tags=[volcengine.clb.ClbTagArgs(
            key="k1",
            value="v1",
        )])
    # create ipv4 private clb
    private_clb = volcengine.clb.Clb("privateClb",
        type="private",
        subnet_id=foo_subnet.id,
        load_balancer_name="acc-test-clb-private",
        load_balancer_spec="small_1",
        description="acc-test-demo",
        project_name="default")
    # create eip
    eip = volcengine.eip.Address("eip",
        billing_type="PostPaidByBandwidth",
        bandwidth=1,
        isp="BGP",
        description="tf-test",
        project_name="default")
    # associate eip to clb
    associate = volcengine.eip.Associate("associate",
        allocation_id=eip.id,
        instance_id=private_clb.id,
        instance_type="ClbInstance")
    # create ipv6 vpc
    vpc_ipv6 = volcengine.vpc.Vpc("vpcIpv6",
        vpc_name="acc-test-vpc-ipv6",
        cidr_block="172.16.0.0/16",
        enable_ipv6=True)
    # create ipv6 subnet
    subnet_ipv6 = volcengine.vpc.Subnet("subnetIpv6",
        subnet_name="acc-test-subnet-ipv6",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[1].id,
        vpc_id=vpc_ipv6.id,
        ipv6_cidr_block=1)
    # create ipv6 private clb
    private_clb_ipv6 = volcengine.clb.Clb("privateClbIpv6",
        type="private",
        subnet_id=subnet_ipv6.id,
        load_balancer_name="acc-test-clb-ipv6",
        load_balancer_spec="small_1",
        description="acc-test-demo",
        project_name="default",
        address_ip_version="DualStack")
    # create ipv6 gateway
    ipv6_gateway = volcengine.vpc.Ipv6Gateway("ipv6Gateway", vpc_id=vpc_ipv6.id)
    foo_ipv6_address_bandwidth = volcengine.vpc.Ipv6AddressBandwidth("fooIpv6AddressBandwidth",
        ipv6_address=private_clb_ipv6.eni_ipv6_address,
        billing_type="PostPaidByBandwidth",
        bandwidth=5,
        opts=pulumi.ResourceOptions(depends_on=[ipv6_gateway]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/clb"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/eip"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		// create vpc
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-vpc"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		// create subnet
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-test-subnet"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv4 public clb
    		_, err = clb.NewClb(ctx, "publicClb", &clb.ClbArgs{
    			Type:             pulumi.String("public"),
    			SubnetId:         fooSubnet.ID(),
    			LoadBalancerName: pulumi.String("acc-test-clb-public"),
    			LoadBalancerSpec: pulumi.String("small_1"),
    			Description:      pulumi.String("acc-test-demo"),
    			ProjectName:      pulumi.String("default"),
    			EipBillingConfig: &clb.ClbEipBillingConfigArgs{
    				Isp:            pulumi.String("BGP"),
    				EipBillingType: pulumi.String("PostPaidByBandwidth"),
    				Bandwidth:      pulumi.Int(1),
    			},
    			Tags: clb.ClbTagArray{
    				&clb.ClbTagArgs{
    					Key:   pulumi.String("k1"),
    					Value: pulumi.String("v1"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv4 private clb
    		privateClb, err := clb.NewClb(ctx, "privateClb", &clb.ClbArgs{
    			Type:             pulumi.String("private"),
    			SubnetId:         fooSubnet.ID(),
    			LoadBalancerName: pulumi.String("acc-test-clb-private"),
    			LoadBalancerSpec: pulumi.String("small_1"),
    			Description:      pulumi.String("acc-test-demo"),
    			ProjectName:      pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		// create eip
    		eip, err := eip.NewAddress(ctx, "eip", &eip.AddressArgs{
    			BillingType: pulumi.String("PostPaidByBandwidth"),
    			Bandwidth:   pulumi.Int(1),
    			Isp:         pulumi.String("BGP"),
    			Description: pulumi.String("tf-test"),
    			ProjectName: pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		// associate eip to clb
    		_, err = eip.NewAssociate(ctx, "associate", &eip.AssociateArgs{
    			AllocationId: eip.ID(),
    			InstanceId:   privateClb.ID(),
    			InstanceType: pulumi.String("ClbInstance"),
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv6 vpc
    		vpcIpv6, err := vpc.NewVpc(ctx, "vpcIpv6", &vpc.VpcArgs{
    			VpcName:    pulumi.String("acc-test-vpc-ipv6"),
    			CidrBlock:  pulumi.String("172.16.0.0/16"),
    			EnableIpv6: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv6 subnet
    		subnetIpv6, err := vpc.NewSubnet(ctx, "subnetIpv6", &vpc.SubnetArgs{
    			SubnetName:    pulumi.String("acc-test-subnet-ipv6"),
    			CidrBlock:     pulumi.String("172.16.0.0/24"),
    			ZoneId:        pulumi.String(fooZones.Zones[1].Id),
    			VpcId:         vpcIpv6.ID(),
    			Ipv6CidrBlock: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv6 private clb
    		privateClbIpv6, err := clb.NewClb(ctx, "privateClbIpv6", &clb.ClbArgs{
    			Type:             pulumi.String("private"),
    			SubnetId:         subnetIpv6.ID(),
    			LoadBalancerName: pulumi.String("acc-test-clb-ipv6"),
    			LoadBalancerSpec: pulumi.String("small_1"),
    			Description:      pulumi.String("acc-test-demo"),
    			ProjectName:      pulumi.String("default"),
    			AddressIpVersion: pulumi.String("DualStack"),
    		})
    		if err != nil {
    			return err
    		}
    		// create ipv6 gateway
    		ipv6Gateway, err := vpc.NewIpv6Gateway(ctx, "ipv6Gateway", &vpc.Ipv6GatewayArgs{
    			VpcId: vpcIpv6.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vpc.NewIpv6AddressBandwidth(ctx, "fooIpv6AddressBandwidth", &vpc.Ipv6AddressBandwidthArgs{
    			Ipv6Address: privateClbIpv6.EniIpv6Address,
    			BillingType: pulumi.String("PostPaidByBandwidth"),
    			Bandwidth:   pulumi.Int(5),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			ipv6Gateway,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.GetZones.Invoke();
    
        // create vpc
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-vpc",
            CidrBlock = "172.16.0.0/16",
        });
    
        // create subnet
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-test-subnet",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        // create ipv4 public clb
        var publicClb = new Volcengine.Clb.Clb("publicClb", new()
        {
            Type = "public",
            SubnetId = fooSubnet.Id,
            LoadBalancerName = "acc-test-clb-public",
            LoadBalancerSpec = "small_1",
            Description = "acc-test-demo",
            ProjectName = "default",
            EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
            {
                Isp = "BGP",
                EipBillingType = "PostPaidByBandwidth",
                Bandwidth = 1,
            },
            Tags = new[]
            {
                new Volcengine.Clb.Inputs.ClbTagArgs
                {
                    Key = "k1",
                    Value = "v1",
                },
            },
        });
    
        // create ipv4 private clb
        var privateClb = new Volcengine.Clb.Clb("privateClb", new()
        {
            Type = "private",
            SubnetId = fooSubnet.Id,
            LoadBalancerName = "acc-test-clb-private",
            LoadBalancerSpec = "small_1",
            Description = "acc-test-demo",
            ProjectName = "default",
        });
    
        // create eip
        var eip = new Volcengine.Eip.Address("eip", new()
        {
            BillingType = "PostPaidByBandwidth",
            Bandwidth = 1,
            Isp = "BGP",
            Description = "tf-test",
            ProjectName = "default",
        });
    
        // associate eip to clb
        var associate = new Volcengine.Eip.Associate("associate", new()
        {
            AllocationId = eip.Id,
            InstanceId = privateClb.Id,
            InstanceType = "ClbInstance",
        });
    
        // create ipv6 vpc
        var vpcIpv6 = new Volcengine.Vpc.Vpc("vpcIpv6", new()
        {
            VpcName = "acc-test-vpc-ipv6",
            CidrBlock = "172.16.0.0/16",
            EnableIpv6 = true,
        });
    
        // create ipv6 subnet
        var subnetIpv6 = new Volcengine.Vpc.Subnet("subnetIpv6", new()
        {
            SubnetName = "acc-test-subnet-ipv6",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[1]?.Id),
            VpcId = vpcIpv6.Id,
            Ipv6CidrBlock = 1,
        });
    
        // create ipv6 private clb
        var privateClbIpv6 = new Volcengine.Clb.Clb("privateClbIpv6", new()
        {
            Type = "private",
            SubnetId = subnetIpv6.Id,
            LoadBalancerName = "acc-test-clb-ipv6",
            LoadBalancerSpec = "small_1",
            Description = "acc-test-demo",
            ProjectName = "default",
            AddressIpVersion = "DualStack",
        });
    
        // create ipv6 gateway
        var ipv6Gateway = new Volcengine.Vpc.Ipv6Gateway("ipv6Gateway", new()
        {
            VpcId = vpcIpv6.Id,
        });
    
        var fooIpv6AddressBandwidth = new Volcengine.Vpc.Ipv6AddressBandwidth("fooIpv6AddressBandwidth", new()
        {
            Ipv6Address = privateClbIpv6.EniIpv6Address,
            BillingType = "PostPaidByBandwidth",
            Bandwidth = 5,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                ipv6Gateway,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.clb.Clb;
    import com.pulumi.volcengine.clb.ClbArgs;
    import com.pulumi.volcengine.clb.inputs.ClbEipBillingConfigArgs;
    import com.pulumi.volcengine.clb.inputs.ClbTagArgs;
    import com.pulumi.volcengine.eip.Address;
    import com.pulumi.volcengine.eip.AddressArgs;
    import com.pulumi.volcengine.eip.Associate;
    import com.pulumi.volcengine.eip.AssociateArgs;
    import com.pulumi.volcengine.vpc.Ipv6Gateway;
    import com.pulumi.volcengine.vpc.Ipv6GatewayArgs;
    import com.pulumi.volcengine.vpc.Ipv6AddressBandwidth;
    import com.pulumi.volcengine.vpc.Ipv6AddressBandwidthArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 fooZones = EcsFunctions.getZones();
    
            // create vpc
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            // create subnet
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            // create ipv4 public clb
            var publicClb = new Clb("publicClb", ClbArgs.builder()        
                .type("public")
                .subnetId(fooSubnet.id())
                .loadBalancerName("acc-test-clb-public")
                .loadBalancerSpec("small_1")
                .description("acc-test-demo")
                .projectName("default")
                .eipBillingConfig(ClbEipBillingConfigArgs.builder()
                    .isp("BGP")
                    .eipBillingType("PostPaidByBandwidth")
                    .bandwidth(1)
                    .build())
                .tags(ClbTagArgs.builder()
                    .key("k1")
                    .value("v1")
                    .build())
                .build());
    
            // create ipv4 private clb
            var privateClb = new Clb("privateClb", ClbArgs.builder()        
                .type("private")
                .subnetId(fooSubnet.id())
                .loadBalancerName("acc-test-clb-private")
                .loadBalancerSpec("small_1")
                .description("acc-test-demo")
                .projectName("default")
                .build());
    
            // create eip
            var eip = new Address("eip", AddressArgs.builder()        
                .billingType("PostPaidByBandwidth")
                .bandwidth(1)
                .isp("BGP")
                .description("tf-test")
                .projectName("default")
                .build());
    
            // associate eip to clb
            var associate = new Associate("associate", AssociateArgs.builder()        
                .allocationId(eip.id())
                .instanceId(privateClb.id())
                .instanceType("ClbInstance")
                .build());
    
            // create ipv6 vpc
            var vpcIpv6 = new Vpc("vpcIpv6", VpcArgs.builder()        
                .vpcName("acc-test-vpc-ipv6")
                .cidrBlock("172.16.0.0/16")
                .enableIpv6(true)
                .build());
    
            // create ipv6 subnet
            var subnetIpv6 = new Subnet("subnetIpv6", SubnetArgs.builder()        
                .subnetName("acc-test-subnet-ipv6")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[1].id()))
                .vpcId(vpcIpv6.id())
                .ipv6CidrBlock(1)
                .build());
    
            // create ipv6 private clb
            var privateClbIpv6 = new Clb("privateClbIpv6", ClbArgs.builder()        
                .type("private")
                .subnetId(subnetIpv6.id())
                .loadBalancerName("acc-test-clb-ipv6")
                .loadBalancerSpec("small_1")
                .description("acc-test-demo")
                .projectName("default")
                .addressIpVersion("DualStack")
                .build());
    
            // create ipv6 gateway
            var ipv6Gateway = new Ipv6Gateway("ipv6Gateway", Ipv6GatewayArgs.builder()        
                .vpcId(vpcIpv6.id())
                .build());
    
            var fooIpv6AddressBandwidth = new Ipv6AddressBandwidth("fooIpv6AddressBandwidth", Ipv6AddressBandwidthArgs.builder()        
                .ipv6Address(privateClbIpv6.eniIpv6Address())
                .billingType("PostPaidByBandwidth")
                .bandwidth(5)
                .build(), CustomResourceOptions.builder()
                    .dependsOn(ipv6Gateway)
                    .build());
    
        }
    }
    
    resources:
      # create vpc
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      # create subnet
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      # create ipv4 public clb
      publicClb:
        type: volcengine:clb:Clb
        properties:
          type: public
          subnetId: ${fooSubnet.id}
          loadBalancerName: acc-test-clb-public
          loadBalancerSpec: small_1
          description: acc-test-demo
          projectName: default
          eipBillingConfig:
            isp: BGP
            eipBillingType: PostPaidByBandwidth
            bandwidth: 1
          tags:
            - key: k1
              value: v1
      # create ipv4 private clb
      privateClb:
        type: volcengine:clb:Clb
        properties:
          type: private
          subnetId: ${fooSubnet.id}
          loadBalancerName: acc-test-clb-private
          loadBalancerSpec: small_1
          description: acc-test-demo
          projectName: default
      # create eip
      eip:
        type: volcengine:eip:Address
        properties:
          billingType: PostPaidByBandwidth
          bandwidth: 1
          isp: BGP
          description: tf-test
          projectName: default
      # associate eip to clb
      associate:
        type: volcengine:eip:Associate
        properties:
          allocationId: ${eip.id}
          instanceId: ${privateClb.id}
          instanceType: ClbInstance
      # create ipv6 vpc
      vpcIpv6:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc-ipv6
          cidrBlock: 172.16.0.0/16
          enableIpv6: true
      # create ipv6 subnet
      subnetIpv6:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet-ipv6
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[1].id}
          vpcId: ${vpcIpv6.id}
          ipv6CidrBlock: 1
      # create ipv6 private clb
      privateClbIpv6:
        type: volcengine:clb:Clb
        properties:
          type: private
          subnetId: ${subnetIpv6.id}
          loadBalancerName: acc-test-clb-ipv6
          loadBalancerSpec: small_1
          description: acc-test-demo
          projectName: default
          addressIpVersion: DualStack
      # create ipv6 gateway
      ipv6Gateway:
        type: volcengine:vpc:Ipv6Gateway
        properties:
          vpcId: ${vpcIpv6.id}
      fooIpv6AddressBandwidth:
        type: volcengine:vpc:Ipv6AddressBandwidth
        properties:
          ipv6Address: ${privateClbIpv6.eniIpv6Address}
          billingType: PostPaidByBandwidth
          bandwidth: 5
        options:
          dependson:
            - ${ipv6Gateway}
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
    
    Example coming soon!
    

    Create Clb Resource

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

    Constructor syntax

    new Clb(name: string, args: ClbArgs, opts?: CustomResourceOptions);
    @overload
    def Clb(resource_name: str,
            args: ClbArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Clb(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            subnet_id: Optional[str] = None,
            type: Optional[str] = None,
            modification_protection_status: Optional[str] = None,
            load_balancer_name: Optional[str] = None,
            eni_address: Optional[str] = None,
            eni_address_num: Optional[int] = None,
            eni_ipv6_address: Optional[str] = None,
            load_balancer_billing_type: Optional[str] = None,
            period: Optional[int] = None,
            load_balancer_spec: Optional[str] = None,
            master_zone_id: Optional[str] = None,
            modification_protection_reason: Optional[str] = None,
            eip_billing_config: Optional[ClbEipBillingConfigArgs] = None,
            address_ip_version: Optional[str] = None,
            renew_type: Optional[str] = None,
            region_id: Optional[str] = None,
            remain_renew_times: Optional[int] = None,
            renew_period_times: Optional[int] = None,
            project_name: Optional[str] = None,
            slave_zone_id: Optional[str] = None,
            description: Optional[str] = None,
            tags: Optional[Sequence[ClbTagArgs]] = None,
            timestamp_remove_enabled: Optional[str] = None,
            bypass_security_group_enabled: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zone_type: Optional[str] = None)
    func NewClb(ctx *Context, name string, args ClbArgs, opts ...ResourceOption) (*Clb, error)
    public Clb(string name, ClbArgs args, CustomResourceOptions? opts = null)
    public Clb(String name, ClbArgs args)
    public Clb(String name, ClbArgs args, CustomResourceOptions options)
    
    type: volcengine:clb:Clb
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcengine_clb_clb" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ClbArgs
    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 ClbArgs
    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 ClbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClbArgs
    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 clbResource = new Volcengine.Clb.Clb("clbResource", new()
    {
        SubnetId = "string",
        Type = "string",
        ModificationProtectionStatus = "string",
        LoadBalancerName = "string",
        EniAddress = "string",
        EniAddressNum = 0,
        EniIpv6Address = "string",
        LoadBalancerBillingType = "string",
        Period = 0,
        LoadBalancerSpec = "string",
        MasterZoneId = "string",
        ModificationProtectionReason = "string",
        EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
        {
            EipBillingType = "string",
            Isp = "string",
            Bandwidth = 0,
            BandwidthPackageId = "string",
            SecurityProtectionInstanceId = "string",
            SecurityProtectionTypes = new[]
            {
                "string",
            },
        },
        AddressIpVersion = "string",
        RenewType = "string",
        RegionId = "string",
        RemainRenewTimes = 0,
        RenewPeriodTimes = 0,
        ProjectName = "string",
        SlaveZoneId = "string",
        Description = "string",
        Tags = new[]
        {
            new Volcengine.Clb.Inputs.ClbTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        TimestampRemoveEnabled = "string",
        BypassSecurityGroupEnabled = "string",
        VpcId = "string",
        ZoneType = "string",
    });
    
    example, err := clb.NewClb(ctx, "clbResource", &clb.ClbArgs{
    	SubnetId:                     pulumi.String("string"),
    	Type:                         pulumi.String("string"),
    	ModificationProtectionStatus: pulumi.String("string"),
    	LoadBalancerName:             pulumi.String("string"),
    	EniAddress:                   pulumi.String("string"),
    	EniAddressNum:                pulumi.Int(0),
    	EniIpv6Address:               pulumi.String("string"),
    	LoadBalancerBillingType:      pulumi.String("string"),
    	Period:                       pulumi.Int(0),
    	LoadBalancerSpec:             pulumi.String("string"),
    	MasterZoneId:                 pulumi.String("string"),
    	ModificationProtectionReason: pulumi.String("string"),
    	EipBillingConfig: &clb.ClbEipBillingConfigArgs{
    		EipBillingType:               pulumi.String("string"),
    		Isp:                          pulumi.String("string"),
    		Bandwidth:                    pulumi.Int(0),
    		BandwidthPackageId:           pulumi.String("string"),
    		SecurityProtectionInstanceId: pulumi.String("string"),
    		SecurityProtectionTypes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	AddressIpVersion: pulumi.String("string"),
    	RenewType:        pulumi.String("string"),
    	RegionId:         pulumi.String("string"),
    	RemainRenewTimes: pulumi.Int(0),
    	RenewPeriodTimes: pulumi.Int(0),
    	ProjectName:      pulumi.String("string"),
    	SlaveZoneId:      pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Tags: clb.ClbTagArray{
    		&clb.ClbTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	TimestampRemoveEnabled:     pulumi.String("string"),
    	BypassSecurityGroupEnabled: pulumi.String("string"),
    	VpcId:                      pulumi.String("string"),
    	ZoneType:                   pulumi.String("string"),
    })
    
    resource "volcengine_clb_clb" "clbResource" {
      subnet_id                      = "string"
      type                           = "string"
      modification_protection_status = "string"
      load_balancer_name             = "string"
      eni_address                    = "string"
      eni_address_num                = 0
      eni_ipv6_address               = "string"
      load_balancer_billing_type     = "string"
      period                         = 0
      load_balancer_spec             = "string"
      master_zone_id                 = "string"
      modification_protection_reason = "string"
      eip_billing_config = {
        eip_billing_type                = "string"
        isp                             = "string"
        bandwidth                       = 0
        bandwidth_package_id            = "string"
        security_protection_instance_id = "string"
        security_protection_types       = ["string"]
      }
      address_ip_version = "string"
      renew_type         = "string"
      region_id          = "string"
      remain_renew_times = 0
      renew_period_times = 0
      project_name       = "string"
      slave_zone_id      = "string"
      description        = "string"
      tags {
        key   = "string"
        value = "string"
      }
      timestamp_remove_enabled      = "string"
      bypass_security_group_enabled = "string"
      vpc_id                        = "string"
      zone_type                     = "string"
    }
    
    var clbResource = new Clb("clbResource", ClbArgs.builder()
        .subnetId("string")
        .type("string")
        .modificationProtectionStatus("string")
        .loadBalancerName("string")
        .eniAddress("string")
        .eniAddressNum(0)
        .eniIpv6Address("string")
        .loadBalancerBillingType("string")
        .period(0)
        .loadBalancerSpec("string")
        .masterZoneId("string")
        .modificationProtectionReason("string")
        .eipBillingConfig(ClbEipBillingConfigArgs.builder()
            .eipBillingType("string")
            .isp("string")
            .bandwidth(0)
            .bandwidthPackageId("string")
            .securityProtectionInstanceId("string")
            .securityProtectionTypes("string")
            .build())
        .addressIpVersion("string")
        .renewType("string")
        .regionId("string")
        .remainRenewTimes(0)
        .renewPeriodTimes(0)
        .projectName("string")
        .slaveZoneId("string")
        .description("string")
        .tags(ClbTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .timestampRemoveEnabled("string")
        .bypassSecurityGroupEnabled("string")
        .vpcId("string")
        .zoneType("string")
        .build());
    
    clb_resource = volcengine.clb.Clb("clbResource",
        subnet_id="string",
        type="string",
        modification_protection_status="string",
        load_balancer_name="string",
        eni_address="string",
        eni_address_num=0,
        eni_ipv6_address="string",
        load_balancer_billing_type="string",
        period=0,
        load_balancer_spec="string",
        master_zone_id="string",
        modification_protection_reason="string",
        eip_billing_config={
            "eip_billing_type": "string",
            "isp": "string",
            "bandwidth": 0,
            "bandwidth_package_id": "string",
            "security_protection_instance_id": "string",
            "security_protection_types": ["string"],
        },
        address_ip_version="string",
        renew_type="string",
        region_id="string",
        remain_renew_times=0,
        renew_period_times=0,
        project_name="string",
        slave_zone_id="string",
        description="string",
        tags=[{
            "key": "string",
            "value": "string",
        }],
        timestamp_remove_enabled="string",
        bypass_security_group_enabled="string",
        vpc_id="string",
        zone_type="string")
    
    const clbResource = new volcengine.clb.Clb("clbResource", {
        subnetId: "string",
        type: "string",
        modificationProtectionStatus: "string",
        loadBalancerName: "string",
        eniAddress: "string",
        eniAddressNum: 0,
        eniIpv6Address: "string",
        loadBalancerBillingType: "string",
        period: 0,
        loadBalancerSpec: "string",
        masterZoneId: "string",
        modificationProtectionReason: "string",
        eipBillingConfig: {
            eipBillingType: "string",
            isp: "string",
            bandwidth: 0,
            bandwidthPackageId: "string",
            securityProtectionInstanceId: "string",
            securityProtectionTypes: ["string"],
        },
        addressIpVersion: "string",
        renewType: "string",
        regionId: "string",
        remainRenewTimes: 0,
        renewPeriodTimes: 0,
        projectName: "string",
        slaveZoneId: "string",
        description: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        timestampRemoveEnabled: "string",
        bypassSecurityGroupEnabled: "string",
        vpcId: "string",
        zoneType: "string",
    });
    
    type: volcengine:clb:Clb
    properties:
        addressIpVersion: string
        bypassSecurityGroupEnabled: string
        description: string
        eipBillingConfig:
            bandwidth: 0
            bandwidthPackageId: string
            eipBillingType: string
            isp: string
            securityProtectionInstanceId: string
            securityProtectionTypes:
                - string
        eniAddress: string
        eniAddressNum: 0
        eniIpv6Address: string
        loadBalancerBillingType: string
        loadBalancerName: string
        loadBalancerSpec: string
        masterZoneId: string
        modificationProtectionReason: string
        modificationProtectionStatus: string
        period: 0
        projectName: string
        regionId: string
        remainRenewTimes: 0
        renewPeriodTimes: 0
        renewType: string
        slaveZoneId: string
        subnetId: string
        tags:
            - key: string
              value: string
        timestampRemoveEnabled: string
        type: string
        vpcId: string
        zoneType: string
    

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

    SubnetId string
    The id of the Subnet.
    Type string
    The type of the CLB. And optional choice contains public or private.
    AddressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    BypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    Description string
    The description of the CLB.
    EipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    EniAddress string
    The eni address of the CLB.
    EniAddressNum int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    EniIpv6Address string
    The eni ipv6 address of the Clb.
    LoadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    LoadBalancerName string
    The name of the CLB.
    LoadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    MasterZoneId string
    The master zone ID of the CLB.
    ModificationProtectionReason string
    The reason of the console modification protection.
    ModificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    Period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The ProjectName of the CLB.
    RegionId string
    The region of the request.
    RemainRenewTimes int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    RenewPeriodTimes int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    RenewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    SlaveZoneId string
    The slave zone ID of the CLB.
    Tags List<ClbTag>
    Tags.
    TimestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    VpcId string
    The id of the VPC.
    ZoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    SubnetId string
    The id of the Subnet.
    Type string
    The type of the CLB. And optional choice contains public or private.
    AddressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    BypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    Description string
    The description of the CLB.
    EipBillingConfig ClbEipBillingConfigArgs
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    EniAddress string
    The eni address of the CLB.
    EniAddressNum int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    EniIpv6Address string
    The eni ipv6 address of the Clb.
    LoadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    LoadBalancerName string
    The name of the CLB.
    LoadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    MasterZoneId string
    The master zone ID of the CLB.
    ModificationProtectionReason string
    The reason of the console modification protection.
    ModificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    Period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The ProjectName of the CLB.
    RegionId string
    The region of the request.
    RemainRenewTimes int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    RenewPeriodTimes int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    RenewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    SlaveZoneId string
    The slave zone ID of the CLB.
    Tags []ClbTagArgs
    Tags.
    TimestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    VpcId string
    The id of the VPC.
    ZoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    subnet_id string
    The id of the Subnet.
    type string
    The type of the CLB. And optional choice contains public or private.
    address_ip_version string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypass_security_group_enabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description string
    The description of the CLB.
    eip_billing_config object
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eni_address string
    The eni address of the CLB.
    eni_address_num number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eni_ipv6_address string
    The eni ipv6 address of the Clb.
    load_balancer_billing_type string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    load_balancer_name string
    The name of the CLB.
    load_balancer_spec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    master_zone_id string
    The master zone ID of the CLB.
    modification_protection_reason string
    The reason of the console modification protection.
    modification_protection_status string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name string
    The ProjectName of the CLB.
    region_id string
    The region of the request.
    remain_renew_times number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renew_period_times number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renew_type string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slave_zone_id string
    The slave zone ID of the CLB.
    tags list(object)
    Tags.
    timestamp_remove_enabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    vpc_id string
    The id of the VPC.
    zone_type string
    The zone type of the CLB. And optional choice contains single or active-standby.
    subnetId String
    The id of the Subnet.
    type String
    The type of the CLB. And optional choice contains public or private.
    addressIpVersion String
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled String
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description String
    The description of the CLB.
    eipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eniAddress String
    The eni address of the CLB.
    eniAddressNum Integer
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address String
    The eni ipv6 address of the Clb.
    loadBalancerBillingType String
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName String
    The name of the CLB.
    loadBalancerSpec String
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId String
    The master zone ID of the CLB.
    modificationProtectionReason String
    The reason of the console modification protection.
    modificationProtectionStatus String
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period Integer
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The ProjectName of the CLB.
    regionId String
    The region of the request.
    remainRenewTimes Integer
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes Integer
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType String
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId String
    The slave zone ID of the CLB.
    tags List<ClbTag>
    Tags.
    timestampRemoveEnabled String
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    vpcId String
    The id of the VPC.
    zoneType String
    The zone type of the CLB. And optional choice contains single or active-standby.
    subnetId string
    The id of the Subnet.
    type string
    The type of the CLB. And optional choice contains public or private.
    addressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description string
    The description of the CLB.
    eipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eniAddress string
    The eni address of the CLB.
    eniAddressNum number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address string
    The eni ipv6 address of the Clb.
    loadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName string
    The name of the CLB.
    loadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId string
    The master zone ID of the CLB.
    modificationProtectionReason string
    The reason of the console modification protection.
    modificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName string
    The ProjectName of the CLB.
    regionId string
    The region of the request.
    remainRenewTimes number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId string
    The slave zone ID of the CLB.
    tags ClbTag[]
    Tags.
    timestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    vpcId string
    The id of the VPC.
    zoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    subnet_id str
    The id of the Subnet.
    type str
    The type of the CLB. And optional choice contains public or private.
    address_ip_version str
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypass_security_group_enabled str
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description str
    The description of the CLB.
    eip_billing_config ClbEipBillingConfigArgs
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eni_address str
    The eni address of the CLB.
    eni_address_num int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eni_ipv6_address str
    The eni ipv6 address of the Clb.
    load_balancer_billing_type str
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    load_balancer_name str
    The name of the CLB.
    load_balancer_spec str
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    master_zone_id str
    The master zone ID of the CLB.
    modification_protection_reason str
    The reason of the console modification protection.
    modification_protection_status str
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name str
    The ProjectName of the CLB.
    region_id str
    The region of the request.
    remain_renew_times int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renew_period_times int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renew_type str
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slave_zone_id str
    The slave zone ID of the CLB.
    tags Sequence[ClbTagArgs]
    Tags.
    timestamp_remove_enabled str
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    vpc_id str
    The id of the VPC.
    zone_type str
    The zone type of the CLB. And optional choice contains single or active-standby.
    subnetId String
    The id of the Subnet.
    type String
    The type of the CLB. And optional choice contains public or private.
    addressIpVersion String
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled String
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description String
    The description of the CLB.
    eipBillingConfig Property Map
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eniAddress String
    The eni address of the CLB.
    eniAddressNum Number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address String
    The eni ipv6 address of the Clb.
    loadBalancerBillingType String
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName String
    The name of the CLB.
    loadBalancerSpec String
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId String
    The master zone ID of the CLB.
    modificationProtectionReason String
    The reason of the console modification protection.
    modificationProtectionStatus String
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period Number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The ProjectName of the CLB.
    regionId String
    The region of the request.
    remainRenewTimes Number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes Number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType String
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId String
    The slave zone ID of the CLB.
    tags List<Property Map>
    Tags.
    timestampRemoveEnabled String
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    vpcId String
    The id of the VPC.
    zoneType String
    The zone type of the CLB. And optional choice contains single or active-standby.

    Outputs

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

    EipAddress string
    The Eip address of the Clb.
    EipId string
    The Eip ID of the Clb.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    EipAddress string
    The Eip address of the Clb.
    EipId string
    The Eip ID of the Clb.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    eip_address string
    The Eip address of the Clb.
    eip_id string
    The Eip ID of the Clb.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv6_eip_id string
    The Ipv6 Eip ID of the Clb.
    eipAddress String
    The Eip address of the Clb.
    eipId String
    The Eip ID of the Clb.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6EipId String
    The Ipv6 Eip ID of the Clb.
    eipAddress string
    The Eip address of the Clb.
    eipId string
    The Eip ID of the Clb.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    eip_address str
    The Eip address of the Clb.
    eip_id str
    The Eip ID of the Clb.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv6_eip_id str
    The Ipv6 Eip ID of the Clb.
    eipAddress String
    The Eip address of the Clb.
    eipId String
    The Eip ID of the Clb.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6EipId String
    The Ipv6 Eip ID of the Clb.

    Look up Existing Clb Resource

    Get an existing Clb 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?: ClbState, opts?: CustomResourceOptions): Clb
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address_ip_version: Optional[str] = None,
            bypass_security_group_enabled: Optional[str] = None,
            description: Optional[str] = None,
            eip_address: Optional[str] = None,
            eip_billing_config: Optional[ClbEipBillingConfigArgs] = None,
            eip_id: Optional[str] = None,
            eni_address: Optional[str] = None,
            eni_address_num: Optional[int] = None,
            eni_ipv6_address: Optional[str] = None,
            ipv6_eip_id: Optional[str] = None,
            load_balancer_billing_type: Optional[str] = None,
            load_balancer_name: Optional[str] = None,
            load_balancer_spec: Optional[str] = None,
            master_zone_id: Optional[str] = None,
            modification_protection_reason: Optional[str] = None,
            modification_protection_status: Optional[str] = None,
            period: Optional[int] = None,
            project_name: Optional[str] = None,
            region_id: Optional[str] = None,
            remain_renew_times: Optional[int] = None,
            renew_period_times: Optional[int] = None,
            renew_type: Optional[str] = None,
            slave_zone_id: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Sequence[ClbTagArgs]] = None,
            timestamp_remove_enabled: Optional[str] = None,
            type: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zone_type: Optional[str] = None) -> Clb
    func GetClb(ctx *Context, name string, id IDInput, state *ClbState, opts ...ResourceOption) (*Clb, error)
    public static Clb Get(string name, Input<string> id, ClbState? state, CustomResourceOptions? opts = null)
    public static Clb get(String name, Output<String> id, ClbState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:clb:Clb    get:      id: ${id}
    import {
      to = volcengine_clb_clb.example
      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.
    The following state arguments are supported:
    AddressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    BypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    Description string
    The description of the CLB.
    EipAddress string
    The Eip address of the Clb.
    EipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    EipId string
    The Eip ID of the Clb.
    EniAddress string
    The eni address of the CLB.
    EniAddressNum int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    EniIpv6Address string
    The eni ipv6 address of the Clb.
    Ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    LoadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    LoadBalancerName string
    The name of the CLB.
    LoadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    MasterZoneId string
    The master zone ID of the CLB.
    ModificationProtectionReason string
    The reason of the console modification protection.
    ModificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    Period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The ProjectName of the CLB.
    RegionId string
    The region of the request.
    RemainRenewTimes int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    RenewPeriodTimes int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    RenewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    SlaveZoneId string
    The slave zone ID of the CLB.
    SubnetId string
    The id of the Subnet.
    Tags List<ClbTag>
    Tags.
    TimestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    Type string
    The type of the CLB. And optional choice contains public or private.
    VpcId string
    The id of the VPC.
    ZoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    AddressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    BypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    Description string
    The description of the CLB.
    EipAddress string
    The Eip address of the Clb.
    EipBillingConfig ClbEipBillingConfigArgs
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    EipId string
    The Eip ID of the Clb.
    EniAddress string
    The eni address of the CLB.
    EniAddressNum int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    EniIpv6Address string
    The eni ipv6 address of the Clb.
    Ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    LoadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    LoadBalancerName string
    The name of the CLB.
    LoadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    MasterZoneId string
    The master zone ID of the CLB.
    ModificationProtectionReason string
    The reason of the console modification protection.
    ModificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    Period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ProjectName string
    The ProjectName of the CLB.
    RegionId string
    The region of the request.
    RemainRenewTimes int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    RenewPeriodTimes int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    RenewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    SlaveZoneId string
    The slave zone ID of the CLB.
    SubnetId string
    The id of the Subnet.
    Tags []ClbTagArgs
    Tags.
    TimestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    Type string
    The type of the CLB. And optional choice contains public or private.
    VpcId string
    The id of the VPC.
    ZoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    address_ip_version string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypass_security_group_enabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description string
    The description of the CLB.
    eip_address string
    The Eip address of the Clb.
    eip_billing_config object
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eip_id string
    The Eip ID of the Clb.
    eni_address string
    The eni address of the CLB.
    eni_address_num number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eni_ipv6_address string
    The eni ipv6 address of the Clb.
    ipv6_eip_id string
    The Ipv6 Eip ID of the Clb.
    load_balancer_billing_type string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    load_balancer_name string
    The name of the CLB.
    load_balancer_spec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    master_zone_id string
    The master zone ID of the CLB.
    modification_protection_reason string
    The reason of the console modification protection.
    modification_protection_status string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name string
    The ProjectName of the CLB.
    region_id string
    The region of the request.
    remain_renew_times number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renew_period_times number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renew_type string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slave_zone_id string
    The slave zone ID of the CLB.
    subnet_id string
    The id of the Subnet.
    tags list(object)
    Tags.
    timestamp_remove_enabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    type string
    The type of the CLB. And optional choice contains public or private.
    vpc_id string
    The id of the VPC.
    zone_type string
    The zone type of the CLB. And optional choice contains single or active-standby.
    addressIpVersion String
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled String
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description String
    The description of the CLB.
    eipAddress String
    The Eip address of the Clb.
    eipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eipId String
    The Eip ID of the Clb.
    eniAddress String
    The eni address of the CLB.
    eniAddressNum Integer
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address String
    The eni ipv6 address of the Clb.
    ipv6EipId String
    The Ipv6 Eip ID of the Clb.
    loadBalancerBillingType String
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName String
    The name of the CLB.
    loadBalancerSpec String
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId String
    The master zone ID of the CLB.
    modificationProtectionReason String
    The reason of the console modification protection.
    modificationProtectionStatus String
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period Integer
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The ProjectName of the CLB.
    regionId String
    The region of the request.
    remainRenewTimes Integer
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes Integer
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType String
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId String
    The slave zone ID of the CLB.
    subnetId String
    The id of the Subnet.
    tags List<ClbTag>
    Tags.
    timestampRemoveEnabled String
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    type String
    The type of the CLB. And optional choice contains public or private.
    vpcId String
    The id of the VPC.
    zoneType String
    The zone type of the CLB. And optional choice contains single or active-standby.
    addressIpVersion string
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled string
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description string
    The description of the CLB.
    eipAddress string
    The Eip address of the Clb.
    eipBillingConfig ClbEipBillingConfig
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eipId string
    The Eip ID of the Clb.
    eniAddress string
    The eni address of the CLB.
    eniAddressNum number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address string
    The eni ipv6 address of the Clb.
    ipv6EipId string
    The Ipv6 Eip ID of the Clb.
    loadBalancerBillingType string
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName string
    The name of the CLB.
    loadBalancerSpec string
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId string
    The master zone ID of the CLB.
    modificationProtectionReason string
    The reason of the console modification protection.
    modificationProtectionStatus string
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName string
    The ProjectName of the CLB.
    regionId string
    The region of the request.
    remainRenewTimes number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType string
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId string
    The slave zone ID of the CLB.
    subnetId string
    The id of the Subnet.
    tags ClbTag[]
    Tags.
    timestampRemoveEnabled string
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    type string
    The type of the CLB. And optional choice contains public or private.
    vpcId string
    The id of the VPC.
    zoneType string
    The zone type of the CLB. And optional choice contains single or active-standby.
    address_ip_version str
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypass_security_group_enabled str
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description str
    The description of the CLB.
    eip_address str
    The Eip address of the Clb.
    eip_billing_config ClbEipBillingConfigArgs
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eip_id str
    The Eip ID of the Clb.
    eni_address str
    The eni address of the CLB.
    eni_address_num int
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eni_ipv6_address str
    The eni ipv6 address of the Clb.
    ipv6_eip_id str
    The Ipv6 Eip ID of the Clb.
    load_balancer_billing_type str
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    load_balancer_name str
    The name of the CLB.
    load_balancer_spec str
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    master_zone_id str
    The master zone ID of the CLB.
    modification_protection_reason str
    The reason of the console modification protection.
    modification_protection_status str
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period int
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    project_name str
    The ProjectName of the CLB.
    region_id str
    The region of the request.
    remain_renew_times int
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renew_period_times int
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renew_type str
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slave_zone_id str
    The slave zone ID of the CLB.
    subnet_id str
    The id of the Subnet.
    tags Sequence[ClbTagArgs]
    Tags.
    timestamp_remove_enabled str
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    type str
    The type of the CLB. And optional choice contains public or private.
    vpc_id str
    The id of the VPC.
    zone_type str
    The zone type of the CLB. And optional choice contains single or active-standby.
    addressIpVersion String
    The address ip version of the Clb. Valid values: ipv4, DualStack. Default is ipv4. When the value of this field is DualStack, the type of the CLB must be private, and suggest using a combination of resource volcengine.vpc.Ipv6Gateway and volcengine.vpc.Ipv6AddressBandwidth to achieve ipv6 public network access function.
    bypassSecurityGroupEnabled String
    Whether the CLB instance enables the "Allow Backend Security Group" function. value range: on, off.
    description String
    The description of the CLB.
    eipAddress String
    The Eip address of the Clb.
    eipBillingConfig Property Map
    The billing configuration of the EIP which automatically associated to CLB. This field is valid when the type of CLB is public.When the type of the CLB is private, suggest using a combination of resource volcengine.eip.Address and volcengine.eip.Associate to achieve public network access function.
    eipId String
    The Eip ID of the Clb.
    eniAddress String
    The eni address of the CLB.
    eniAddressNum Number
    The number of private IPv4 addresses for the CLB instance. This parameter is valid only when the type parameter is set to private and eni_address is not passed in.
    eniIpv6Address String
    The eni ipv6 address of the Clb.
    ipv6EipId String
    The Ipv6 Eip ID of the Clb.
    loadBalancerBillingType String
    The billing type of the CLB, valid values: PostPaid, PrePaid, PostPaidByLCU. Default is PostPaid.
    loadBalancerName String
    The name of the CLB.
    loadBalancerSpec String
    The specification of the CLB, the value can be small_1, small_2, medium_1, medium_2, large_1, large_2. When the value of the load_balancer_billing_type is PostPaidByLCU, this field does not need to be specified.
    masterZoneId String
    The master zone ID of the CLB.
    modificationProtectionReason String
    The reason of the console modification protection.
    modificationProtectionStatus String
    The status of the console modification protection, the value can be NonProtection or ConsoleProtection.
    period Number
    The period of the NatGateway, the valid value range in 1~9 or 12 or 24 or 36. Default value is 12. The period unit defaults to Month.This field is only effective when creating a PrePaid NatGateway. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    projectName String
    The ProjectName of the CLB.
    regionId String
    The region of the request.
    remainRenewTimes Number
    The remain renew times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: -1, 1~100. The -1 indicates unlimited automatic renewals.
    renewPeriodTimes Number
    The renew period times of the CLB. When the value of the renew_type is AutoRenew, this field is effective. Valid values: 1, 2, 3, 6, 12.
    renewType String
    The renew type of the CLB. When the value of the load_balancer_billing_type is PrePaid, the query returns this field. Valid values: AutoRenew, ManualRenew.
    slaveZoneId String
    The slave zone ID of the CLB.
    subnetId String
    The id of the Subnet.
    tags List<Property Map>
    Tags.
    timestampRemoveEnabled String
    Whether to enable the function of clearing the timestamp of TCP/HTTP/HTTPS packets (i.e., the time stamp). value range: on, off.
    type String
    The type of the CLB. And optional choice contains public or private.
    vpcId String
    The id of the VPC.
    zoneType String
    The zone type of the CLB. And optional choice contains single or active-standby.

    Supporting Types

    ClbEipBillingConfig, ClbEipBillingConfigArgs

    EipBillingType string
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    Isp string
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    Bandwidth int
    The peek bandwidth of the EIP which automatically assigned to CLB.
    BandwidthPackageId string
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    SecurityProtectionInstanceId string
    The ID of the DDoS native protection (Enterprise Edition) instance.
    SecurityProtectionTypes List<string>
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    EipBillingType string
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    Isp string
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    Bandwidth int
    The peek bandwidth of the EIP which automatically assigned to CLB.
    BandwidthPackageId string
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    SecurityProtectionInstanceId string
    The ID of the DDoS native protection (Enterprise Edition) instance.
    SecurityProtectionTypes []string
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    eip_billing_type string
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    isp string
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    bandwidth number
    The peek bandwidth of the EIP which automatically assigned to CLB.
    bandwidth_package_id string
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    security_protection_instance_id string
    The ID of the DDoS native protection (Enterprise Edition) instance.
    security_protection_types list(string)
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    eipBillingType String
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    isp String
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    bandwidth Integer
    The peek bandwidth of the EIP which automatically assigned to CLB.
    bandwidthPackageId String
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    securityProtectionInstanceId String
    The ID of the DDoS native protection (Enterprise Edition) instance.
    securityProtectionTypes List<String>
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    eipBillingType string
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    isp string
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    bandwidth number
    The peek bandwidth of the EIP which automatically assigned to CLB.
    bandwidthPackageId string
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    securityProtectionInstanceId string
    The ID of the DDoS native protection (Enterprise Edition) instance.
    securityProtectionTypes string[]
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    eip_billing_type str
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    isp str
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    bandwidth int
    The peek bandwidth of the EIP which automatically assigned to CLB.
    bandwidth_package_id str
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    security_protection_instance_id str
    The ID of the DDoS native protection (Enterprise Edition) instance.
    security_protection_types Sequence[str]
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    eipBillingType String
    The billing type of the EIP which automatically assigned to CLB. And optional choice contains PostPaidByBandwidth or PostPaidByTraffic or PrePaid.When creating a PrePaid public CLB, this field must be specified as PrePaid simultaneously.When the LoadBalancerBillingType changes from PostPaid to PrePaid, please manually modify the value of this field to PrePaid simultaneously.
    isp String
    The ISP of the EIP which automatically associated to CLB, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom or SingleLine_BGP or Static_BGP or Fusion_BGP.
    bandwidth Number
    The peek bandwidth of the EIP which automatically assigned to CLB.
    bandwidthPackageId String
    The ID of the shared bandwidth package that the EIP is to be added to. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.
    securityProtectionInstanceId String
    The ID of the DDoS native protection (Enterprise Edition) instance.
    securityProtectionTypes List<String>
    The security protection types of the EIP. Only valid when the eip_billing_type is PostPaidByBandwidth or PostPaidByTraffic.

    ClbTag, ClbTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

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

    $ pulumi import volcengine:clb/clb:Clb default clb-273y2ok6ets007fap8txvf6us
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.