1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getIpamPool
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine

    Data Source schema for Volcengine::VPC::IpamPool

    Using getIpamPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpamPool(args: GetIpamPoolArgs, opts?: InvokeOptions): Promise<GetIpamPoolResult>
    function getIpamPoolOutput(args: GetIpamPoolOutputArgs, opts?: InvokeOutputOptions): Output<GetIpamPoolResult>
    def get_ipam_pool(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIpamPoolResult
    def get_ipam_pool_output(id: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetIpamPoolResult]
    func LookupIpamPool(ctx *Context, args *LookupIpamPoolArgs, opts ...InvokeOption) (*LookupIpamPoolResult, error)
    func LookupIpamPoolOutput(ctx *Context, args *LookupIpamPoolOutputArgs, opts ...InvokeOption) LookupIpamPoolResultOutput

    > Note: This function is named LookupIpamPool in the Go SDK.

    public static class GetIpamPool 
    {
        public static Task<GetIpamPoolResult> InvokeAsync(GetIpamPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetIpamPoolResult> Invoke(GetIpamPoolInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetIpamPoolResult> Invoke(GetIpamPoolInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
    public static Output<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
    public static Output<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: volcenginecc:vpc/getIpamPool:getIpamPool
      arguments:
        # arguments dictionary
    data "volcenginecc_vpc_get_ipam_pool" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getIpamPool Result

    The following output properties are available:

    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
    Id string
    Uniquely identifies the resource.
    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.GetIpamPoolTag>
    IPAM address pool tags
    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
    Id string
    Uniquely identifies the resource.
    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 []GetIpamPoolTag
    IPAM address pool tags
    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
    id string
    Uniquely identifies the resource.
    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
    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
    id String
    Uniquely identifies the resource.
    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<GetIpamPoolTag>
    IPAM address pool tags
    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
    id string
    Uniquely identifies the resource.
    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 GetIpamPoolTag[]
    IPAM address pool tags
    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
    id str
    Uniquely identifies the resource.
    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[GetIpamPoolTag]
    IPAM address pool tags
    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
    id String
    Uniquely identifies the resource.
    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
    updateTime String
    IPAM address pool update time

    Supporting Types

    GetIpamPoolTag

    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

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial