1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. directconnect
  5. DirectConnectGateway
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus

    专线网关是本地数据中心访问云上的入口,用于连接私有网络(VPC)与物理专线,实现云下数据中心(IDC)和云上私有网络(VPC)互访。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
    
    const directConnectDirectConnectGatewayDemo = new bytepluscc.directconnect.DirectConnectGateway("DirectConnectDirectConnectGatewayDemo", {
        description: "DirectConnectDirectConnectGatewayDemo-Description",
        directConnectGatewayName: "DirectConnectDirectConnectGatewayDemo",
        enableIpv6: false,
        projectName: "default",
        tags: [{
            key: "env",
            value: "test",
        }],
    });
    
    import pulumi
    import pulumi_bytepluscc as bytepluscc
    
    direct_connect_direct_connect_gateway_demo = bytepluscc.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/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/directconnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    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 Bytepluscc = Byteplus.Pulumi.Bytepluscc;
    
    return await Deployment.RunAsync(() => 
    {
        var directConnectDirectConnectGatewayDemo = new Bytepluscc.Directconnect.DirectConnectGateway("DirectConnectDirectConnectGatewayDemo", new()
        {
            Description = "DirectConnectDirectConnectGatewayDemo-Description",
            DirectConnectGatewayName = "DirectConnectDirectConnectGatewayDemo",
            EnableIpv6 = false,
            ProjectName = "default",
            Tags = new[]
            {
                new Bytepluscc.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.byteplus.bytepluscc.directconnect.DirectConnectGateway;
    import com.byteplus.bytepluscc.directconnect.DirectConnectGatewayArgs;
    import com.pulumi.bytepluscc.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: bytepluscc: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: bytepluscc: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var directConnectGatewayResource = new Bytepluscc.Directconnect.DirectConnectGateway("directConnectGatewayResource", new()
    {
        BgpAsn = 0,
        Description = "string",
        DirectConnectGatewayName = "string",
        EnableIpv6 = false,
        ProjectName = "string",
        Tags = new[]
        {
            new Bytepluscc.Directconnect.Inputs.DirectConnectGatewayTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    });
    
    example, err := directconnect.NewDirectConnectGateway(ctx, "directConnectGatewayResource", &directconnect.DirectConnectGatewayArgs{
    	BgpAsn:                   pulumi.Int(0),
    	Description:              pulumi.String("string"),
    	DirectConnectGatewayName: pulumi.String("string"),
    	EnableIpv6:               pulumi.Bool(false),
    	ProjectName:              pulumi.String("string"),
    	Tags: directconnect.DirectConnectGatewayTagArray{
    		&directconnect.DirectConnectGatewayTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    var directConnectGatewayResource = new DirectConnectGateway("directConnectGatewayResource", DirectConnectGatewayArgs.builder()
        .bgpAsn(0)
        .description("string")
        .directConnectGatewayName("string")
        .enableIpv6(false)
        .projectName("string")
        .tags(DirectConnectGatewayTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build());
    
    direct_connect_gateway_resource = bytepluscc.directconnect.DirectConnectGateway("directConnectGatewayResource",
        bgp_asn=0,
        description="string",
        direct_connect_gateway_name="string",
        enable_ipv6=False,
        project_name="string",
        tags=[{
            "key": "string",
            "value": "string",
        }])
    
    const directConnectGatewayResource = new bytepluscc.directconnect.DirectConnectGateway("directConnectGatewayResource", {
        bgpAsn: 0,
        description: "string",
        directConnectGatewayName: "string",
        enableIpv6: false,
        projectName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    type: bytepluscc:directconnect:DirectConnectGateway
    properties:
        bgpAsn: 0
        description: string
        directConnectGatewayName: string
        enableIpv6: false
        projectName: string
        tags:
            - key: string
              value: string
    

    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)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    Description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    DirectConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    EnableIpv6 bool
    是否支持IPv6。true:支持。false:不支持。
    ProjectName string
    专线网关所属的项目。
    Tags List<Byteplus.DirectConnectGatewayTag>
    BgpAsn int
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    Description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    DirectConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    EnableIpv6 bool
    是否支持IPv6。true:支持。false:不支持。
    ProjectName string
    专线网关所属的项目。
    Tags []DirectConnectGatewayTagArgs
    bgpAsn Integer
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    description String
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayName String
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 Boolean
    是否支持IPv6。true:支持。false:不支持。
    projectName String
    专线网关所属的项目。
    tags List<DirectConnectGatewayTag>
    bgpAsn number
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 boolean
    是否支持IPv6。true:支持。false:不支持。
    projectName string
    专线网关所属的项目。
    tags DirectConnectGatewayTag[]
    bgp_asn int
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    description str
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    direct_connect_gateway_name str
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enable_ipv6 bool
    是否支持IPv6。true:支持。false:不支持。
    project_name str
    专线网关所属的项目。
    tags Sequence[DirectConnectGatewayTagArgs]
    bgpAsn Number
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    description String
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayName String
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 Boolean
    是否支持IPv6。true:支持。false:不支持。
    projectName String
    专线网关所属的项目。
    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。
    AssociateCens List<Byteplus.DirectConnectGatewayAssociateCen>
    BusinessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    CreatedTime string
    创建专线网关的时间。
    DeletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    DirectConnectGatewayId string
    专线网关的ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    Status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    UpdatedTime string
    更新专线网关的时间。
    AccountId string
    专线网关所属账号的ID。
    AssociateCens []DirectConnectGatewayAssociateCen
    BusinessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    CreatedTime string
    创建专线网关的时间。
    DeletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    DirectConnectGatewayId string
    专线网关的ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    Status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    UpdatedTime string
    更新专线网关的时间。
    accountId String
    专线网关所属账号的ID。
    associateCens List<DirectConnectGatewayAssociateCen>
    businessStatus String
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime String
    创建专线网关的时间。
    deletedTime String
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    directConnectGatewayId String
    专线网关的ID。
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    status String
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    updatedTime String
    更新专线网关的时间。
    accountId string
    专线网关所属账号的ID。
    associateCens DirectConnectGatewayAssociateCen[]
    businessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime string
    创建专线网关的时间。
    deletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    directConnectGatewayId string
    专线网关的ID。
    id string
    The provider-assigned unique ID for this managed resource.
    lockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    updatedTime string
    更新专线网关的时间。
    account_id str
    专线网关所属账号的ID。
    associate_cens Sequence[DirectConnectGatewayAssociateCen]
    business_status str
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    created_time str
    创建专线网关的时间。
    deleted_time str
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    direct_connect_gateway_id str
    专线网关的ID。
    id str
    The provider-assigned unique ID for this managed resource.
    lock_reason str
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdue_time str
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    status str
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    updated_time str
    更新专线网关的时间。
    accountId String
    专线网关所属账号的ID。
    associateCens List<Property Map>
    businessStatus String
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime String
    创建专线网关的时间。
    deletedTime String
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    directConnectGatewayId String
    专线网关的ID。
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    status String
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    updatedTime String
    更新专线网关的时间。

    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,
            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: bytepluscc: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。
    AssociateCens List<Byteplus.DirectConnectGatewayAssociateCen>
    BgpAsn int
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    BusinessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    CreatedTime string
    创建专线网关的时间。
    DeletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    Description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    DirectConnectGatewayId string
    专线网关的ID。
    DirectConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    EnableIpv6 bool
    是否支持IPv6。true:支持。false:不支持。
    LockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    ProjectName string
    专线网关所属的项目。
    Status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    Tags List<Byteplus.DirectConnectGatewayTag>
    UpdatedTime string
    更新专线网关的时间。
    AccountId string
    专线网关所属账号的ID。
    AssociateCens []DirectConnectGatewayAssociateCenArgs
    BgpAsn int
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    BusinessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    CreatedTime string
    创建专线网关的时间。
    DeletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    Description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    DirectConnectGatewayId string
    专线网关的ID。
    DirectConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    EnableIpv6 bool
    是否支持IPv6。true:支持。false:不支持。
    LockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    ProjectName string
    专线网关所属的项目。
    Status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    Tags []DirectConnectGatewayTagArgs
    UpdatedTime string
    更新专线网关的时间。
    accountId String
    专线网关所属账号的ID。
    associateCens List<DirectConnectGatewayAssociateCen>
    bgpAsn Integer
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    businessStatus String
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime String
    创建专线网关的时间。
    deletedTime String
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    description String
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayId String
    专线网关的ID。
    directConnectGatewayName String
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 Boolean
    是否支持IPv6。true:支持。false:不支持。
    lockReason String
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    projectName String
    专线网关所属的项目。
    status String
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    tags List<DirectConnectGatewayTag>
    updatedTime String
    更新专线网关的时间。
    accountId string
    专线网关所属账号的ID。
    associateCens DirectConnectGatewayAssociateCen[]
    bgpAsn number
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    businessStatus string
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime string
    创建专线网关的时间。
    deletedTime string
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    description string
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayId string
    专线网关的ID。
    directConnectGatewayName string
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 boolean
    是否支持IPv6。true:支持。false:不支持。
    lockReason string
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    projectName string
    专线网关所属的项目。
    status string
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    tags DirectConnectGatewayTag[]
    updatedTime string
    更新专线网关的时间。
    account_id str
    专线网关所属账号的ID。
    associate_cens Sequence[DirectConnectGatewayAssociateCenArgs]
    bgp_asn int
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    business_status str
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    created_time str
    创建专线网关的时间。
    deleted_time str
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    description str
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    direct_connect_gateway_id str
    专线网关的ID。
    direct_connect_gateway_name str
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enable_ipv6 bool
    是否支持IPv6。true:支持。false:不支持。
    lock_reason str
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdue_time str
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    project_name str
    专线网关所属的项目。
    status str
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    tags Sequence[DirectConnectGatewayTagArgs]
    updated_time str
    更新专线网关的时间。
    accountId String
    专线网关所属账号的ID。
    associateCens List<Property Map>
    bgpAsn Number
    专线网关的ASN(Autonomous System Number)。专线网关ASN有效范围为:137718、64512 ~ 65534 、4200000000 ~ 4294967294,其中137718为火山引擎的ASN。如果专线网关仅在普通场景下使用(如本地IDC通过专线连接访问单个云上VPC资源),请使用火山引擎ASN(137718)。如果专线网关在特殊场景下使用(如单个IDC通过专线连接访问多个云企业网),每个专线网关均要自定义ASN且避免使用火山引擎ASN(137718),确保不同专线网关的ASN不重复。
    businessStatus String
    专线网关是否被锁定。Normal:正常。FinancialLocked:被锁定。
    createdTime String
    创建专线网关的时间。
    deletedTime String
    预期资源强制回收时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    description String
    专线网关的描述信息。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时,默认为空字符串。
    directConnectGatewayId String
    专线网关的ID。
    directConnectGatewayName String
    专线网关的名称。以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为专线网关的ID。
    enableIpv6 Boolean
    是否支持IPv6。true:支持。false:不支持。
    lockReason String
    专线网关被锁定的原因。unlock:解锁。financial:因欠费被锁定。security:因安全被锁定。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。
    projectName String
    专线网关所属的项目。
    status String
    专线网关的状态。Creating:创建中。Deleting:删除中。Pending:配置中。Available:可用。
    tags List<Property Map>
    updatedTime String
    更新专线网关的时间。

    Supporting Types

    DirectConnectGatewayAssociateCen, DirectConnectGatewayAssociateCenArgs

    CenId string
    CEN的ID。
    CenOwnerId string
    CEN的用户ID。
    CenStatus string
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。
    CenId string
    CEN的ID。
    CenOwnerId string
    CEN的用户ID。
    CenStatus string
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。
    cenId String
    CEN的ID。
    cenOwnerId String
    CEN的用户ID。
    cenStatus String
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。
    cenId string
    CEN的ID。
    cenOwnerId string
    CEN的用户ID。
    cenStatus string
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。
    cen_id str
    CEN的ID。
    cen_owner_id str
    CEN的用户ID。
    cen_status str
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。
    cenId String
    CEN的ID。
    cenOwnerId String
    CEN的用户ID。
    cenStatus String
    实例在CEN中的状态。Attaching:加载中。Attached:已加载。

    DirectConnectGatewayTag, DirectConnectGatewayTagArgs

    Key string
    用户标签的标签键。长度取值范围为1~128字符。
    Value string
    用户标签的标签值。长度取值范围为0~256字符。
    Key string
    用户标签的标签键。长度取值范围为1~128字符。
    Value string
    用户标签的标签值。长度取值范围为0~256字符。
    key String
    用户标签的标签键。长度取值范围为1~128字符。
    value String
    用户标签的标签值。长度取值范围为0~256字符。
    key string
    用户标签的标签键。长度取值范围为1~128字符。
    value string
    用户标签的标签值。长度取值范围为0~256字符。
    key str
    用户标签的标签键。长度取值范围为1~128字符。
    value str
    用户标签的标签值。长度取值范围为0~256字符。
    key String
    用户标签的标签键。长度取值范围为1~128字符。
    value String
    用户标签的标签值。长度取值范围为0~256字符。

    Import

    $ pulumi import bytepluscc:directconnect/directConnectGateway:DirectConnectGateway example "direct_connect_gateway_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
      Meet Neo: Your AI Platform Teammate