1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getVpc
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpc.getVpc

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::VPC::VPC

    Using getVpc

    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 getVpc(args: GetVpcArgs, opts?: InvokeOptions): Promise<GetVpcResult>
function getVpcOutput(args: GetVpcOutputArgs, opts?: InvokeOptions): Output<GetVpcResult>
    def get_vpc(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVpcResult
def get_vpc_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVpcResult]
    func LookupVpc(ctx *Context, args *LookupVpcArgs, opts ...InvokeOption) (*LookupVpcResult, error)
func LookupVpcOutput(ctx *Context, args *LookupVpcOutputArgs, opts ...InvokeOption) LookupVpcResultOutput

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

    public static class GetVpc 
{
    public static Task<GetVpcResult> InvokeAsync(GetVpcArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcResult> Invoke(GetVpcInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
public static Output<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:vpc/getVpc:getVpc
  arguments:
    # arguments dictionary

    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 str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getVpc Result

    The following output properties are available:

    AccountId string
    ID of the account to which the VPC belongs.
    AssociateCens List<Volcengine.GetVpcAssociateCen>
    CEN information associated with the VPC.
    CidrBlock string
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    CreationTime string
    Time when the VPC was created.
    Description string
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    DnsServers List<string>
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    EnableIpv6 bool
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    Id string
    Uniquely identifies the resource.
    Ipv4GatewayId string
    ID of the IPv4 gateway bound to the VPC.
    Ipv6CidrBlock string
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    IsDefault bool
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    NatGatewayIds List<string>
    ID of the NAT gateway created in the VPC.
    NetworkAclNum string
    Number of network ACLs in the VPC.
    ProjectName string
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    RouteTableIds List<string>
    ID of the route table associated with the VPC.
    SecondaryCidrBlocks List<string>
    Secondary CIDR block of the VPC.
    SecurityGroupIds List<string>
    List of security groups in the VPC.
    Status string
    Status of the VPC. Creating: being created. Created: created. Available: available.
    SubnetIds List<string>
    List of subnets in the VPC.
    SupportIpv4Gateway bool
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    Tags List<Volcengine.GetVpcTag>
    Tags bound to the private network.
    UpdateTime string
    Time when the VPC was updated.
    UserCidrBlocks List<string>
    User CIDR block of the VPC.
    VpcId string
    ID of the VPC.
    VpcName string
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.
    AccountId string
    ID of the account to which the VPC belongs.
    AssociateCens []GetVpcAssociateCen
    CEN information associated with the VPC.
    CidrBlock string
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    CreationTime string
    Time when the VPC was created.
    Description string
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    DnsServers []string
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    EnableIpv6 bool
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    Id string
    Uniquely identifies the resource.
    Ipv4GatewayId string
    ID of the IPv4 gateway bound to the VPC.
    Ipv6CidrBlock string
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    IsDefault bool
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    NatGatewayIds []string
    ID of the NAT gateway created in the VPC.
    NetworkAclNum string
    Number of network ACLs in the VPC.
    ProjectName string
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    RouteTableIds []string
    ID of the route table associated with the VPC.
    SecondaryCidrBlocks []string
    Secondary CIDR block of the VPC.
    SecurityGroupIds []string
    List of security groups in the VPC.
    Status string
    Status of the VPC. Creating: being created. Created: created. Available: available.
    SubnetIds []string
    List of subnets in the VPC.
    SupportIpv4Gateway bool
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    Tags []GetVpcTag
    Tags bound to the private network.
    UpdateTime string
    Time when the VPC was updated.
    UserCidrBlocks []string
    User CIDR block of the VPC.
    VpcId string
    ID of the VPC.
    VpcName string
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.
    accountId String
    ID of the account to which the VPC belongs.
    associateCens List<GetVpcAssociateCen>
    CEN information associated with the VPC.
    cidrBlock String
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    creationTime String
    Time when the VPC was created.
    description String
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    dnsServers List<String>
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    enableIpv6 Boolean
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    id String
    Uniquely identifies the resource.
    ipv4GatewayId String
    ID of the IPv4 gateway bound to the VPC.
    ipv6CidrBlock String
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    isDefault Boolean
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    natGatewayIds List<String>
    ID of the NAT gateway created in the VPC.
    networkAclNum String
    Number of network ACLs in the VPC.
    projectName String
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    routeTableIds List<String>
    ID of the route table associated with the VPC.
    secondaryCidrBlocks List<String>
    Secondary CIDR block of the VPC.
    securityGroupIds List<String>
    List of security groups in the VPC.
    status String
    Status of the VPC. Creating: being created. Created: created. Available: available.
    subnetIds List<String>
    List of subnets in the VPC.
    supportIpv4Gateway Boolean
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    tags List<GetVpcTag>
    Tags bound to the private network.
    updateTime String
    Time when the VPC was updated.
    userCidrBlocks List<String>
    User CIDR block of the VPC.
    vpcId String
    ID of the VPC.
    vpcName String
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.
    accountId string
    ID of the account to which the VPC belongs.
    associateCens GetVpcAssociateCen[]
    CEN information associated with the VPC.
    cidrBlock string
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    creationTime string
    Time when the VPC was created.
    description string
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    dnsServers string[]
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    enableIpv6 boolean
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    id string
    Uniquely identifies the resource.
    ipv4GatewayId string
    ID of the IPv4 gateway bound to the VPC.
    ipv6CidrBlock string
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    isDefault boolean
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    natGatewayIds string[]
    ID of the NAT gateway created in the VPC.
    networkAclNum string
    Number of network ACLs in the VPC.
    projectName string
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    routeTableIds string[]
    ID of the route table associated with the VPC.
    secondaryCidrBlocks string[]
    Secondary CIDR block of the VPC.
    securityGroupIds string[]
    List of security groups in the VPC.
    status string
    Status of the VPC. Creating: being created. Created: created. Available: available.
    subnetIds string[]
    List of subnets in the VPC.
    supportIpv4Gateway boolean
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    tags GetVpcTag[]
    Tags bound to the private network.
    updateTime string
    Time when the VPC was updated.
    userCidrBlocks string[]
    User CIDR block of the VPC.
    vpcId string
    ID of the VPC.
    vpcName string
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.
    account_id str
    ID of the account to which the VPC belongs.
    associate_cens Sequence[GetVpcAssociateCen]
    CEN information associated with the VPC.
    cidr_block str
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    creation_time str
    Time when the VPC was created.
    description str
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    dns_servers Sequence[str]
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    enable_ipv6 bool
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    id str
    Uniquely identifies the resource.
    ipv4_gateway_id str
    ID of the IPv4 gateway bound to the VPC.
    ipv6_cidr_block str
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    is_default bool
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    nat_gateway_ids Sequence[str]
    ID of the NAT gateway created in the VPC.
    network_acl_num str
    Number of network ACLs in the VPC.
    project_name str
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    route_table_ids Sequence[str]
    ID of the route table associated with the VPC.
    secondary_cidr_blocks Sequence[str]
    Secondary CIDR block of the VPC.
    security_group_ids Sequence[str]
    List of security groups in the VPC.
    status str
    Status of the VPC. Creating: being created. Created: created. Available: available.
    subnet_ids Sequence[str]
    List of subnets in the VPC.
    support_ipv4_gateway bool
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    tags Sequence[GetVpcTag]
    Tags bound to the private network.
    update_time str
    Time when the VPC was updated.
    user_cidr_blocks Sequence[str]
    User CIDR block of the VPC.
    vpc_id str
    ID of the VPC.
    vpc_name str
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.
    accountId String
    ID of the account to which the VPC belongs.
    associateCens List<Property Map>
    CEN information associated with the VPC.
    cidrBlock String
    IPv4 CIDR block of the VPC. You can use the following CIDR blocks or their subsets as the VPC's IPv4 CIDR block: 192.168.0.0/16 ~ 24, 10.0.0.0/8 ~ 24, 172.16.0.0/12 ~ 24.
    creationTime String
    Time when the VPC was created.
    description String
    Description of the VPC. Length must be between 0 and 255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Cannot start with http:// or https://.
    dnsServers List<String>
    DNS server addresses of the VPC. Maximum of 5 per request. Each DnsServer must be a valid IP address. Use & to separate multiple IPs. If not specified, defaults to the system DNS server addresses.
    enableIpv6 Boolean
    Whether to enable IPv6 CIDR block. false (default): not enabled. true: enabled.
    id String
    Uniquely identifies the resource.
    ipv4GatewayId String
    ID of the IPv4 gateway bound to the VPC.
    ipv6CidrBlock String
    IPv6 CIDR block of the VPC. If this parameter is provided, the Ipv6MaskLen parameter is ignored. If the Ipv6Isp parameter is set to a value other than BGP, either the Ipv6MaskLen or Ipv6CidrBlock parameter must be provided. If the Ipv6Isp parameter is not provided or set to BGP and this parameter is not provided, the system automatically assigns an IPv6 CIDR block.
    isDefault Boolean
    Whether this VPC is the default VPC. true: default VPC, meaning the VPC was automatically created by the system when creating an ECS instance. false: non-default VPC, meaning the VPC was manually created by the user.
    natGatewayIds List<String>
    ID of the NAT gateway created in the VPC.
    networkAclNum String
    Number of network ACLs in the VPC.
    projectName String
    Name of the project to which the VPC belongs. If not specified, it is added to the default project.
    routeTableIds List<String>
    ID of the route table associated with the VPC.
    secondaryCidrBlocks List<String>
    Secondary CIDR block of the VPC.
    securityGroupIds List<String>
    List of security groups in the VPC.
    status String
    Status of the VPC. Creating: being created. Created: created. Available: available.
    subnetIds List<String>
    List of subnets in the VPC.
    supportIpv4Gateway Boolean
    Whether the VPC enables the IPv4 gateway. false (default): not enabled. true: enabled.
    tags List<Property Map>
    Tags bound to the private network.
    updateTime String
    Time when the VPC was updated.
    userCidrBlocks List<String>
    User CIDR block of the VPC.
    vpcId String
    ID of the VPC.
    vpcName String
    Name of the VPC. Length must be between 1 and 128 characters. Must start with a letter, Chinese character, or number, and can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the VPC instance ID. Cannot start with http:// or https://.

    Supporting Types

    GetVpcAssociateCen

    CenId string
    ID of the CEN.
    CenOwnerId string
    User ID of the CEN.
    CenStatus string
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded
    CenId string
    ID of the CEN.
    CenOwnerId string
    User ID of the CEN.
    CenStatus string
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded
    cenId String
    ID of the CEN.
    cenOwnerId String
    User ID of the CEN.
    cenStatus String
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded
    cenId string
    ID of the CEN.
    cenOwnerId string
    User ID of the CEN.
    cenStatus string
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded
    cen_id str
    ID of the CEN.
    cen_owner_id str
    User ID of the CEN.
    cen_status str
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded
    cenId String
    ID of the CEN.
    cenOwnerId String
    User ID of the CEN.
    cenStatus String
    Status of the VPC in the CEN. Loading: loading, Loaded: loaded

    GetVpcTag

    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.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.