1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. vpn
  5. CustomerGateway
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vpn.CustomerGateway

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    用户网关是您本地网关侧的信息集合和抽象。通过用户网关，您可以把本地网关的信息注册到云上VPC之中。一个用户网关，可以对接多个VPN网关。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const vpncustomergatewayDemo = new bytepluscc.vpn.CustomerGateway("vpncustomergatewayDemo", {
    asn: 64513,
    customerGatewayName: "ccapi-test",
    description: "testdesc",
    ipAddress: "115.***.151.5",
    ipVersion: "ipv4",
    projectName: "default",
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

vpncustomergateway_demo = bytepluscc.vpn.CustomerGateway("vpncustomergatewayDemo",
    asn=64513,
    customer_gateway_name="ccapi-test",
    description="testdesc",
    ip_address="115.***.151.5",
    ip_version="ipv4",
    project_name="default")

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/vpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.NewCustomerGateway(ctx, "vpncustomergatewayDemo", &vpn.CustomerGatewayArgs{
			Asn:                 pulumi.Int(64513),
			CustomerGatewayName: pulumi.String("ccapi-test"),
			Description:         pulumi.String("testdesc"),
			IpAddress:           pulumi.String("115.***.151.5"),
			IpVersion:           pulumi.String("ipv4"),
			ProjectName:         pulumi.String("default"),
		})
		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 vpncustomergatewayDemo = new Bytepluscc.Vpn.CustomerGateway("vpncustomergatewayDemo", new()
    {
        Asn = 64513,
        CustomerGatewayName = "ccapi-test",
        Description = "testdesc",
        IpAddress = "115.***.151.5",
        IpVersion = "ipv4",
        ProjectName = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.vpn.CustomerGateway;
import com.byteplus.bytepluscc.vpn.CustomerGatewayArgs;
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 vpncustomergatewayDemo = new CustomerGateway("vpncustomergatewayDemo", CustomerGatewayArgs.builder()
            .asn(64513)
            .customerGatewayName("ccapi-test")
            .description("testdesc")
            .ipAddress("115.***.151.5")
            .ipVersion("ipv4")
            .projectName("default")
            .build());

    }
}

    resources:
  vpncustomergatewayDemo:
    type: bytepluscc:vpn:CustomerGateway
    properties:
      asn: 64513
      customerGatewayName: ccapi-test
      description: testdesc
      ipAddress: 115.***.151.5
      ipVersion: ipv4
      projectName: default

    Create CustomerGateway Resource

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

    Constructor syntax

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

@overload
def CustomerGateway(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    ip_address: Optional[str] = None,
                    asn: Optional[int] = None,
                    customer_gateway_name: Optional[str] = None,
                    description: Optional[str] = None,
                    ip_version: Optional[str] = None,
                    project_name: Optional[str] = None,
                    tags: Optional[Sequence[CustomerGatewayTagArgs]] = None)
    func NewCustomerGateway(ctx *Context, name string, args CustomerGatewayArgs, opts ...ResourceOption) (*CustomerGateway, error)
    public CustomerGateway(string name, CustomerGatewayArgs args, CustomResourceOptions? opts = null)
    public CustomerGateway(String name, CustomerGatewayArgs args)
public CustomerGateway(String name, CustomerGatewayArgs args, CustomResourceOptions options)

    type: bytepluscc:vpn:CustomerGateway
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 CustomerGatewayArgs
    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 CustomerGatewayArgs
    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 CustomerGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomerGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomerGatewayArgs
    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 customerGatewayResource = new Bytepluscc.Vpn.CustomerGateway("customerGatewayResource", new()
{
    IpAddress = "string",
    Asn = 0,
    CustomerGatewayName = "string",
    Description = "string",
    IpVersion = "string",
    ProjectName = "string",
    Tags = new[]
    {
        new Bytepluscc.Vpn.Inputs.CustomerGatewayTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := vpn.NewCustomerGateway(ctx, "customerGatewayResource", &vpn.CustomerGatewayArgs{
	IpAddress:           pulumi.String("string"),
	Asn:                 pulumi.Int(0),
	CustomerGatewayName: pulumi.String("string"),
	Description:         pulumi.String("string"),
	IpVersion:           pulumi.String("string"),
	ProjectName:         pulumi.String("string"),
	Tags: vpn.CustomerGatewayTagArray{
		&vpn.CustomerGatewayTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var customerGatewayResource = new CustomerGateway("customerGatewayResource", CustomerGatewayArgs.builder()
    .ipAddress("string")
    .asn(0)
    .customerGatewayName("string")
    .description("string")
    .ipVersion("string")
    .projectName("string")
    .tags(CustomerGatewayTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    customer_gateway_resource = bytepluscc.vpn.CustomerGateway("customerGatewayResource",
    ip_address="string",
    asn=0,
    customer_gateway_name="string",
    description="string",
    ip_version="string",
    project_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const customerGatewayResource = new bytepluscc.vpn.CustomerGateway("customerGatewayResource", {
    ipAddress: "string",
    asn: 0,
    customerGatewayName: "string",
    description: "string",
    ipVersion: "string",
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: bytepluscc:vpn:CustomerGateway
properties:
    asn: 0
    customerGatewayName: string
    description: string
    ipAddress: string
    ipVersion: string
    projectName: string
    tags:
        - key: string
          value: string

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

    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Tags List<Byteplus.CustomerGatewayTag>
    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Tags []CustomerGatewayTagArgs
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    asn Integer
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    tags List<CustomerGatewayTag>
    ipAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    asn number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    customerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    tags CustomerGatewayTag[]
    ip_address str
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    customer_gateway_name str
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description str
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ip_version str
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    project_name str
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    tags Sequence[CustomerGatewayTagArgs]
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    asn Number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    tags List<Property Map>

    Outputs

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

    AccountId string
    用户网关所属账户的ID。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    UpdatedTime string
    更新用户网关的时间。
    AccountId string
    用户网关所属账户的ID。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    UpdatedTime string
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    connectionCount Integer
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    updatedTime String
    更新用户网关的时间。
    accountId string
    用户网关所属账户的ID。
    connectionCount number
    用户网关关联的IPsec连接的数量。
    createdTime string
    创建用户网关的时间。
    customerGatewayId string
    网关ID。
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    updatedTime string
    更新用户网关的时间。
    account_id str
    用户网关所属账户的ID。
    connection_count int
    用户网关关联的IPsec连接的数量。
    created_time str
    创建用户网关的时间。
    customer_gateway_id str
    网关ID。
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    updated_time str
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    connectionCount Number
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    updatedTime String
    更新用户网关的时间。

    Look up Existing CustomerGateway Resource

    Get an existing CustomerGateway 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?: CustomerGatewayState, opts?: CustomResourceOptions): CustomerGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        asn: Optional[int] = None,
        connection_count: Optional[int] = None,
        created_time: Optional[str] = None,
        customer_gateway_id: Optional[str] = None,
        customer_gateway_name: Optional[str] = None,
        description: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_version: Optional[str] = None,
        project_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[CustomerGatewayTagArgs]] = None,
        updated_time: Optional[str] = None) -> CustomerGateway
    func GetCustomerGateway(ctx *Context, name string, id IDInput, state *CustomerGatewayState, opts ...ResourceOption) (*CustomerGateway, error)
    public static CustomerGateway Get(string name, Input<string> id, CustomerGatewayState? state, CustomResourceOptions? opts = null)
    public static CustomerGateway get(String name, Output<String> id, CustomerGatewayState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:vpn:CustomerGateway    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。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    Tags List<Byteplus.CustomerGatewayTag>
    UpdatedTime string
    更新用户网关的时间。
    AccountId string
    用户网关所属账户的ID。
    Asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    ConnectionCount int
    用户网关关联的IPsec连接的数量。
    CreatedTime string
    创建用户网关的时间。
    CustomerGatewayId string
    网关ID。
    CustomerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    Description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    IpAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    IpVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    ProjectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    Status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    Tags []CustomerGatewayTagArgs
    UpdatedTime string
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    asn Integer
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount Integer
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags List<CustomerGatewayTag>
    updatedTime String
    更新用户网关的时间。
    accountId string
    用户网关所属账户的ID。
    asn number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount number
    用户网关关联的IPsec连接的数量。
    createdTime string
    创建用户网关的时间。
    customerGatewayId string
    网关ID。
    customerGatewayName string
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description string
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipAddress string
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion string
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName string
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status string
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags CustomerGatewayTag[]
    updatedTime string
    更新用户网关的时间。
    account_id str
    用户网关所属账户的ID。
    asn int
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connection_count int
    用户网关关联的IPsec连接的数量。
    created_time str
    创建用户网关的时间。
    customer_gateway_id str
    网关ID。
    customer_gateway_name str
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description str
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ip_address str
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ip_version str
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    project_name str
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status str
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags Sequence[CustomerGatewayTagArgs]
    updated_time str
    更新用户网关的时间。
    accountId String
    用户网关所属账户的ID。
    asn Number
    用户网关的ASN（Autonomous System Number）。如需使用BGP功能，则此参数必须填写。ASN有效范围1～4294967295（137718 、150436、65533除外）。
    connectionCount Number
    用户网关关联的IPsec连接的数量。
    createdTime String
    创建用户网关的时间。
    customerGatewayId String
    网关ID。
    customerGatewayName String
    用户网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。长度限制为1 ~ 128个字符。不填默认为用户网关的ID。
    description String
    用户网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填默认为空字符串。
    ipAddress String
    对端本地数据中心网关的静态公网IP地址或其他VPC的VPN网关出口IP地址。若对端为非固定静态公网IP，此处需传入0.0.0.0。
    ipVersion String
    VPN网关的IP地址协议类型，取值如下：ipv4 （默认值）ipv6
    projectName String
    用户网关所属的项目。不填默认为default，即创建的资源属于default项目。
    status String
    用户网关的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
    tags List<Property Map>
    updatedTime String
    更新用户网关的时间。

    Supporting Types

    CustomerGatewayTag, CustomerGatewayTagArgs

    Key string
    用户标签的标签键。
    Value string
    用户标签的标签值。
    Key string
    用户标签的标签键。
    Value string
    用户标签的标签值。
    key String
    用户标签的标签键。
    value String
    用户标签的标签值。
    key string
    用户标签的标签键。
    value string
    用户标签的标签值。
    key str
    用户标签的标签键。
    value str
    用户标签的标签值。
    key String
    用户标签的标签键。
    value String
    用户标签的标签值。

    Import

    $ pulumi import bytepluscc:vpn/customerGateway:CustomerGateway example "customer_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
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.