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

volcenginecc.directconnect.DirectConnectGateway

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

    The Direct Connect Gateway is the entry point for local data centers to access the cloud. It connects private networks (VPC) and physical dedicated connections, enabling mutual access between on-premises data centers (IDC) and cloud private networks (VPC).

    Example Usage

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

const directConnectDirectConnectGatewayDemo = new volcenginecc.directconnect.DirectConnectGateway("DirectConnectDirectConnectGatewayDemo", {
    description: "DirectConnectDirectConnectGatewayDemo-Description",
    directConnectGatewayName: "DirectConnectDirectConnectGatewayDemo",
    enableIpv6: false,
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

direct_connect_direct_connect_gateway_demo = volcenginecc.directconnect.DirectConnectGateway("DirectConnectDirectConnectGatewayDemo",
    description="DirectConnectDirectConnectGatewayDemo-Description",
    direct_connect_gateway_name="DirectConnectDirectConnectGatewayDemo",
    enable_ipv6=False,
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/directconnect"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewDirectConnectGateway(ctx, "DirectConnectDirectConnectGatewayDemo", &directconnect.DirectConnectGatewayArgs{
			Description:              pulumi.String("DirectConnectDirectConnectGatewayDemo-Description"),
			DirectConnectGatewayName: pulumi.String("DirectConnectDirectConnectGatewayDemo"),
			EnableIpv6:               pulumi.Bool(false),
			ProjectName:              pulumi.String("default"),
			Tags: directconnect.DirectConnectGatewayTagArray{
				&directconnect.DirectConnectGatewayTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		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 directConnectDirectConnectGatewayDemo = new Volcenginecc.Directconnect.DirectConnectGateway("DirectConnectDirectConnectGatewayDemo", new()
    {
        Description = "DirectConnectDirectConnectGatewayDemo-Description",
        DirectConnectGatewayName = "DirectConnectDirectConnectGatewayDemo",
        EnableIpv6 = false,
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Directconnect.Inputs.DirectConnectGatewayTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.directconnect.DirectConnectGateway;
import com.volcengine.volcenginecc.directconnect.DirectConnectGatewayArgs;
import com.pulumi.volcenginecc.directconnect.inputs.DirectConnectGatewayTagArgs;
import java.util.List;
import java.util.ArrayList;
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 directConnectDirectConnectGatewayDemo = new DirectConnectGateway("directConnectDirectConnectGatewayDemo", DirectConnectGatewayArgs.builder()
            .description("DirectConnectDirectConnectGatewayDemo-Description")
            .directConnectGatewayName("DirectConnectDirectConnectGatewayDemo")
            .enableIpv6(false)
            .projectName("default")
            .tags(DirectConnectGatewayTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  directConnectDirectConnectGatewayDemo:
    type: volcenginecc:directconnect:DirectConnectGateway
    name: DirectConnectDirectConnectGatewayDemo
    properties:
      description: DirectConnectDirectConnectGatewayDemo-Description
      directConnectGatewayName: DirectConnectDirectConnectGatewayDemo
      enableIpv6: false
      projectName: default
      tags:
        - key: env
          value: test

    Create DirectConnectGateway Resource

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

    Constructor syntax

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

@overload
def DirectConnectGateway(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         bgp_asn: Optional[int] = None,
                         description: Optional[str] = None,
                         direct_connect_gateway_name: Optional[str] = None,
                         enable_ipv6: Optional[bool] = None,
                         project_name: Optional[str] = None,
                         tags: Optional[Sequence[DirectConnectGatewayTagArgs]] = None)
    func NewDirectConnectGateway(ctx *Context, name string, args *DirectConnectGatewayArgs, opts ...ResourceOption) (*DirectConnectGateway, error)
    public DirectConnectGateway(string name, DirectConnectGatewayArgs? args = null, CustomResourceOptions? opts = null)
    public DirectConnectGateway(String name, DirectConnectGatewayArgs args)
public DirectConnectGateway(String name, DirectConnectGatewayArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args DirectConnectGatewayArgs
    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 DirectConnectGatewayArgs
    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 DirectConnectGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DirectConnectGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DirectConnectGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    BgpAsn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    Description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    DirectConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    EnableIpv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    ProjectName string
    Project to which the Direct Connect Gateway belongs.
    Tags List<Volcengine.DirectConnectGatewayTag>
    BgpAsn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    Description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    DirectConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    EnableIpv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    ProjectName string
    Project to which the Direct Connect Gateway belongs.
    Tags []DirectConnectGatewayTagArgs
    bgpAsn Integer
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    description String
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayName String
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 Boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    projectName String
    Project to which the Direct Connect Gateway belongs.
    tags List<DirectConnectGatewayTag>
    bgpAsn number
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    projectName string
    Project to which the Direct Connect Gateway belongs.
    tags DirectConnectGatewayTag[]
    bgp_asn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    description str
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    direct_connect_gateway_name str
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enable_ipv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    project_name str
    Project to which the Direct Connect Gateway belongs.
    tags Sequence[DirectConnectGatewayTagArgs]
    bgpAsn Number
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    description String
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayName String
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 Boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    projectName String
    Project to which the Direct Connect Gateway belongs.
    tags List<Property Map>

    Outputs

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

    AccountId string
    ID of the account to which the Direct Connect Gateway belongs.
    AssociateCens List<Volcengine.DirectConnectGatewayAssociateCen>
    AssociateEic Volcengine.DirectConnectGatewayAssociateEic
    Associated EIC information.
    BusinessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Time when the Direct Connect Gateway was created.
    DeletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    DirectConnectGatewayId string
    ID of the Direct Connect Gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    OverdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    Status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    UpdatedTime string
    Time when the Direct Connect Gateway was updated.
    AccountId string
    ID of the account to which the Direct Connect Gateway belongs.
    AssociateCens []DirectConnectGatewayAssociateCen
    AssociateEic DirectConnectGatewayAssociateEic
    Associated EIC information.
    BusinessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Time when the Direct Connect Gateway was created.
    DeletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    DirectConnectGatewayId string
    ID of the Direct Connect Gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    OverdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    Status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    UpdatedTime string
    Time when the Direct Connect Gateway was updated.
    accountId String
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens List<DirectConnectGatewayAssociateCen>
    associateEic DirectConnectGatewayAssociateEic
    Associated EIC information.
    businessStatus String
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Time when the Direct Connect Gateway was created.
    deletedTime String
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    directConnectGatewayId String
    ID of the Direct Connect Gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime String
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    status String
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    updatedTime String
    Time when the Direct Connect Gateway was updated.
    accountId string
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens DirectConnectGatewayAssociateCen[]
    associateEic DirectConnectGatewayAssociateEic
    Associated EIC information.
    businessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime string
    Time when the Direct Connect Gateway was created.
    deletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    directConnectGatewayId string
    ID of the Direct Connect Gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    lockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    updatedTime string
    Time when the Direct Connect Gateway was updated.
    account_id str
    ID of the account to which the Direct Connect Gateway belongs.
    associate_cens Sequence[DirectConnectGatewayAssociateCen]
    associate_eic DirectConnectGatewayAssociateEic
    Associated EIC information.
    business_status str
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    created_time str
    Time when the Direct Connect Gateway was created.
    deleted_time str
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    direct_connect_gateway_id str
    ID of the Direct Connect Gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    lock_reason str
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdue_time str
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    status str
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    updated_time str
    Time when the Direct Connect Gateway was updated.
    accountId String
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens List<Property Map>
    associateEic Property Map
    Associated EIC information.
    businessStatus String
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Time when the Direct Connect Gateway was created.
    deletedTime String
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    directConnectGatewayId String
    ID of the Direct Connect Gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime String
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    status String
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    updatedTime String
    Time when the Direct Connect Gateway was updated.

    Look up Existing DirectConnectGateway Resource

    Get an existing DirectConnectGateway 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?: DirectConnectGatewayState, opts?: CustomResourceOptions): DirectConnectGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        associate_cens: Optional[Sequence[DirectConnectGatewayAssociateCenArgs]] = None,
        associate_eic: Optional[DirectConnectGatewayAssociateEicArgs] = None,
        bgp_asn: Optional[int] = None,
        business_status: Optional[str] = None,
        created_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        direct_connect_gateway_id: Optional[str] = None,
        direct_connect_gateway_name: Optional[str] = None,
        enable_ipv6: Optional[bool] = None,
        lock_reason: Optional[str] = None,
        overdue_time: Optional[str] = None,
        project_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[DirectConnectGatewayTagArgs]] = None,
        updated_time: Optional[str] = None) -> DirectConnectGateway
    func GetDirectConnectGateway(ctx *Context, name string, id IDInput, state *DirectConnectGatewayState, opts ...ResourceOption) (*DirectConnectGateway, error)
    public static DirectConnectGateway Get(string name, Input<string> id, DirectConnectGatewayState? state, CustomResourceOptions? opts = null)
    public static DirectConnectGateway get(String name, Output<String> id, DirectConnectGatewayState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:directconnect:DirectConnectGateway    get:      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
    ID of the account to which the Direct Connect Gateway belongs.
    AssociateCens List<Volcengine.DirectConnectGatewayAssociateCen>
    AssociateEic Volcengine.DirectConnectGatewayAssociateEic
    Associated EIC information.
    BgpAsn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    BusinessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Time when the Direct Connect Gateway was created.
    DeletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    Description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    DirectConnectGatewayId string
    ID of the Direct Connect Gateway.
    DirectConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    EnableIpv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    LockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    OverdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    ProjectName string
    Project to which the Direct Connect Gateway belongs.
    Status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    Tags List<Volcengine.DirectConnectGatewayTag>
    UpdatedTime string
    Time when the Direct Connect Gateway was updated.
    AccountId string
    ID of the account to which the Direct Connect Gateway belongs.
    AssociateCens []DirectConnectGatewayAssociateCenArgs
    AssociateEic DirectConnectGatewayAssociateEicArgs
    Associated EIC information.
    BgpAsn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    BusinessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Time when the Direct Connect Gateway was created.
    DeletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    Description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    DirectConnectGatewayId string
    ID of the Direct Connect Gateway.
    DirectConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    EnableIpv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    LockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    OverdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    ProjectName string
    Project to which the Direct Connect Gateway belongs.
    Status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    Tags []DirectConnectGatewayTagArgs
    UpdatedTime string
    Time when the Direct Connect Gateway was updated.
    accountId String
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens List<DirectConnectGatewayAssociateCen>
    associateEic DirectConnectGatewayAssociateEic
    Associated EIC information.
    bgpAsn Integer
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    businessStatus String
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Time when the Direct Connect Gateway was created.
    deletedTime String
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    description String
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayId String
    ID of the Direct Connect Gateway.
    directConnectGatewayName String
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 Boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    lockReason String
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime String
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    projectName String
    Project to which the Direct Connect Gateway belongs.
    status String
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    tags List<DirectConnectGatewayTag>
    updatedTime String
    Time when the Direct Connect Gateway was updated.
    accountId string
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens DirectConnectGatewayAssociateCen[]
    associateEic DirectConnectGatewayAssociateEic
    Associated EIC information.
    bgpAsn number
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    businessStatus string
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime string
    Time when the Direct Connect Gateway was created.
    deletedTime string
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    description string
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayId string
    ID of the Direct Connect Gateway.
    directConnectGatewayName string
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    lockReason string
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime string
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    projectName string
    Project to which the Direct Connect Gateway belongs.
    status string
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    tags DirectConnectGatewayTag[]
    updatedTime string
    Time when the Direct Connect Gateway was updated.
    account_id str
    ID of the account to which the Direct Connect Gateway belongs.
    associate_cens Sequence[DirectConnectGatewayAssociateCenArgs]
    associate_eic DirectConnectGatewayAssociateEicArgs
    Associated EIC information.
    bgp_asn int
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    business_status str
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    created_time str
    Time when the Direct Connect Gateway was created.
    deleted_time str
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    description str
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    direct_connect_gateway_id str
    ID of the Direct Connect Gateway.
    direct_connect_gateway_name str
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enable_ipv6 bool
    Whether IPv6 is supported. true: supported. false: not supported.
    lock_reason str
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdue_time str
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    project_name str
    Project to which the Direct Connect Gateway belongs.
    status str
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    tags Sequence[DirectConnectGatewayTagArgs]
    updated_time str
    Time when the Direct Connect Gateway was updated.
    accountId String
    ID of the account to which the Direct Connect Gateway belongs.
    associateCens List<Property Map>
    associateEic Property Map
    Associated EIC information.
    bgpAsn Number
    ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
    businessStatus String
    Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Time when the Direct Connect Gateway was created.
    deletedTime String
    Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    description String
    Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
    directConnectGatewayId String
    ID of the Direct Connect Gateway.
    directConnectGatewayName String
    Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
    enableIpv6 Boolean
    Whether IPv6 is supported. true: supported. false: not supported.
    lockReason String
    Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
    overdueTime String
    Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
    projectName String
    Project to which the Direct Connect Gateway belongs.
    status String
    Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
    tags List<Property Map>
    updatedTime String
    Time when the Direct Connect Gateway was updated.

    Supporting Types

    DirectConnectGatewayAssociateCen, DirectConnectGatewayAssociateCenArgs

    CenId string
    ID of CEN.
    CenOwnerId string
    User ID of CEN.
    CenStatus string
    Status of the instance in CEN. Attaching: attaching. Attached: attached.
    CenId string
    ID of CEN.
    CenOwnerId string
    User ID of CEN.
    CenStatus string
    Status of the instance in CEN. Attaching: attaching. Attached: attached.
    cenId String
    ID of CEN.
    cenOwnerId String
    User ID of CEN.
    cenStatus String
    Status of the instance in CEN. Attaching: attaching. Attached: attached.
    cenId string
    ID of CEN.
    cenOwnerId string
    User ID of CEN.
    cenStatus string
    Status of the instance in CEN. Attaching: attaching. Attached: attached.
    cen_id str
    ID of CEN.
    cen_owner_id str
    User ID of CEN.
    cen_status str
    Status of the instance in CEN. Attaching: attaching. Attached: attached.
    cenId String
    ID of CEN.
    cenOwnerId String
    User ID of CEN.
    cenStatus String
    Status of the instance in CEN. Attaching: attaching. Attached: attached.

    DirectConnectGatewayAssociateEic, DirectConnectGatewayAssociateEicArgs

    EicId string
    ID of EIC.
    EicOwnerId string
    User ID of EIC.
    EicStatus string
    Status of the instance in EIC.
    EicId string
    ID of EIC.
    EicOwnerId string
    User ID of EIC.
    EicStatus string
    Status of the instance in EIC.
    eicId String
    ID of EIC.
    eicOwnerId String
    User ID of EIC.
    eicStatus String
    Status of the instance in EIC.
    eicId string
    ID of EIC.
    eicOwnerId string
    User ID of EIC.
    eicStatus string
    Status of the instance in EIC.
    eic_id str
    ID of EIC.
    eic_owner_id str
    User ID of EIC.
    eic_status str
    Status of the instance in EIC.
    eicId String
    ID of EIC.
    eicOwnerId String
    User ID of EIC.
    eicStatus String
    Status of the instance in EIC.

    DirectConnectGatewayTag, DirectConnectGatewayTagArgs

    Key string
    User label tag key. Length must be between 1 and 128 characters.
    Value string
    User label tag value. Length must be between 0 and 256 characters.
    Key string
    User label tag key. Length must be between 1 and 128 characters.
    Value string
    User label tag value. Length must be between 0 and 256 characters.
    key String
    User label tag key. Length must be between 1 and 128 characters.
    value String
    User label tag value. Length must be between 0 and 256 characters.
    key string
    User label tag key. Length must be between 1 and 128 characters.
    value string
    User label tag value. Length must be between 0 and 256 characters.
    key str
    User label tag key. Length must be between 1 and 128 characters.
    value str
    User label tag value. Length must be between 0 and 256 characters.
    key String
    User label tag key. Length must be between 1 and 128 characters.
    value String
    User label tag value. Length must be between 0 and 256 characters.

    Import

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