Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. IpPool
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpc.IpPool

volcenginecc logo
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    IP address pool resources.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const example = new volcenginecc.vpc.IpPool("example", {
    isp: "BGP",
    cidrMask: 28,
    description: "ccapi ip pool with cidr mask",
    name: "ccapi-ippool-cidr-mask",
    projectName: "default",
    tags: [{
        key: "k1",
        value: "v1",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.vpc.IpPool("example",
    isp="BGP",
    cidr_mask=28,
    description="ccapi ip pool with cidr mask",
    name="ccapi-ippool-cidr-mask",
    project_name="default",
    tags=[{
        "key": "k1",
        "value": "v1",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.NewIpPool(ctx, "example", &vpc.IpPoolArgs{
			Isp:         pulumi.String("BGP"),
			CidrMask:    pulumi.Int(28),
			Description: pulumi.String("ccapi ip pool with cidr mask"),
			Name:        pulumi.String("ccapi-ippool-cidr-mask"),
			ProjectName: pulumi.String("default"),
			Tags: vpc.IpPoolTagArray{
				&vpc.IpPoolTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var example = new Volcenginecc.Vpc.IpPool("example", new()
    {
        Isp = "BGP",
        CidrMask = 28,
        Description = "ccapi ip pool with cidr mask",
        Name = "ccapi-ippool-cidr-mask",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Vpc.Inputs.IpPoolTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vpc.IpPool;
import com.volcengine.volcenginecc.vpc.IpPoolArgs;
import com.pulumi.volcenginecc.vpc.inputs.IpPoolTagArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IpPool("example", IpPoolArgs.builder()
            .isp("BGP")
            .cidrMask(28)
            .description("ccapi ip pool with cidr mask")
            .name("ccapi-ippool-cidr-mask")
            .projectName("default")
            .tags(IpPoolTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:vpc:IpPool
    properties:
      isp: BGP
      cidrMask: 28
      description: ccapi ip pool with cidr mask
      name: ccapi-ippool-cidr-mask
      projectName: default
      tags:
        - key: k1
          value: v1

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_vpc_ippool" "example" {
  isp          = "BGP"
  cidr_mask    = 28
  description  = "ccapi ip pool with cidr mask"
  name         = "ccapi-ippool-cidr-mask"
  project_name = "default"
  tags {
    key   = "k1"
    value = "v1"
  }
}

    Create IpPool Resource

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

    Constructor syntax

    new IpPool(name: string, args: IpPoolArgs, opts?: CustomResourceOptions);
    @overload
def IpPool(resource_name: str,
           args: IpPoolArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def IpPool(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           isp: Optional[str] = None,
           cidr_block: Optional[str] = None,
           cidr_mask: Optional[int] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           project_name: Optional[str] = None,
           tags: Optional[Sequence[IpPoolTagArgs]] = None)
    func NewIpPool(ctx *Context, name string, args IpPoolArgs, opts ...ResourceOption) (*IpPool, error)
    public IpPool(string name, IpPoolArgs args, CustomResourceOptions? opts = null)
    public IpPool(String name, IpPoolArgs args)
public IpPool(String name, IpPoolArgs args, CustomResourceOptions options)

    type: volcenginecc:vpc:IpPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_vpc_ip_pool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IpPoolArgs
    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 IpPoolArgs
    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 IpPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpPoolArgs
    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 ipPoolResource = new Volcenginecc.Vpc.IpPool("ipPoolResource", new()
{
    Isp = "string",
    CidrBlock = "string",
    CidrMask = 0,
    Description = "string",
    Name = "string",
    ProjectName = "string",
    Tags = new[]
    {
        new Volcenginecc.Vpc.Inputs.IpPoolTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := vpc.NewIpPool(ctx, "ipPoolResource", &vpc.IpPoolArgs{
	Isp:         pulumi.String("string"),
	CidrBlock:   pulumi.String("string"),
	CidrMask:    pulumi.Int(0),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ProjectName: pulumi.String("string"),
	Tags: vpc.IpPoolTagArray{
		&vpc.IpPoolTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    resource "volcenginecc_vpc_ip_pool" "ipPoolResource" {
  lifecycle {
    create_before_destroy = true
  }
  isp          = "string"
  cidr_block   = "string"
  cidr_mask    = 0
  description  = "string"
  name         = "string"
  project_name = "string"
  tags {
    key   = "string"
    value = "string"
  }
}

    var ipPoolResource = new IpPool("ipPoolResource", IpPoolArgs.builder()
    .isp("string")
    .cidrBlock("string")
    .cidrMask(0)
    .description("string")
    .name("string")
    .projectName("string")
    .tags(IpPoolTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    ip_pool_resource = volcenginecc.vpc.IpPool("ipPoolResource",
    isp="string",
    cidr_block="string",
    cidr_mask=0,
    description="string",
    name="string",
    project_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const ipPoolResource = new volcenginecc.vpc.IpPool("ipPoolResource", {
    isp: "string",
    cidrBlock: "string",
    cidrMask: 0,
    description: "string",
    name: "string",
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcenginecc:vpc:IpPool
properties:
    cidrBlock: string
    cidrMask: 0
    description: string
    isp: string
    name: string
    projectName: string
    tags:
        - key: string
          value: string

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

    Isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    Description string
    Description of the IP address pool.
    Name string
    Name of the IP address pool.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    Tags List<Volcengine.IpPoolTag>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    Description string
    Description of the IP address pool.
    Name string
    Name of the IP address pool.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    Tags []IpPoolTagArgs
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    cidr_block string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_mask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    description string
    Description of the IP address pool.
    name string
    Name of the IP address pool.
    project_name string
    Name of the project to which the IP address pool belongs.
    tags list(object)
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    isp String
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrMask Integer
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    description String
    Description of the IP address pool.
    name String
    Name of the IP address pool.
    projectName String
    Name of the project to which the IP address pool belongs.
    tags List<IpPoolTag>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    cidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrMask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    description string
    Description of the IP address pool.
    name string
    Name of the IP address pool.
    projectName string
    Name of the project to which the IP address pool belongs.
    tags IpPoolTag[]
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    isp str
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    cidr_block str
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_mask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    description str
    Description of the IP address pool.
    name str
    Name of the IP address pool.
    project_name str
    Name of the project to which the IP address pool belongs.
    tags Sequence[IpPoolTagArgs]
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    isp String
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrMask Number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    description String
    Description of the IP address pool.
    name String
    Name of the IP address pool.
    projectName String
    Name of the project to which the IP address pool belongs.
    tags List<Property Map>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    Outputs

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

    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlocks List<string>
    IP range information in the IP address pool.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressPoolId string
    ID of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlocks []string
    IP range information in the IP address pool.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddressPoolId string
    ID of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source string
    Address source.
    business_status string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_blocks list(string)
    IP range information in the IP address pool.
    creation_time string
    Creation time of the IP address pool.
    deleted_time string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    id string
    The provider-assigned unique ID for this managed resource.
    ip_address_pool_id string
    ID of the IP address pool.
    overdue_time string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    specific_egress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    total_ip_count number
    Total number of IP addresses contained in the IP address pool.
    update_time string
    Update time of the IP address pool.
    used_ip_count number
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressPoolId String
    ID of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    totalIpCount Integer
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Integer
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource string
    Address source.
    businessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlocks string[]
    IP range information in the IP address pool.
    creationTime string
    Creation time of the IP address pool.
    deletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddressPoolId string
    ID of the IP address pool.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    specificEgress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    totalIpCount number
    Total number of IP addresses contained in the IP address pool.
    updateTime string
    Update time of the IP address pool.
    usedIpCount number
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source str
    Address source.
    business_status str
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_blocks Sequence[str]
    IP range information in the IP address pool.
    creation_time str
    Creation time of the IP address pool.
    deleted_time str
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address_pool_id str
    ID of the IP address pool.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    specific_egress str
    Specific egress.
    status str
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    total_ip_count int
    Total number of IP addresses contained in the IP address pool.
    update_time str
    Update time of the IP address pool.
    used_ip_count int
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddressPoolId String
    ID of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    totalIpCount Number
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Number
    Number of IP addresses allocated as EIP in the IP address pool.

    Look up Existing IpPool Resource

    Get an existing IpPool 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?: IpPoolState, opts?: CustomResourceOptions): IpPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_source: Optional[str] = None,
        business_status: Optional[str] = None,
        cidr_block: Optional[str] = None,
        cidr_blocks: Optional[Sequence[str]] = None,
        cidr_mask: Optional[int] = None,
        creation_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        ip_address_pool_id: Optional[str] = None,
        isp: Optional[str] = None,
        name: Optional[str] = None,
        overdue_time: Optional[str] = None,
        project_name: Optional[str] = None,
        specific_egress: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[IpPoolTagArgs]] = None,
        total_ip_count: Optional[int] = None,
        update_time: Optional[str] = None,
        used_ip_count: Optional[int] = None) -> IpPool
    func GetIpPool(ctx *Context, name string, id IDInput, state *IpPoolState, opts ...ResourceOption) (*IpPool, error)
    public static IpPool Get(string name, Input<string> id, IpPoolState? state, CustomResourceOptions? opts = null)
    public static IpPool get(String name, Output<String> id, IpPoolState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:vpc:IpPool    get:      id: ${id}
    import {
  to = volcenginecc_vpc_ip_pool.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:
    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrBlocks List<string>
    IP range information in the IP address pool.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Description string
    Description of the IP address pool.
    IpAddressPoolId string
    ID of the IP address pool.
    Isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    Name string
    Name of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    Tags List<Volcengine.IpPoolTag>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrBlocks []string
    IP range information in the IP address pool.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Description string
    Description of the IP address pool.
    IpAddressPoolId string
    ID of the IP address pool.
    Isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    Name string
    Name of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    Tags []IpPoolTagArgs
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source string
    Address source.
    business_status string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_block string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_blocks list(string)
    IP range information in the IP address pool.
    cidr_mask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creation_time string
    Creation time of the IP address pool.
    deleted_time string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description string
    Description of the IP address pool.
    ip_address_pool_id string
    ID of the IP address pool.
    isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name string
    Name of the IP address pool.
    overdue_time string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    project_name string
    Name of the project to which the IP address pool belongs.
    specific_egress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags list(object)
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    total_ip_count number
    Total number of IP addresses contained in the IP address pool.
    update_time string
    Update time of the IP address pool.
    used_ip_count number
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    cidrMask Integer
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description String
    Description of the IP address pool.
    ipAddressPoolId String
    ID of the IP address pool.
    isp String
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name String
    Name of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName String
    Name of the project to which the IP address pool belongs.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags List<IpPoolTag>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalIpCount Integer
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Integer
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource string
    Address source.
    businessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks string[]
    IP range information in the IP address pool.
    cidrMask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime string
    Creation time of the IP address pool.
    deletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description string
    Description of the IP address pool.
    ipAddressPoolId string
    ID of the IP address pool.
    isp string
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name string
    Name of the IP address pool.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName string
    Name of the project to which the IP address pool belongs.
    specificEgress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags IpPoolTag[]
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalIpCount number
    Total number of IP addresses contained in the IP address pool.
    updateTime string
    Update time of the IP address pool.
    usedIpCount number
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source str
    Address source.
    business_status str
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_block str
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_blocks Sequence[str]
    IP range information in the IP address pool.
    cidr_mask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creation_time str
    Creation time of the IP address pool.
    deleted_time str
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description str
    Description of the IP address pool.
    ip_address_pool_id str
    ID of the IP address pool.
    isp str
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name str
    Name of the IP address pool.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    project_name str
    Name of the project to which the IP address pool belongs.
    specific_egress str
    Specific egress.
    status str
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags Sequence[IpPoolTagArgs]
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    total_ip_count int
    Total number of IP addresses contained in the IP address pool.
    update_time str
    Update time of the IP address pool.
    used_ip_count int
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    cidrMask Number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description String
    Description of the IP address pool.
    ipAddressPoolId String
    ID of the IP address pool.
    isp String
    Line type. Valid values: BGP (multi-line), ChinaMobile (China Mobile static single line), ChinaTelecom (China Telecom static single line), ChinaUnicom (China Unicom static single line), SingleLineBGP (BGP single line), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name String
    Name of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName String
    Name of the project to which the IP address pool belongs.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags List<Property Map>
    Tag information of the IP address pool. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalIpCount Number
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Number
    Number of IP addresses allocated as EIP in the IP address pool.

    Supporting Types

    IpPoolTag, IpPoolTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:vpc/ipPool:IpPool example "ip_address_pool_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.57
    published on Monday, Aug 24, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial