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

volcenginecc.vpn.CustomerGateway

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

    The user gateway is a collection and abstraction of information on your local gateway side. With the user gateway, you can register local gateway information to the cloud VPC. One user gateway can connect to multiple VPN gateways

    Example Usage

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

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

    import pulumi
import pulumi_volcenginecc as volcenginecc

vpncustomergateway_demo = volcenginecc.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/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpn"
)

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 Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var vpncustomergatewayDemo = new Volcenginecc.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.volcengine.volcenginecc.vpn.CustomerGateway;
import com.volcengine.volcenginecc.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: volcenginecc: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: volcenginecc: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.

    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
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Tags List<Volcengine.CustomerGatewayTag>
    IpAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Tags []CustomerGatewayTagArgs
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    asn Integer
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    tags List<CustomerGatewayTag>
    ipAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    asn number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    customerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    tags CustomerGatewayTag[]
    ip_address str
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    customer_gateway_name str
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description str
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ip_version str
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    project_name str
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    tags Sequence[CustomerGatewayTagArgs]
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    asn Number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    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 of the account to which the user gateway belongs
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    UpdatedTime string
    Time when the user gateway was updated
    AccountId string
    ID of the account to which the user gateway belongs
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    UpdatedTime string
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    connectionCount Integer
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    updatedTime String
    Time when the user gateway was updated
    accountId string
    ID of the account to which the user gateway belongs
    connectionCount number
    Number of IPsec connections associated with the user gateway
    createdTime string
    Time when the user gateway was created
    customerGatewayId string
    Gateway ID
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    updatedTime string
    Time when the user gateway was updated
    account_id str
    ID of the account to which the user gateway belongs
    connection_count int
    Number of IPsec connections associated with the user gateway
    created_time str
    Time when the user gateway was created
    customer_gateway_id str
    Gateway ID
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    updated_time str
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    connectionCount Number
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    updatedTime String
    Time when the user gateway was updated

    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: volcenginecc: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 of the account to which the user gateway belongs
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    IpAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Volcengine.CustomerGatewayTag>
    UpdatedTime string
    Time when the user gateway was updated
    AccountId string
    ID of the account to which the user gateway belongs
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    IpAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []CustomerGatewayTagArgs
    UpdatedTime string
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    asn Integer
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount Integer
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<CustomerGatewayTag>
    updatedTime String
    Time when the user gateway was updated
    accountId string
    ID of the account to which the user gateway belongs
    asn number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount number
    Number of IPsec connections associated with the user gateway
    createdTime string
    Time when the user gateway was created
    customerGatewayId string
    Gateway ID
    customerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description string
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags CustomerGatewayTag[]
    updatedTime string
    Time when the user gateway was updated
    account_id str
    ID of the account to which the user gateway belongs
    asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connection_count int
    Number of IPsec connections associated with the user gateway
    created_time str
    Time when the user gateway was created
    customer_gateway_id str
    Gateway ID
    customer_gateway_name str
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description str
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ip_address str
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ip_version str
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    project_name str
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status str
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[CustomerGatewayTagArgs]
    updated_time str
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    asn Number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount Number
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user 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 must be between 0 and 255 characters. If not specified, defaults to an empty string
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    updatedTime String
    Time when the user gateway was updated

    Supporting Types

    CustomerGatewayTag, CustomerGatewayTagArgs

    Key string
    Tag key for user tag
    Value string
    Tag value for user tag
    Key string
    Tag key for user tag
    Value string
    Tag value for user tag
    key String
    Tag key for user tag
    value String
    Tag value for user tag
    key string
    Tag key for user tag
    value string
    Tag value for user tag
    key str
    Tag key for user tag
    value str
    Tag value for user tag
    key String
    Tag key for user tag
    value String
    Tag value for user tag

    Import

    $ pulumi import volcenginecc:vpn/customerGateway:CustomerGateway example "customer_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.