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

volcenginecc.vpc.IpamPool

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

    IPAM address pool

    Example Usage

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

const example = new volcenginecc.vpc.IpamPool("example", {
    ipamScopeId: "ipam-scope-xxxxxx",
    ipVersion: "IPv4",
    poolRegionId: "cn-beijing",
    projectName: "default",
    ipamPoolName: "tf-ipam-pool-full",
    description: "created by terraform full case",
    autoImport: true,
    allocationDefaultCidrMask: 24,
    allocationMinCidrMask: 16,
    allocationMaxCidrMask: 28,
    tags: [
        {
            key: "case",
            value: "tf-c02",
        },
        {
            key: "env",
            value: "terraform",
        },
    ],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.vpc.IpamPool("example",
    ipam_scope_id="ipam-scope-xxxxxx",
    ip_version="IPv4",
    pool_region_id="cn-beijing",
    project_name="default",
    ipam_pool_name="tf-ipam-pool-full",
    description="created by terraform full case",
    auto_import=True,
    allocation_default_cidr_mask=24,
    allocation_min_cidr_mask=16,
    allocation_max_cidr_mask=28,
    tags=[
        {
            "key": "case",
            "value": "tf-c02",
        },
        {
            "key": "env",
            "value": "terraform",
        },
    ])

    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.NewIpamPool(ctx, "example", &vpc.IpamPoolArgs{
			IpamScopeId:               pulumi.String("ipam-scope-xxxxxx"),
			IpVersion:                 pulumi.String("IPv4"),
			PoolRegionId:              pulumi.String("cn-beijing"),
			ProjectName:               pulumi.String("default"),
			IpamPoolName:              pulumi.String("tf-ipam-pool-full"),
			Description:               pulumi.String("created by terraform full case"),
			AutoImport:                pulumi.Bool(true),
			AllocationDefaultCidrMask: pulumi.Int(24),
			AllocationMinCidrMask:     pulumi.Int(16),
			AllocationMaxCidrMask:     pulumi.Int(28),
			Tags: vpc.IpamPoolTagArray{
				&vpc.IpamPoolTagArgs{
					Key:   pulumi.String("case"),
					Value: pulumi.String("tf-c02"),
				},
				&vpc.IpamPoolTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("terraform"),
				},
			},
		})
		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.IpamPool("example", new()
    {
        IpamScopeId = "ipam-scope-xxxxxx",
        IpVersion = "IPv4",
        PoolRegionId = "cn-beijing",
        ProjectName = "default",
        IpamPoolName = "tf-ipam-pool-full",
        Description = "created by terraform full case",
        AutoImport = true,
        AllocationDefaultCidrMask = 24,
        AllocationMinCidrMask = 16,
        AllocationMaxCidrMask = 28,
        Tags = new[]
        {
            new Volcenginecc.Vpc.Inputs.IpamPoolTagArgs
            {
                Key = "case",
                Value = "tf-c02",
            },
            new Volcenginecc.Vpc.Inputs.IpamPoolTagArgs
            {
                Key = "env",
                Value = "terraform",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vpc.IpamPool;
import com.volcengine.volcenginecc.vpc.IpamPoolArgs;
import com.pulumi.volcenginecc.vpc.inputs.IpamPoolTagArgs;
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 IpamPool("example", IpamPoolArgs.builder()
            .ipamScopeId("ipam-scope-xxxxxx")
            .ipVersion("IPv4")
            .poolRegionId("cn-beijing")
            .projectName("default")
            .ipamPoolName("tf-ipam-pool-full")
            .description("created by terraform full case")
            .autoImport(true)
            .allocationDefaultCidrMask(24)
            .allocationMinCidrMask(16)
            .allocationMaxCidrMask(28)
            .tags(            
                IpamPoolTagArgs.builder()
                    .key("case")
                    .value("tf-c02")
                    .build(),
                IpamPoolTagArgs.builder()
                    .key("env")
                    .value("terraform")
                    .build())
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:vpc:IpamPool
    properties:
      ipamScopeId: ipam-scope-xxxxxx
      ipVersion: IPv4
      poolRegionId: cn-beijing
      projectName: default
      ipamPoolName: tf-ipam-pool-full
      description: created by terraform full case
      autoImport: true
      allocationDefaultCidrMask: 24
      allocationMinCidrMask: 16
      allocationMaxCidrMask: 28
      tags:
        - key: case
          value: tf-c02
        - key: env
          value: terraform

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

resource "volcenginecc_vpc_ipampool" "example" {
  ipam_scope_id                = "ipam-scope-xxxxxx"
  ip_version                   = "IPv4"
  pool_region_id               = "cn-beijing"
  project_name                 = "default"
  ipam_pool_name               = "tf-ipam-pool-full"
  description                  = "created by terraform full case"
  auto_import                  = true
  allocation_default_cidr_mask = 24
  allocation_min_cidr_mask     = 16
  allocation_max_cidr_mask     = 28
  tags {
    key   = "case"
    value = "tf-c02"
  }
  tags {
    key   = "env"
    value = "terraform"
  }
}

    Create IpamPool Resource

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

    Constructor syntax

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

@overload
def IpamPool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ip_version: Optional[str] = None,
             ipam_scope_id: Optional[str] = None,
             auto_import: Optional[bool] = None,
             allocation_default_cidr_mask: Optional[int] = None,
             clear_allocation_default_cidr_mask: Optional[bool] = None,
             description: Optional[str] = None,
             allocation_min_cidr_mask: Optional[int] = None,
             ipam_pool_name: Optional[str] = None,
             allocation_max_cidr_mask: Optional[int] = None,
             pool_region_id: Optional[str] = None,
             project_name: Optional[str] = None,
             source_ipam_pool_id: Optional[str] = None,
             tags: Optional[Sequence[IpamPoolTagArgs]] = None)
    func NewIpamPool(ctx *Context, name string, args IpamPoolArgs, opts ...ResourceOption) (*IpamPool, error)
    public IpamPool(string name, IpamPoolArgs args, CustomResourceOptions? opts = null)
    public IpamPool(String name, IpamPoolArgs args)
public IpamPool(String name, IpamPoolArgs args, CustomResourceOptions options)

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


    resource "volcenginecc_vpc_ipam_pool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IpamPoolArgs
    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 IpamPoolArgs
    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 IpamPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpamPoolArgs
    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 ipamPoolResource = new Volcenginecc.Vpc.IpamPool("ipamPoolResource", new()
{
    IpVersion = "string",
    IpamScopeId = "string",
    AutoImport = false,
    AllocationDefaultCidrMask = 0,
    ClearAllocationDefaultCidrMask = false,
    Description = "string",
    AllocationMinCidrMask = 0,
    IpamPoolName = "string",
    AllocationMaxCidrMask = 0,
    PoolRegionId = "string",
    ProjectName = "string",
    SourceIpamPoolId = "string",
    Tags = new[]
    {
        new Volcenginecc.Vpc.Inputs.IpamPoolTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := vpc.NewIpamPool(ctx, "ipamPoolResource", &vpc.IpamPoolArgs{
	IpVersion:                      pulumi.String("string"),
	IpamScopeId:                    pulumi.String("string"),
	AutoImport:                     pulumi.Bool(false),
	AllocationDefaultCidrMask:      pulumi.Int(0),
	ClearAllocationDefaultCidrMask: pulumi.Bool(false),
	Description:                    pulumi.String("string"),
	AllocationMinCidrMask:          pulumi.Int(0),
	IpamPoolName:                   pulumi.String("string"),
	AllocationMaxCidrMask:          pulumi.Int(0),
	PoolRegionId:                   pulumi.String("string"),
	ProjectName:                    pulumi.String("string"),
	SourceIpamPoolId:               pulumi.String("string"),
	Tags: vpc.IpamPoolTagArray{
		&vpc.IpamPoolTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    resource "volcenginecc_vpc_ipam_pool" "ipamPoolResource" {
  lifecycle {
    create_before_destroy = true
  }
  ip_version                         = "string"
  ipam_scope_id                      = "string"
  auto_import                        = false
  allocation_default_cidr_mask       = 0
  clear_allocation_default_cidr_mask = false
  description                        = "string"
  allocation_min_cidr_mask           = 0
  ipam_pool_name                     = "string"
  allocation_max_cidr_mask           = 0
  pool_region_id                     = "string"
  project_name                       = "string"
  source_ipam_pool_id                = "string"
  tags {
    key   = "string"
    value = "string"
  }
}

    var ipamPoolResource = new IpamPool("ipamPoolResource", IpamPoolArgs.builder()
    .ipVersion("string")
    .ipamScopeId("string")
    .autoImport(false)
    .allocationDefaultCidrMask(0)
    .clearAllocationDefaultCidrMask(false)
    .description("string")
    .allocationMinCidrMask(0)
    .ipamPoolName("string")
    .allocationMaxCidrMask(0)
    .poolRegionId("string")
    .projectName("string")
    .sourceIpamPoolId("string")
    .tags(IpamPoolTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    ipam_pool_resource = volcenginecc.vpc.IpamPool("ipamPoolResource",
    ip_version="string",
    ipam_scope_id="string",
    auto_import=False,
    allocation_default_cidr_mask=0,
    clear_allocation_default_cidr_mask=False,
    description="string",
    allocation_min_cidr_mask=0,
    ipam_pool_name="string",
    allocation_max_cidr_mask=0,
    pool_region_id="string",
    project_name="string",
    source_ipam_pool_id="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const ipamPoolResource = new volcenginecc.vpc.IpamPool("ipamPoolResource", {
    ipVersion: "string",
    ipamScopeId: "string",
    autoImport: false,
    allocationDefaultCidrMask: 0,
    clearAllocationDefaultCidrMask: false,
    description: "string",
    allocationMinCidrMask: 0,
    ipamPoolName: "string",
    allocationMaxCidrMask: 0,
    poolRegionId: "string",
    projectName: "string",
    sourceIpamPoolId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcenginecc:vpc:IpamPool
properties:
    allocationDefaultCidrMask: 0
    allocationMaxCidrMask: 0
    allocationMinCidrMask: 0
    autoImport: false
    clearAllocationDefaultCidrMask: false
    description: string
    ipVersion: string
    ipamPoolName: string
    ipamScopeId: string
    poolRegionId: string
    projectName: string
    sourceIpamPoolId: string
    tags:
        - key: string
          value: string

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

    IpVersion string
    Address pool IP version
    IpamScopeId string
    IPAM scope ID
    AllocationDefaultCidrMask int
    Default mask length when allocating CIDR
    AllocationMaxCidrMask int
    Maximum allocation mask bits
    AllocationMinCidrMask int
    Minimum allocation mask bits
    AutoImport bool
    Whether to automatically import resources
    ClearAllocationDefaultCidrMask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    Description string
    IPAM address pool description
    IpamPoolName string
    IPAM address pool name
    PoolRegionId string
    Address pool region ID
    ProjectName string
    IPAM address pool project name
    SourceIpamPoolId string
    Parent address pool ID
    Tags List<Volcengine.IpamPoolTag>
    IPAM address pool tags 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.
    IpVersion string
    Address pool IP version
    IpamScopeId string
    IPAM scope ID
    AllocationDefaultCidrMask int
    Default mask length when allocating CIDR
    AllocationMaxCidrMask int
    Maximum allocation mask bits
    AllocationMinCidrMask int
    Minimum allocation mask bits
    AutoImport bool
    Whether to automatically import resources
    ClearAllocationDefaultCidrMask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    Description string
    IPAM address pool description
    IpamPoolName string
    IPAM address pool name
    PoolRegionId string
    Address pool region ID
    ProjectName string
    IPAM address pool project name
    SourceIpamPoolId string
    Parent address pool ID
    Tags []IpamPoolTagArgs
    IPAM address pool tags 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.
    ip_version string
    Address pool IP version
    ipam_scope_id string
    IPAM scope ID
    allocation_default_cidr_mask number
    Default mask length when allocating CIDR
    allocation_max_cidr_mask number
    Maximum allocation mask bits
    allocation_min_cidr_mask number
    Minimum allocation mask bits
    auto_import bool
    Whether to automatically import resources
    clear_allocation_default_cidr_mask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    description string
    IPAM address pool description
    ipam_pool_name string
    IPAM address pool name
    pool_region_id string
    Address pool region ID
    project_name string
    IPAM address pool project name
    source_ipam_pool_id string
    Parent address pool ID
    tags list(object)
    IPAM address pool tags 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.
    ipVersion String
    Address pool IP version
    ipamScopeId String
    IPAM scope ID
    allocationDefaultCidrMask Integer
    Default mask length when allocating CIDR
    allocationMaxCidrMask Integer
    Maximum allocation mask bits
    allocationMinCidrMask Integer
    Minimum allocation mask bits
    autoImport Boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask Boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    description String
    IPAM address pool description
    ipamPoolName String
    IPAM address pool name
    poolRegionId String
    Address pool region ID
    projectName String
    IPAM address pool project name
    sourceIpamPoolId String
    Parent address pool ID
    tags List<IpamPoolTag>
    IPAM address pool tags 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.
    ipVersion string
    Address pool IP version
    ipamScopeId string
    IPAM scope ID
    allocationDefaultCidrMask number
    Default mask length when allocating CIDR
    allocationMaxCidrMask number
    Maximum allocation mask bits
    allocationMinCidrMask number
    Minimum allocation mask bits
    autoImport boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    description string
    IPAM address pool description
    ipamPoolName string
    IPAM address pool name
    poolRegionId string
    Address pool region ID
    projectName string
    IPAM address pool project name
    sourceIpamPoolId string
    Parent address pool ID
    tags IpamPoolTag[]
    IPAM address pool tags 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.
    ip_version str
    Address pool IP version
    ipam_scope_id str
    IPAM scope ID
    allocation_default_cidr_mask int
    Default mask length when allocating CIDR
    allocation_max_cidr_mask int
    Maximum allocation mask bits
    allocation_min_cidr_mask int
    Minimum allocation mask bits
    auto_import bool
    Whether to automatically import resources
    clear_allocation_default_cidr_mask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    description str
    IPAM address pool description
    ipam_pool_name str
    IPAM address pool name
    pool_region_id str
    Address pool region ID
    project_name str
    IPAM address pool project name
    source_ipam_pool_id str
    Parent address pool ID
    tags Sequence[IpamPoolTagArgs]
    IPAM address pool tags 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.
    ipVersion String
    Address pool IP version
    ipamScopeId String
    IPAM scope ID
    allocationDefaultCidrMask Number
    Default mask length when allocating CIDR
    allocationMaxCidrMask Number
    Maximum allocation mask bits
    allocationMinCidrMask Number
    Minimum allocation mask bits
    autoImport Boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask Boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    description String
    IPAM address pool description
    ipamPoolName String
    IPAM address pool name
    poolRegionId String
    Address pool region ID
    projectName String
    IPAM address pool project name
    sourceIpamPoolId String
    Parent address pool ID
    tags List<Property Map>
    IPAM address pool tags 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 IpamPool resource produces the following output properties:

    AccountId string
    Account ID
    CreateTime string
    IPAM address pool creation time
    HasSubPool bool
    Whether there are child address pools
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamId string
    IPAM ID。
    IpamPoolId string
    IPAM address pool ID
    IpamRegionId string
    IPAM region ID
    IpamScopeType string
    IPAM scope type
    PoolDepth int
    Address pool depth
    Status string
    IPAM address pool status
    UpdateTime string
    IPAM address pool update time
    AccountId string
    Account ID
    CreateTime string
    IPAM address pool creation time
    HasSubPool bool
    Whether there are child address pools
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamId string
    IPAM ID。
    IpamPoolId string
    IPAM address pool ID
    IpamRegionId string
    IPAM region ID
    IpamScopeType string
    IPAM scope type
    PoolDepth int
    Address pool depth
    Status string
    IPAM address pool status
    UpdateTime string
    IPAM address pool update time
    account_id string
    Account ID
    create_time string
    IPAM address pool creation time
    has_sub_pool bool
    Whether there are child address pools
    id string
    The provider-assigned unique ID for this managed resource.
    ipam_id string
    IPAM ID。
    ipam_pool_id string
    IPAM address pool ID
    ipam_region_id string
    IPAM region ID
    ipam_scope_type string
    IPAM scope type
    pool_depth number
    Address pool depth
    status string
    IPAM address pool status
    update_time string
    IPAM address pool update time
    accountId String
    Account ID
    createTime String
    IPAM address pool creation time
    hasSubPool Boolean
    Whether there are child address pools
    id String
    The provider-assigned unique ID for this managed resource.
    ipamId String
    IPAM ID。
    ipamPoolId String
    IPAM address pool ID
    ipamRegionId String
    IPAM region ID
    ipamScopeType String
    IPAM scope type
    poolDepth Integer
    Address pool depth
    status String
    IPAM address pool status
    updateTime String
    IPAM address pool update time
    accountId string
    Account ID
    createTime string
    IPAM address pool creation time
    hasSubPool boolean
    Whether there are child address pools
    id string
    The provider-assigned unique ID for this managed resource.
    ipamId string
    IPAM ID。
    ipamPoolId string
    IPAM address pool ID
    ipamRegionId string
    IPAM region ID
    ipamScopeType string
    IPAM scope type
    poolDepth number
    Address pool depth
    status string
    IPAM address pool status
    updateTime string
    IPAM address pool update time
    account_id str
    Account ID
    create_time str
    IPAM address pool creation time
    has_sub_pool bool
    Whether there are child address pools
    id str
    The provider-assigned unique ID for this managed resource.
    ipam_id str
    IPAM ID。
    ipam_pool_id str
    IPAM address pool ID
    ipam_region_id str
    IPAM region ID
    ipam_scope_type str
    IPAM scope type
    pool_depth int
    Address pool depth
    status str
    IPAM address pool status
    update_time str
    IPAM address pool update time
    accountId String
    Account ID
    createTime String
    IPAM address pool creation time
    hasSubPool Boolean
    Whether there are child address pools
    id String
    The provider-assigned unique ID for this managed resource.
    ipamId String
    IPAM ID。
    ipamPoolId String
    IPAM address pool ID
    ipamRegionId String
    IPAM region ID
    ipamScopeType String
    IPAM scope type
    poolDepth Number
    Address pool depth
    status String
    IPAM address pool status
    updateTime String
    IPAM address pool update time

    Look up Existing IpamPool Resource

    Get an existing IpamPool 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?: IpamPoolState, opts?: CustomResourceOptions): IpamPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allocation_default_cidr_mask: Optional[int] = None,
        allocation_max_cidr_mask: Optional[int] = None,
        allocation_min_cidr_mask: Optional[int] = None,
        auto_import: Optional[bool] = None,
        clear_allocation_default_cidr_mask: Optional[bool] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        has_sub_pool: Optional[bool] = None,
        ip_version: Optional[str] = None,
        ipam_id: Optional[str] = None,
        ipam_pool_id: Optional[str] = None,
        ipam_pool_name: Optional[str] = None,
        ipam_region_id: Optional[str] = None,
        ipam_scope_id: Optional[str] = None,
        ipam_scope_type: Optional[str] = None,
        pool_depth: Optional[int] = None,
        pool_region_id: Optional[str] = None,
        project_name: Optional[str] = None,
        source_ipam_pool_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[IpamPoolTagArgs]] = None,
        update_time: Optional[str] = None) -> IpamPool
    func GetIpamPool(ctx *Context, name string, id IDInput, state *IpamPoolState, opts ...ResourceOption) (*IpamPool, error)
    public static IpamPool Get(string name, Input<string> id, IpamPoolState? state, CustomResourceOptions? opts = null)
    public static IpamPool get(String name, Output<String> id, IpamPoolState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:vpc:IpamPool    get:      id: ${id}
    import {
  to = volcenginecc_vpc_ipam_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:
    AccountId string
    Account ID
    AllocationDefaultCidrMask int
    Default mask length when allocating CIDR
    AllocationMaxCidrMask int
    Maximum allocation mask bits
    AllocationMinCidrMask int
    Minimum allocation mask bits
    AutoImport bool
    Whether to automatically import resources
    ClearAllocationDefaultCidrMask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    CreateTime string
    IPAM address pool creation time
    Description string
    IPAM address pool description
    HasSubPool bool
    Whether there are child address pools
    IpVersion string
    Address pool IP version
    IpamId string
    IPAM ID。
    IpamPoolId string
    IPAM address pool ID
    IpamPoolName string
    IPAM address pool name
    IpamRegionId string
    IPAM region ID
    IpamScopeId string
    IPAM scope ID
    IpamScopeType string
    IPAM scope type
    PoolDepth int
    Address pool depth
    PoolRegionId string
    Address pool region ID
    ProjectName string
    IPAM address pool project name
    SourceIpamPoolId string
    Parent address pool ID
    Status string
    IPAM address pool status
    Tags List<Volcengine.IpamPoolTag>
    IPAM address pool tags 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.
    UpdateTime string
    IPAM address pool update time
    AccountId string
    Account ID
    AllocationDefaultCidrMask int
    Default mask length when allocating CIDR
    AllocationMaxCidrMask int
    Maximum allocation mask bits
    AllocationMinCidrMask int
    Minimum allocation mask bits
    AutoImport bool
    Whether to automatically import resources
    ClearAllocationDefaultCidrMask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    CreateTime string
    IPAM address pool creation time
    Description string
    IPAM address pool description
    HasSubPool bool
    Whether there are child address pools
    IpVersion string
    Address pool IP version
    IpamId string
    IPAM ID。
    IpamPoolId string
    IPAM address pool ID
    IpamPoolName string
    IPAM address pool name
    IpamRegionId string
    IPAM region ID
    IpamScopeId string
    IPAM scope ID
    IpamScopeType string
    IPAM scope type
    PoolDepth int
    Address pool depth
    PoolRegionId string
    Address pool region ID
    ProjectName string
    IPAM address pool project name
    SourceIpamPoolId string
    Parent address pool ID
    Status string
    IPAM address pool status
    Tags []IpamPoolTagArgs
    IPAM address pool tags 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.
    UpdateTime string
    IPAM address pool update time
    account_id string
    Account ID
    allocation_default_cidr_mask number
    Default mask length when allocating CIDR
    allocation_max_cidr_mask number
    Maximum allocation mask bits
    allocation_min_cidr_mask number
    Minimum allocation mask bits
    auto_import bool
    Whether to automatically import resources
    clear_allocation_default_cidr_mask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    create_time string
    IPAM address pool creation time
    description string
    IPAM address pool description
    has_sub_pool bool
    Whether there are child address pools
    ip_version string
    Address pool IP version
    ipam_id string
    IPAM ID。
    ipam_pool_id string
    IPAM address pool ID
    ipam_pool_name string
    IPAM address pool name
    ipam_region_id string
    IPAM region ID
    ipam_scope_id string
    IPAM scope ID
    ipam_scope_type string
    IPAM scope type
    pool_depth number
    Address pool depth
    pool_region_id string
    Address pool region ID
    project_name string
    IPAM address pool project name
    source_ipam_pool_id string
    Parent address pool ID
    status string
    IPAM address pool status
    tags list(object)
    IPAM address pool tags 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.
    update_time string
    IPAM address pool update time
    accountId String
    Account ID
    allocationDefaultCidrMask Integer
    Default mask length when allocating CIDR
    allocationMaxCidrMask Integer
    Maximum allocation mask bits
    allocationMinCidrMask Integer
    Minimum allocation mask bits
    autoImport Boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask Boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    createTime String
    IPAM address pool creation time
    description String
    IPAM address pool description
    hasSubPool Boolean
    Whether there are child address pools
    ipVersion String
    Address pool IP version
    ipamId String
    IPAM ID。
    ipamPoolId String
    IPAM address pool ID
    ipamPoolName String
    IPAM address pool name
    ipamRegionId String
    IPAM region ID
    ipamScopeId String
    IPAM scope ID
    ipamScopeType String
    IPAM scope type
    poolDepth Integer
    Address pool depth
    poolRegionId String
    Address pool region ID
    projectName String
    IPAM address pool project name
    sourceIpamPoolId String
    Parent address pool ID
    status String
    IPAM address pool status
    tags List<IpamPoolTag>
    IPAM address pool tags 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.
    updateTime String
    IPAM address pool update time
    accountId string
    Account ID
    allocationDefaultCidrMask number
    Default mask length when allocating CIDR
    allocationMaxCidrMask number
    Maximum allocation mask bits
    allocationMinCidrMask number
    Minimum allocation mask bits
    autoImport boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    createTime string
    IPAM address pool creation time
    description string
    IPAM address pool description
    hasSubPool boolean
    Whether there are child address pools
    ipVersion string
    Address pool IP version
    ipamId string
    IPAM ID。
    ipamPoolId string
    IPAM address pool ID
    ipamPoolName string
    IPAM address pool name
    ipamRegionId string
    IPAM region ID
    ipamScopeId string
    IPAM scope ID
    ipamScopeType string
    IPAM scope type
    poolDepth number
    Address pool depth
    poolRegionId string
    Address pool region ID
    projectName string
    IPAM address pool project name
    sourceIpamPoolId string
    Parent address pool ID
    status string
    IPAM address pool status
    tags IpamPoolTag[]
    IPAM address pool tags 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.
    updateTime string
    IPAM address pool update time
    account_id str
    Account ID
    allocation_default_cidr_mask int
    Default mask length when allocating CIDR
    allocation_max_cidr_mask int
    Maximum allocation mask bits
    allocation_min_cidr_mask int
    Minimum allocation mask bits
    auto_import bool
    Whether to automatically import resources
    clear_allocation_default_cidr_mask bool
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    create_time str
    IPAM address pool creation time
    description str
    IPAM address pool description
    has_sub_pool bool
    Whether there are child address pools
    ip_version str
    Address pool IP version
    ipam_id str
    IPAM ID。
    ipam_pool_id str
    IPAM address pool ID
    ipam_pool_name str
    IPAM address pool name
    ipam_region_id str
    IPAM region ID
    ipam_scope_id str
    IPAM scope ID
    ipam_scope_type str
    IPAM scope type
    pool_depth int
    Address pool depth
    pool_region_id str
    Address pool region ID
    project_name str
    IPAM address pool project name
    source_ipam_pool_id str
    Parent address pool ID
    status str
    IPAM address pool status
    tags Sequence[IpamPoolTagArgs]
    IPAM address pool tags 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.
    update_time str
    IPAM address pool update time
    accountId String
    Account ID
    allocationDefaultCidrMask Number
    Default mask length when allocating CIDR
    allocationMaxCidrMask Number
    Maximum allocation mask bits
    allocationMinCidrMask Number
    Minimum allocation mask bits
    autoImport Boolean
    Whether to automatically import resources
    clearAllocationDefaultCidrMask Boolean
    Whether to clear the default network mask of the IPAM address pool. ClearAllocationDefaultCidrMask and AllocationDefaultCidrMask cannot be used together
    createTime String
    IPAM address pool creation time
    description String
    IPAM address pool description
    hasSubPool Boolean
    Whether there are child address pools
    ipVersion String
    Address pool IP version
    ipamId String
    IPAM ID。
    ipamPoolId String
    IPAM address pool ID
    ipamPoolName String
    IPAM address pool name
    ipamRegionId String
    IPAM region ID
    ipamScopeId String
    IPAM scope ID
    ipamScopeType String
    IPAM scope type
    poolDepth Number
    Address pool depth
    poolRegionId String
    Address pool region ID
    projectName String
    IPAM address pool project name
    sourceIpamPoolId String
    Parent address pool ID
    status String
    IPAM address pool status
    tags List<Property Map>
    IPAM address pool tags 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.
    updateTime String
    IPAM address pool update time

    Supporting Types

    IpamPoolTag, IpamPoolTagArgs

    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/ipamPool:IpamPool example "ipam_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