Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. privatezone
  6. PrivateZone
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.privatezone.PrivateZone

volcenginecc logo
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Private network resolution

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  privateZoneDemo:
    type: volcenginecc:privatezone:PrivateZone
    name: PrivateZoneDemo
    properties:
      zoneName: new.example.com
      vpcs:
        - vpc_id: vpc-btgxxxxx0b2tnxxxxx
          region: cn-beijing
      projectName: default
      lineMode: 1
      recursionMode: true
      tags:
        - value: test
          key: env
      remark: 测试域名

    Example coming soon!

    Create PrivateZone Resource

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

    Constructor syntax

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

@overload
def PrivateZone(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                zone_name: Optional[str] = None,
                line_mode: Optional[int] = None,
                project_name: Optional[str] = None,
                recursion_mode: Optional[bool] = None,
                remark: Optional[str] = None,
                tags: Optional[Sequence[PrivateZoneTagArgs]] = None,
                vpcs: Optional[Sequence[PrivateZoneVpcArgs]] = None)
    func NewPrivateZone(ctx *Context, name string, args PrivateZoneArgs, opts ...ResourceOption) (*PrivateZone, error)
    public PrivateZone(string name, PrivateZoneArgs args, CustomResourceOptions? opts = null)
    public PrivateZone(String name, PrivateZoneArgs args)
public PrivateZone(String name, PrivateZoneArgs args, CustomResourceOptions options)

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


    resource "volcenginecc_privatezone_privatezone" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PrivateZoneArgs
    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 PrivateZoneArgs
    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 PrivateZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateZoneArgs
    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 privateZoneResource = new Volcenginecc.Privatezone.PrivateZone("privateZoneResource", new()
{
    ZoneName = "string",
    LineMode = 0,
    ProjectName = "string",
    RecursionMode = false,
    Remark = "string",
    Tags = new[]
    {
        new Volcenginecc.Privatezone.Inputs.PrivateZoneTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Vpcs = new[]
    {
        new Volcenginecc.Privatezone.Inputs.PrivateZoneVpcArgs
        {
            Region = "string",
            VpcId = "string",
        },
    },
});

    example, err := privatezone.NewPrivateZone(ctx, "privateZoneResource", &privatezone.PrivateZoneArgs{
	ZoneName:      pulumi.String("string"),
	LineMode:      pulumi.Int(0),
	ProjectName:   pulumi.String("string"),
	RecursionMode: pulumi.Bool(false),
	Remark:        pulumi.String("string"),
	Tags: privatezone.PrivateZoneTagArray{
		&privatezone.PrivateZoneTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Vpcs: privatezone.PrivateZoneVpcArray{
		&privatezone.PrivateZoneVpcArgs{
			Region: pulumi.String("string"),
			VpcId:  pulumi.String("string"),
		},
	},
})

    resource "volcenginecc_privatezone_privatezone" "privateZoneResource" {
  zone_name      = "string"
  line_mode      = 0
  project_name   = "string"
  recursion_mode = false
  remark         = "string"
  tags {
    key   = "string"
    value = "string"
  }
  vpcs {
    region = "string"
    vpc_id = "string"
  }
}

    var privateZoneResource = new PrivateZone("privateZoneResource", PrivateZoneArgs.builder()
    .zoneName("string")
    .lineMode(0)
    .projectName("string")
    .recursionMode(false)
    .remark("string")
    .tags(PrivateZoneTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .vpcs(PrivateZoneVpcArgs.builder()
        .region("string")
        .vpcId("string")
        .build())
    .build());

    private_zone_resource = volcenginecc.privatezone.PrivateZone("privateZoneResource",
    zone_name="string",
    line_mode=0,
    project_name="string",
    recursion_mode=False,
    remark="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    vpcs=[{
        "region": "string",
        "vpc_id": "string",
    }])

    const privateZoneResource = new volcenginecc.privatezone.PrivateZone("privateZoneResource", {
    zoneName: "string",
    lineMode: 0,
    projectName: "string",
    recursionMode: false,
    remark: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    vpcs: [{
        region: "string",
        vpcId: "string",
    }],
});

    type: volcenginecc:privatezone:PrivateZone
properties:
    lineMode: 0
    projectName: string
    recursionMode: false
    remark: string
    tags:
        - key: string
          value: string
    vpcs:
        - region: string
          vpcId: string
    zoneName: string

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

    ZoneName string
    Domain name, can be a second-level or multi-level domain
    LineMode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    ProjectName string
    Name of the project the domain belongs to. Default is default
    RecursionMode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    Remark string
    Remarks. Default is an empty string
    Tags List<Volcengine.PrivateZoneTag>
    Vpcs List<Volcengine.PrivateZoneVpc>
    ZoneName string
    Domain name, can be a second-level or multi-level domain
    LineMode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    ProjectName string
    Name of the project the domain belongs to. Default is default
    RecursionMode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    Remark string
    Remarks. Default is an empty string
    Tags []PrivateZoneTagArgs
    Vpcs []PrivateZoneVpcArgs
    zone_name string
    Domain name, can be a second-level or multi-level domain
    line_mode number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    project_name string
    Name of the project the domain belongs to. Default is default
    recursion_mode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark string
    Remarks. Default is an empty string
    tags list(object)
    vpcs list(object)
    zoneName String
    Domain name, can be a second-level or multi-level domain
    lineMode Integer
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName String
    Name of the project the domain belongs to. Default is default
    recursionMode Boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark String
    Remarks. Default is an empty string
    tags List<PrivateZoneTag>
    vpcs List<PrivateZoneVpc>
    zoneName string
    Domain name, can be a second-level or multi-level domain
    lineMode number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName string
    Name of the project the domain belongs to. Default is default
    recursionMode boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark string
    Remarks. Default is an empty string
    tags PrivateZoneTag[]
    vpcs PrivateZoneVpc[]
    zone_name str
    Domain name, can be a second-level or multi-level domain
    line_mode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    project_name str
    Name of the project the domain belongs to. Default is default
    recursion_mode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark str
    Remarks. Default is an empty string
    tags Sequence[PrivateZoneTagArgs]
    vpcs Sequence[PrivateZoneVpcArgs]
    zoneName String
    Domain name, can be a second-level or multi-level domain
    lineMode Number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName String
    Name of the project the domain belongs to. Default is default
    recursionMode Boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark String
    Remarks. Default is an empty string
    tags List<Property Map>
    vpcs List<Property Map>

    Outputs

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

    CreatedAt string
    Domain creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperator string
    Most recent operator
    RecordCount int
    Number of DNS records under the domain name
    UpdatedAt string
    Most recent update time of the domain
    Zid string
    Unique ID identifying the domain name
    CreatedAt string
    Domain creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperator string
    Most recent operator
    RecordCount int
    Number of DNS records under the domain name
    UpdatedAt string
    Most recent update time of the domain
    Zid string
    Unique ID identifying the domain name
    created_at string
    Domain creation time
    id string
    The provider-assigned unique ID for this managed resource.
    last_operator string
    Most recent operator
    record_count number
    Number of DNS records under the domain name
    updated_at string
    Most recent update time of the domain
    zid string
    Unique ID identifying the domain name
    createdAt String
    Domain creation time
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperator String
    Most recent operator
    recordCount Integer
    Number of DNS records under the domain name
    updatedAt String
    Most recent update time of the domain
    zid String
    Unique ID identifying the domain name
    createdAt string
    Domain creation time
    id string
    The provider-assigned unique ID for this managed resource.
    lastOperator string
    Most recent operator
    recordCount number
    Number of DNS records under the domain name
    updatedAt string
    Most recent update time of the domain
    zid string
    Unique ID identifying the domain name
    created_at str
    Domain creation time
    id str
    The provider-assigned unique ID for this managed resource.
    last_operator str
    Most recent operator
    record_count int
    Number of DNS records under the domain name
    updated_at str
    Most recent update time of the domain
    zid str
    Unique ID identifying the domain name
    createdAt String
    Domain creation time
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperator String
    Most recent operator
    recordCount Number
    Number of DNS records under the domain name
    updatedAt String
    Most recent update time of the domain
    zid String
    Unique ID identifying the domain name

    Look up Existing PrivateZone Resource

    Get an existing PrivateZone 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?: PrivateZoneState, opts?: CustomResourceOptions): PrivateZone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        last_operator: Optional[str] = None,
        line_mode: Optional[int] = None,
        project_name: Optional[str] = None,
        record_count: Optional[int] = None,
        recursion_mode: Optional[bool] = None,
        remark: Optional[str] = None,
        tags: Optional[Sequence[PrivateZoneTagArgs]] = None,
        updated_at: Optional[str] = None,
        vpcs: Optional[Sequence[PrivateZoneVpcArgs]] = None,
        zid: Optional[str] = None,
        zone_name: Optional[str] = None) -> PrivateZone
    func GetPrivateZone(ctx *Context, name string, id IDInput, state *PrivateZoneState, opts ...ResourceOption) (*PrivateZone, error)
    public static PrivateZone Get(string name, Input<string> id, PrivateZoneState? state, CustomResourceOptions? opts = null)
    public static PrivateZone get(String name, Output<String> id, PrivateZoneState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:privatezone:PrivateZone    get:      id: ${id}
    import {
  to = volcenginecc_privatezone_privatezone.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:
    CreatedAt string
    Domain creation time
    LastOperator string
    Most recent operator
    LineMode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    ProjectName string
    Name of the project the domain belongs to. Default is default
    RecordCount int
    Number of DNS records under the domain name
    RecursionMode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    Remark string
    Remarks. Default is an empty string
    Tags List<Volcengine.PrivateZoneTag>
    UpdatedAt string
    Most recent update time of the domain
    Vpcs List<Volcengine.PrivateZoneVpc>
    Zid string
    Unique ID identifying the domain name
    ZoneName string
    Domain name, can be a second-level or multi-level domain
    CreatedAt string
    Domain creation time
    LastOperator string
    Most recent operator
    LineMode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    ProjectName string
    Name of the project the domain belongs to. Default is default
    RecordCount int
    Number of DNS records under the domain name
    RecursionMode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    Remark string
    Remarks. Default is an empty string
    Tags []PrivateZoneTagArgs
    UpdatedAt string
    Most recent update time of the domain
    Vpcs []PrivateZoneVpcArgs
    Zid string
    Unique ID identifying the domain name
    ZoneName string
    Domain name, can be a second-level or multi-level domain
    created_at string
    Domain creation time
    last_operator string
    Most recent operator
    line_mode number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    project_name string
    Name of the project the domain belongs to. Default is default
    record_count number
    Number of DNS records under the domain name
    recursion_mode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark string
    Remarks. Default is an empty string
    tags list(object)
    updated_at string
    Most recent update time of the domain
    vpcs list(object)
    zid string
    Unique ID identifying the domain name
    zone_name string
    Domain name, can be a second-level or multi-level domain
    createdAt String
    Domain creation time
    lastOperator String
    Most recent operator
    lineMode Integer
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName String
    Name of the project the domain belongs to. Default is default
    recordCount Integer
    Number of DNS records under the domain name
    recursionMode Boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark String
    Remarks. Default is an empty string
    tags List<PrivateZoneTag>
    updatedAt String
    Most recent update time of the domain
    vpcs List<PrivateZoneVpc>
    zid String
    Unique ID identifying the domain name
    zoneName String
    Domain name, can be a second-level or multi-level domain
    createdAt string
    Domain creation time
    lastOperator string
    Most recent operator
    lineMode number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName string
    Name of the project the domain belongs to. Default is default
    recordCount number
    Number of DNS records under the domain name
    recursionMode boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark string
    Remarks. Default is an empty string
    tags PrivateZoneTag[]
    updatedAt string
    Most recent update time of the domain
    vpcs PrivateZoneVpc[]
    zid string
    Unique ID identifying the domain name
    zoneName string
    Domain name, can be a second-level or multi-level domain
    created_at str
    Domain creation time
    last_operator str
    Most recent operator
    line_mode int
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    project_name str
    Name of the project the domain belongs to. Default is default
    record_count int
    Number of DNS records under the domain name
    recursion_mode bool
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark str
    Remarks. Default is an empty string
    tags Sequence[PrivateZoneTagArgs]
    updated_at str
    Most recent update time of the domain
    vpcs Sequence[PrivateZoneVpcArgs]
    zid str
    Unique ID identifying the domain name
    zone_name str
    Domain name, can be a second-level or multi-level domain
    createdAt String
    Domain creation time
    lastOperator String
    Most recent operator
    lineMode Number
    Enable load balancing: 0 to disable, 1 to enable. Default is 0
    projectName String
    Name of the project the domain belongs to. Default is default
    recordCount Number
    Number of DNS records under the domain name
    recursionMode Boolean
    Enable recursive resolution: true to enable, false to disable. Default is false
    remark String
    Remarks. Default is an empty string
    tags List<Property Map>
    updatedAt String
    Most recent update time of the domain
    vpcs List<Property Map>
    zid String
    Unique ID identifying the domain name
    zoneName String
    Domain name, can be a second-level or multi-level domain

    Supporting Types

    PrivateZoneTag, PrivateZoneTagArgs

    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

    PrivateZoneVpc, PrivateZoneVpcArgs

    Region string
    Region where the VPC is located
    VpcId string
    VPC ID
    Region string
    Region where the VPC is located
    VpcId string
    VPC ID
    region string
    Region where the VPC is located
    vpc_id string
    VPC ID
    region String
    Region where the VPC is located
    vpcId String
    VPC ID
    region string
    Region where the VPC is located
    vpcId string
    VPC ID
    region str
    Region where the VPC is located
    vpc_id str
    VPC ID
    region String
    Region where the VPC is located
    vpcId String
    VPC ID

    Import

    $ pulumi import volcenginecc:privatezone/privateZone:PrivateZone example "zid"

    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.43
    published on Monday, Jun 15, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial