published on Monday, Aug 24, 2026 by Volcengine
published on Monday, Aug 24, 2026 by Volcengine
IPAM Scope
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const example = new volcenginecc.vpc.IpamScope("example", {
ipamId: "ipam-xxxxxx",
ipamScopeName: "tf-ipam-scope-full",
ipamScopeType: "private",
description: "created by terraform full case",
projectName: "default",
tags: [
{
key: "case",
value: "tf-c02",
},
{
key: "env",
value: "terraform",
},
],
});
import pulumi
import pulumi_volcenginecc as volcenginecc
example = volcenginecc.vpc.IpamScope("example",
ipam_id="ipam-xxxxxx",
ipam_scope_name="tf-ipam-scope-full",
ipam_scope_type="private",
description="created by terraform full case",
project_name="default",
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.NewIpamScope(ctx, "example", &vpc.IpamScopeArgs{
IpamId: pulumi.String("ipam-xxxxxx"),
IpamScopeName: pulumi.String("tf-ipam-scope-full"),
IpamScopeType: pulumi.String("private"),
Description: pulumi.String("created by terraform full case"),
ProjectName: pulumi.String("default"),
Tags: vpc.IpamScopeTagArray{
&vpc.IpamScopeTagArgs{
Key: pulumi.String("case"),
Value: pulumi.String("tf-c02"),
},
&vpc.IpamScopeTagArgs{
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.IpamScope("example", new()
{
IpamId = "ipam-xxxxxx",
IpamScopeName = "tf-ipam-scope-full",
IpamScopeType = "private",
Description = "created by terraform full case",
ProjectName = "default",
Tags = new[]
{
new Volcenginecc.Vpc.Inputs.IpamScopeTagArgs
{
Key = "case",
Value = "tf-c02",
},
new Volcenginecc.Vpc.Inputs.IpamScopeTagArgs
{
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.IpamScope;
import com.volcengine.volcenginecc.vpc.IpamScopeArgs;
import com.pulumi.volcenginecc.vpc.inputs.IpamScopeTagArgs;
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 IpamScope("example", IpamScopeArgs.builder()
.ipamId("ipam-xxxxxx")
.ipamScopeName("tf-ipam-scope-full")
.ipamScopeType("private")
.description("created by terraform full case")
.projectName("default")
.tags(
IpamScopeTagArgs.builder()
.key("case")
.value("tf-c02")
.build(),
IpamScopeTagArgs.builder()
.key("env")
.value("terraform")
.build())
.build());
}
}
resources:
example:
type: volcenginecc:vpc:IpamScope
properties:
ipamId: ipam-xxxxxx
ipamScopeName: tf-ipam-scope-full
ipamScopeType: private
description: created by terraform full case
projectName: default
tags:
- key: case
value: tf-c02
- key: env
value: terraform
pulumi {
required_providers {
volcenginecc = {
source = "pulumi/volcenginecc"
}
}
}
resource "volcenginecc_vpc_ipamscope" "example" {
ipam_id = "ipam-xxxxxx"
ipam_scope_name = "tf-ipam-scope-full"
ipam_scope_type = "private"
description = "created by terraform full case"
project_name = "default"
tags {
key = "case"
value = "tf-c02"
}
tags {
key = "env"
value = "terraform"
}
}
Create IpamScope Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpamScope(name: string, args: IpamScopeArgs, opts?: CustomResourceOptions);@overload
def IpamScope(resource_name: str,
args: IpamScopeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IpamScope(resource_name: str,
opts: Optional[ResourceOptions] = None,
ipam_id: Optional[str] = None,
description: Optional[str] = None,
ipam_scope_name: Optional[str] = None,
ipam_scope_type: Optional[str] = None,
project_name: Optional[str] = None,
tags: Optional[Sequence[IpamScopeTagArgs]] = None)func NewIpamScope(ctx *Context, name string, args IpamScopeArgs, opts ...ResourceOption) (*IpamScope, error)public IpamScope(string name, IpamScopeArgs args, CustomResourceOptions? opts = null)
public IpamScope(String name, IpamScopeArgs args)
public IpamScope(String name, IpamScopeArgs args, CustomResourceOptions options)
type: volcenginecc:vpc:IpamScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_vpc_ipam_scope" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IpamScopeArgs
- 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 IpamScopeArgs
- 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 IpamScopeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpamScopeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpamScopeArgs
- 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 ipamScopeResource = new Volcenginecc.Vpc.IpamScope("ipamScopeResource", new()
{
IpamId = "string",
Description = "string",
IpamScopeName = "string",
IpamScopeType = "string",
ProjectName = "string",
Tags = new[]
{
new Volcenginecc.Vpc.Inputs.IpamScopeTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := vpc.NewIpamScope(ctx, "ipamScopeResource", &vpc.IpamScopeArgs{
IpamId: pulumi.String("string"),
Description: pulumi.String("string"),
IpamScopeName: pulumi.String("string"),
IpamScopeType: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Tags: vpc.IpamScopeTagArray{
&vpc.IpamScopeTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
resource "volcenginecc_vpc_ipam_scope" "ipamScopeResource" {
lifecycle {
create_before_destroy = true
}
ipam_id = "string"
description = "string"
ipam_scope_name = "string"
ipam_scope_type = "string"
project_name = "string"
tags {
key = "string"
value = "string"
}
}
var ipamScopeResource = new IpamScope("ipamScopeResource", IpamScopeArgs.builder()
.ipamId("string")
.description("string")
.ipamScopeName("string")
.ipamScopeType("string")
.projectName("string")
.tags(IpamScopeTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
ipam_scope_resource = volcenginecc.vpc.IpamScope("ipamScopeResource",
ipam_id="string",
description="string",
ipam_scope_name="string",
ipam_scope_type="string",
project_name="string",
tags=[{
"key": "string",
"value": "string",
}])
const ipamScopeResource = new volcenginecc.vpc.IpamScope("ipamScopeResource", {
ipamId: "string",
description: "string",
ipamScopeName: "string",
ipamScopeType: "string",
projectName: "string",
tags: [{
key: "string",
value: "string",
}],
});
type: volcenginecc:vpc:IpamScope
properties:
description: string
ipamId: string
ipamScopeName: string
ipamScopeType: string
projectName: string
tags:
- key: string
value: string
IpamScope 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 IpamScope resource accepts the following input properties:
- Ipam
Id string - IPAM ID。
- Description string
- IPAM Scope Description
- Ipam
Scope stringName - IPAM Scope Name
- Ipam
Scope stringType - IPAM Scope Type
- Project
Name string - Project Name
-
List<Volcengine.
Ipam Scope Tag> - IPAM Scope 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.
- Ipam
Id string - IPAM ID。
- Description string
- IPAM Scope Description
- Ipam
Scope stringName - IPAM Scope Name
- Ipam
Scope stringType - IPAM Scope Type
- Project
Name string - Project Name
-
[]Ipam
Scope Tag Args - IPAM Scope 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.
- ipam_
id string - IPAM ID。
- description string
- IPAM Scope Description
- ipam_
scope_ stringname - IPAM Scope Name
- ipam_
scope_ stringtype - IPAM Scope Type
- project_
name string - Project Name
- list(object)
- IPAM Scope 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.
- ipam
Id String - IPAM ID。
- description String
- IPAM Scope Description
- ipam
Scope StringName - IPAM Scope Name
- ipam
Scope StringType - IPAM Scope Type
- project
Name String - Project Name
-
List<Ipam
Scope Tag> - IPAM Scope 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.
- ipam
Id string - IPAM ID。
- description string
- IPAM Scope Description
- ipam
Scope stringName - IPAM Scope Name
- ipam
Scope stringType - IPAM Scope Type
- project
Name string - Project Name
-
Ipam
Scope Tag[] - IPAM Scope 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.
- ipam_
id str - IPAM ID。
- description str
- IPAM Scope Description
- ipam_
scope_ strname - IPAM Scope Name
- ipam_
scope_ strtype - IPAM Scope Type
- project_
name str - Project Name
-
Sequence[Ipam
Scope Tag Args] - IPAM Scope 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.
- ipam
Id String - IPAM ID。
- description String
- IPAM Scope Description
- ipam
Scope StringName - IPAM Scope Name
- ipam
Scope StringType - IPAM Scope Type
- project
Name String - Project Name
- List<Property Map>
- IPAM Scope 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 IpamScope resource produces the following output properties:
- Account
Id string - Account ID
- Create
Time string - IPAM Scope Creation Time
- Id string
- The provider-assigned unique ID for this managed resource.
- Ipam
Region stringId - IPAM Region ID
- Ipam
Scope stringId - IPAM Scope ID
- Is
Default bool - Default Scope
- Pool
Count int - Number of Address Pools
- Status string
- IPAM Scope Status
- Update
Time string - IPAM Scope Update Time
- Account
Id string - Account ID
- Create
Time string - IPAM Scope Creation Time
- Id string
- The provider-assigned unique ID for this managed resource.
- Ipam
Region stringId - IPAM Region ID
- Ipam
Scope stringId - IPAM Scope ID
- Is
Default bool - Default Scope
- Pool
Count int - Number of Address Pools
- Status string
- IPAM Scope Status
- Update
Time string - IPAM Scope Update Time
- account_
id string - Account ID
- create_
time string - IPAM Scope Creation Time
- id string
- The provider-assigned unique ID for this managed resource.
- ipam_
region_ stringid - IPAM Region ID
- ipam_
scope_ stringid - IPAM Scope ID
- is_
default bool - Default Scope
- pool_
count number - Number of Address Pools
- status string
- IPAM Scope Status
- update_
time string - IPAM Scope Update Time
- account
Id String - Account ID
- create
Time String - IPAM Scope Creation Time
- id String
- The provider-assigned unique ID for this managed resource.
- ipam
Region StringId - IPAM Region ID
- ipam
Scope StringId - IPAM Scope ID
- is
Default Boolean - Default Scope
- pool
Count Integer - Number of Address Pools
- status String
- IPAM Scope Status
- update
Time String - IPAM Scope Update Time
- account
Id string - Account ID
- create
Time string - IPAM Scope Creation Time
- id string
- The provider-assigned unique ID for this managed resource.
- ipam
Region stringId - IPAM Region ID
- ipam
Scope stringId - IPAM Scope ID
- is
Default boolean - Default Scope
- pool
Count number - Number of Address Pools
- status string
- IPAM Scope Status
- update
Time string - IPAM Scope Update Time
- account_
id str - Account ID
- create_
time str - IPAM Scope Creation Time
- id str
- The provider-assigned unique ID for this managed resource.
- ipam_
region_ strid - IPAM Region ID
- ipam_
scope_ strid - IPAM Scope ID
- is_
default bool - Default Scope
- pool_
count int - Number of Address Pools
- status str
- IPAM Scope Status
- update_
time str - IPAM Scope Update Time
- account
Id String - Account ID
- create
Time String - IPAM Scope Creation Time
- id String
- The provider-assigned unique ID for this managed resource.
- ipam
Region StringId - IPAM Region ID
- ipam
Scope StringId - IPAM Scope ID
- is
Default Boolean - Default Scope
- pool
Count Number - Number of Address Pools
- status String
- IPAM Scope Status
- update
Time String - IPAM Scope Update Time
Look up Existing IpamScope Resource
Get an existing IpamScope 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?: IpamScopeState, opts?: CustomResourceOptions): IpamScope@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
ipam_id: Optional[str] = None,
ipam_region_id: Optional[str] = None,
ipam_scope_id: Optional[str] = None,
ipam_scope_name: Optional[str] = None,
ipam_scope_type: Optional[str] = None,
is_default: Optional[bool] = None,
pool_count: Optional[int] = None,
project_name: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Sequence[IpamScopeTagArgs]] = None,
update_time: Optional[str] = None) -> IpamScopefunc GetIpamScope(ctx *Context, name string, id IDInput, state *IpamScopeState, opts ...ResourceOption) (*IpamScope, error)public static IpamScope Get(string name, Input<string> id, IpamScopeState? state, CustomResourceOptions? opts = null)public static IpamScope get(String name, Output<String> id, IpamScopeState state, CustomResourceOptions options)resources: _: type: volcenginecc:vpc:IpamScope get: id: ${id}import {
to = volcenginecc_vpc_ipam_scope.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.
- Account
Id string - Account ID
- Create
Time string - IPAM Scope Creation Time
- Description string
- IPAM Scope Description
- Ipam
Id string - IPAM ID。
- Ipam
Region stringId - IPAM Region ID
- Ipam
Scope stringId - IPAM Scope ID
- Ipam
Scope stringName - IPAM Scope Name
- Ipam
Scope stringType - IPAM Scope Type
- Is
Default bool - Default Scope
- Pool
Count int - Number of Address Pools
- Project
Name string - Project Name
- Status string
- IPAM Scope Status
-
List<Volcengine.
Ipam Scope Tag> - IPAM Scope 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 Scope Update Time
- Account
Id string - Account ID
- Create
Time string - IPAM Scope Creation Time
- Description string
- IPAM Scope Description
- Ipam
Id string - IPAM ID。
- Ipam
Region stringId - IPAM Region ID
- Ipam
Scope stringId - IPAM Scope ID
- Ipam
Scope stringName - IPAM Scope Name
- Ipam
Scope stringType - IPAM Scope Type
- Is
Default bool - Default Scope
- Pool
Count int - Number of Address Pools
- Project
Name string - Project Name
- Status string
- IPAM Scope Status
-
[]Ipam
Scope Tag Args - IPAM Scope 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 Scope Update Time
- account_
id string - Account ID
- create_
time string - IPAM Scope Creation Time
- description string
- IPAM Scope Description
- ipam_
id string - IPAM ID。
- ipam_
region_ stringid - IPAM Region ID
- ipam_
scope_ stringid - IPAM Scope ID
- ipam_
scope_ stringname - IPAM Scope Name
- ipam_
scope_ stringtype - IPAM Scope Type
- is_
default bool - Default Scope
- pool_
count number - Number of Address Pools
- project_
name string - Project Name
- status string
- IPAM Scope Status
- list(object)
- IPAM Scope 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 Scope Update Time
- account
Id String - Account ID
- create
Time String - IPAM Scope Creation Time
- description String
- IPAM Scope Description
- ipam
Id String - IPAM ID。
- ipam
Region StringId - IPAM Region ID
- ipam
Scope StringId - IPAM Scope ID
- ipam
Scope StringName - IPAM Scope Name
- ipam
Scope StringType - IPAM Scope Type
- is
Default Boolean - Default Scope
- pool
Count Integer - Number of Address Pools
- project
Name String - Project Name
- status String
- IPAM Scope Status
-
List<Ipam
Scope Tag> - IPAM Scope 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 Scope Update Time
- account
Id string - Account ID
- create
Time string - IPAM Scope Creation Time
- description string
- IPAM Scope Description
- ipam
Id string - IPAM ID。
- ipam
Region stringId - IPAM Region ID
- ipam
Scope stringId - IPAM Scope ID
- ipam
Scope stringName - IPAM Scope Name
- ipam
Scope stringType - IPAM Scope Type
- is
Default boolean - Default Scope
- pool
Count number - Number of Address Pools
- project
Name string - Project Name
- status string
- IPAM Scope Status
-
Ipam
Scope Tag[] - IPAM Scope 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 Scope Update Time
- account_
id str - Account ID
- create_
time str - IPAM Scope Creation Time
- description str
- IPAM Scope Description
- ipam_
id str - IPAM ID。
- ipam_
region_ strid - IPAM Region ID
- ipam_
scope_ strid - IPAM Scope ID
- ipam_
scope_ strname - IPAM Scope Name
- ipam_
scope_ strtype - IPAM Scope Type
- is_
default bool - Default Scope
- pool_
count int - Number of Address Pools
- project_
name str - Project Name
- status str
- IPAM Scope Status
-
Sequence[Ipam
Scope Tag Args] - IPAM Scope 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 Scope Update Time
- account
Id String - Account ID
- create
Time String - IPAM Scope Creation Time
- description String
- IPAM Scope Description
- ipam
Id String - IPAM ID。
- ipam
Region StringId - IPAM Region ID
- ipam
Scope StringId - IPAM Scope ID
- ipam
Scope StringName - IPAM Scope Name
- ipam
Scope StringType - IPAM Scope Type
- is
Default Boolean - Default Scope
- pool
Count Number - Number of Address Pools
- project
Name String - Project Name
- status String
- IPAM Scope Status
- List<Property Map>
- IPAM Scope 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 Scope Update Time
Supporting Types
IpamScopeTag, IpamScopeTagArgs
Import
$ pulumi import volcenginecc:vpc/ipamScope:IpamScope example "ipam_scope_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
volcengineccTerraform Provider.
published on Monday, Aug 24, 2026 by Volcengine