published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
To enable communication between your private network and a local data center or another private network via a VPN connection, you must first create a VPN gateway.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const vpnVpnGatewayDemo = new volcenginecc.vpn.VpnGateway("VpnVpnGatewayDemo", {
bandwidth: 5,
billingType: 2,
description: "this is a test description",
dualTunnelEnabled: false,
ipStackType: "ipv4_only",
ipVersion: "ipv4",
vpnGatewayName: "VpnVpnGatewayDemo",
ipsecEnabled: true,
sslEnabled: true,
sslMaxConnections: 5,
projectName: "default",
vpcId: "vpc-3nr6adxxxxu8931eb64y4z2",
subnetId: "subnet-btepcsxxxxw5h0b2u6hppyd",
});
import pulumi
import pulumi_volcenginecc as volcenginecc
vpn_vpn_gateway_demo = volcenginecc.vpn.VpnGateway("VpnVpnGatewayDemo",
bandwidth=5,
billing_type=2,
description="this is a test description",
dual_tunnel_enabled=False,
ip_stack_type="ipv4_only",
ip_version="ipv4",
vpn_gateway_name="VpnVpnGatewayDemo",
ipsec_enabled=True,
ssl_enabled=True,
ssl_max_connections=5,
project_name="default",
vpc_id="vpc-3nr6adxxxxu8931eb64y4z2",
subnet_id="subnet-btepcsxxxxw5h0b2u6hppyd")
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.NewVpnGateway(ctx, "VpnVpnGatewayDemo", &vpn.VpnGatewayArgs{
Bandwidth: pulumi.Int(5),
BillingType: pulumi.Int(2),
Description: pulumi.String("this is a test description"),
DualTunnelEnabled: pulumi.Bool(false),
IpStackType: pulumi.String("ipv4_only"),
IpVersion: pulumi.String("ipv4"),
VpnGatewayName: pulumi.String("VpnVpnGatewayDemo"),
IpsecEnabled: pulumi.Bool(true),
SslEnabled: pulumi.Bool(true),
SslMaxConnections: pulumi.Int(5),
ProjectName: pulumi.String("default"),
VpcId: pulumi.String("vpc-3nr6adxxxxu8931eb64y4z2"),
SubnetId: pulumi.String("subnet-btepcsxxxxw5h0b2u6hppyd"),
})
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 vpnVpnGatewayDemo = new Volcenginecc.Vpn.VpnGateway("VpnVpnGatewayDemo", new()
{
Bandwidth = 5,
BillingType = 2,
Description = "this is a test description",
DualTunnelEnabled = false,
IpStackType = "ipv4_only",
IpVersion = "ipv4",
VpnGatewayName = "VpnVpnGatewayDemo",
IpsecEnabled = true,
SslEnabled = true,
SslMaxConnections = 5,
ProjectName = "default",
VpcId = "vpc-3nr6adxxxxu8931eb64y4z2",
SubnetId = "subnet-btepcsxxxxw5h0b2u6hppyd",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vpn.VpnGateway;
import com.volcengine.volcenginecc.vpn.VpnGatewayArgs;
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 vpnVpnGatewayDemo = new VpnGateway("vpnVpnGatewayDemo", VpnGatewayArgs.builder()
.bandwidth(5)
.billingType(2)
.description("this is a test description")
.dualTunnelEnabled(false)
.ipStackType("ipv4_only")
.ipVersion("ipv4")
.vpnGatewayName("VpnVpnGatewayDemo")
.ipsecEnabled(true)
.sslEnabled(true)
.sslMaxConnections(5)
.projectName("default")
.vpcId("vpc-3nr6adxxxxu8931eb64y4z2")
.subnetId("subnet-btepcsxxxxw5h0b2u6hppyd")
.build());
}
}
resources:
vpnVpnGatewayDemo:
type: volcenginecc:vpn:VpnGateway
name: VpnVpnGatewayDemo
properties:
bandwidth: 5
billingType: 2
description: this is a test description
dualTunnelEnabled: false
ipStackType: ipv4_only
ipVersion: ipv4
vpnGatewayName: VpnVpnGatewayDemo
ipsecEnabled: true
sslEnabled: true
sslMaxConnections: 5
projectName: default
vpcId: vpc-3nr6adxxxxu8931eb64y4z2
subnetId: subnet-btepcsxxxxw5h0b2u6hppyd
Create VpnGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpnGateway(name: string, args: VpnGatewayArgs, opts?: CustomResourceOptions);@overload
def VpnGateway(resource_name: str,
args: VpnGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpnGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
subnet_id: Optional[str] = None,
bandwidth: Optional[int] = None,
vpc_id: Optional[str] = None,
period: Optional[int] = None,
project_name: Optional[str] = None,
ip_stack_type: Optional[str] = None,
ip_version: Optional[str] = None,
ipsec_enabled: Optional[bool] = None,
asn: Optional[int] = None,
period_unit: Optional[str] = None,
dual_tunnel_enabled: Optional[bool] = None,
secondary_subnet_id: Optional[str] = None,
ssl_enabled: Optional[bool] = None,
ssl_max_connections: Optional[int] = None,
description: Optional[str] = None,
tags: Optional[Sequence[VpnGatewayTagArgs]] = None,
billing_type: Optional[int] = None,
vpn_gateway_name: Optional[str] = None)func NewVpnGateway(ctx *Context, name string, args VpnGatewayArgs, opts ...ResourceOption) (*VpnGateway, error)public VpnGateway(string name, VpnGatewayArgs args, CustomResourceOptions? opts = null)
public VpnGateway(String name, VpnGatewayArgs args)
public VpnGateway(String name, VpnGatewayArgs args, CustomResourceOptions options)
type: volcenginecc:vpn:VpnGateway
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 VpnGatewayArgs
- 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 VpnGatewayArgs
- 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 VpnGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpnGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpnGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VpnGateway 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 VpnGateway resource accepts the following input properties:
- Bandwidth int
- VPN gateway bandwidth specification.
- Subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
- Vpc
Id string - VPC ID where the VPN gateway is located.
- Asn int
- ASN of the VPN gateway.
- Billing
Type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- Description string
- Description of the VPN gateway.
- Dual
Tunnel boolEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- Ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- Ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- Ipsec
Enabled bool - Enable IPSec feature. true: enabled false: disabled
- Period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- Period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- Project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- Secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Ssl
Enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- Ssl
Max intConnections - Maximum SSL connections for the VPN gateway.
-
List<Volcengine.
Vpn Gateway Tag> - Vpn
Gateway stringName - Name of the VPN gateway.
- Bandwidth int
- VPN gateway bandwidth specification.
- Subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
- Vpc
Id string - VPC ID where the VPN gateway is located.
- Asn int
- ASN of the VPN gateway.
- Billing
Type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- Description string
- Description of the VPN gateway.
- Dual
Tunnel boolEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- Ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- Ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- Ipsec
Enabled bool - Enable IPSec feature. true: enabled false: disabled
- Period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- Period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- Project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- Secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Ssl
Enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- Ssl
Max intConnections - Maximum SSL connections for the VPN gateway.
-
[]Vpn
Gateway Tag Args - Vpn
Gateway stringName - Name of the VPN gateway.
- bandwidth Integer
- VPN gateway bandwidth specification.
- subnet
Id String - ID of the subnet to which the port used by the VPN gateway belongs.
- vpc
Id String - VPC ID where the VPN gateway is located.
- asn Integer
- ASN of the VPN gateway.
- billing
Type Integer - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- description String
- Description of the VPN gateway.
- dual
Tunnel BooleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- ip
Stack StringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version String - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled Boolean - Enable IPSec feature. true: enabled false: disabled
- period Integer
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit String - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name String - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- secondary
Subnet StringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled Boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max IntegerConnections - Maximum SSL connections for the VPN gateway.
-
List<Vpn
Gateway Tag> - vpn
Gateway StringName - Name of the VPN gateway.
- bandwidth number
- VPN gateway bandwidth specification.
- subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
- vpc
Id string - VPC ID where the VPN gateway is located.
- asn number
- ASN of the VPN gateway.
- billing
Type number - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- description string
- Description of the VPN gateway.
- dual
Tunnel booleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled boolean - Enable IPSec feature. true: enabled false: disabled
- period number
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max numberConnections - Maximum SSL connections for the VPN gateway.
-
Vpn
Gateway Tag[] - vpn
Gateway stringName - Name of the VPN gateway.
- bandwidth int
- VPN gateway bandwidth specification.
- subnet_
id str - ID of the subnet to which the port used by the VPN gateway belongs.
- vpc_
id str - VPC ID where the VPN gateway is located.
- asn int
- ASN of the VPN gateway.
- billing_
type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- description str
- Description of the VPN gateway.
- dual_
tunnel_ boolenabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- ip_
stack_ strtype - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip_
version str - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec_
enabled bool - Enable IPSec feature. true: enabled false: disabled
- period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period_
unit str - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project_
name str - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- secondary_
subnet_ strid - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl_
enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- ssl_
max_ intconnections - Maximum SSL connections for the VPN gateway.
-
Sequence[Vpn
Gateway Tag Args] - vpn_
gateway_ strname - Name of the VPN gateway.
- bandwidth Number
- VPN gateway bandwidth specification.
- subnet
Id String - ID of the subnet to which the port used by the VPN gateway belongs.
- vpc
Id String - VPC ID where the VPN gateway is located.
- asn Number
- ASN of the VPN gateway.
- billing
Type Number - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- description String
- Description of the VPN gateway.
- dual
Tunnel BooleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- ip
Stack StringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version String - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled Boolean - Enable IPSec feature. true: enabled false: disabled
- period Number
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit String - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name String - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- secondary
Subnet StringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled Boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max NumberConnections - Maximum SSL connections for the VPN gateway.
- List<Property Map>
- vpn
Gateway StringName - Name of the VPN gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpnGateway resource produces the following output properties:
- Business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- Connection
Count int - Number of IPsec connections associated with the VPN gateway.
- Create
Time string - Time when the VPN gateway was created.
- Deleted
Time string - Expected resource forced reclaim time.
- Expired
Time string - VPN gateway expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - VPN gateway public IP address.
- Is
Blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- Lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- Overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- Route
Count int - Number of route entries for the VPN gateway.
- Secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- Update
Time string - VPN gateway update time.
- Vpn
Gateway stringId - ID of the VPN gateway.
- Business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- Connection
Count int - Number of IPsec connections associated with the VPN gateway.
- Create
Time string - Time when the VPN gateway was created.
- Deleted
Time string - Expected resource forced reclaim time.
- Expired
Time string - VPN gateway expiration time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - VPN gateway public IP address.
- Is
Blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- Lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- Overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- Route
Count int - Number of route entries for the VPN gateway.
- Secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- Update
Time string - VPN gateway update time.
- Vpn
Gateway stringId - ID of the VPN gateway.
- business
Status String - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count Integer - Number of IPsec connections associated with the VPN gateway.
- create
Time String - Time when the VPN gateway was created.
- deleted
Time String - Expected resource forced reclaim time.
- expired
Time String - VPN gateway expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - VPN gateway public IP address.
- is
Blocked Boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason String - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time String - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- route
Count Integer - Number of route entries for the VPN gateway.
- secondary
Ip StringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- status String
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- update
Time String - VPN gateway update time.
- vpn
Gateway StringId - ID of the VPN gateway.
- business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count number - Number of IPsec connections associated with the VPN gateway.
- create
Time string - Time when the VPN gateway was created.
- deleted
Time string - Expected resource forced reclaim time.
- expired
Time string - VPN gateway expiration time.
- id string
- The provider-assigned unique ID for this managed resource.
- ip
Address string - VPN gateway public IP address.
- is
Blocked boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- route
Count number - Number of route entries for the VPN gateway.
- secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- update
Time string - VPN gateway update time.
- vpn
Gateway stringId - ID of the VPN gateway.
- business_
status str - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection_
count int - Number of IPsec connections associated with the VPN gateway.
- create_
time str - Time when the VPN gateway was created.
- deleted_
time str - Expected resource forced reclaim time.
- expired_
time str - VPN gateway expiration time.
- id str
- The provider-assigned unique ID for this managed resource.
- ip_
address str - VPN gateway public IP address.
- is_
blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- lock_
reason str - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue_
time str - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- route_
count int - Number of route entries for the VPN gateway.
- secondary_
ip_ straddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- status str
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- update_
time str - VPN gateway update time.
- vpn_
gateway_ strid - ID of the VPN gateway.
- business
Status String - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count Number - Number of IPsec connections associated with the VPN gateway.
- create
Time String - Time when the VPN gateway was created.
- deleted
Time String - Expected resource forced reclaim time.
- expired
Time String - VPN gateway expiration time.
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - VPN gateway public IP address.
- is
Blocked Boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason String - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time String - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- route
Count Number - Number of route entries for the VPN gateway.
- secondary
Ip StringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- status String
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- update
Time String - VPN gateway update time.
- vpn
Gateway StringId - ID of the VPN gateway.
Look up Existing VpnGateway Resource
Get an existing VpnGateway 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?: VpnGatewayState, opts?: CustomResourceOptions): VpnGateway@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
asn: Optional[int] = None,
bandwidth: Optional[int] = None,
billing_type: Optional[int] = None,
business_status: Optional[str] = None,
connection_count: Optional[int] = None,
create_time: Optional[str] = None,
deleted_time: Optional[str] = None,
description: Optional[str] = None,
dual_tunnel_enabled: Optional[bool] = None,
expired_time: Optional[str] = None,
ip_address: Optional[str] = None,
ip_stack_type: Optional[str] = None,
ip_version: Optional[str] = None,
ipsec_enabled: Optional[bool] = None,
is_blocked: Optional[bool] = None,
lock_reason: Optional[str] = None,
overdue_time: Optional[str] = None,
period: Optional[int] = None,
period_unit: Optional[str] = None,
project_name: Optional[str] = None,
route_count: Optional[int] = None,
secondary_ip_address: Optional[str] = None,
secondary_subnet_id: Optional[str] = None,
ssl_enabled: Optional[bool] = None,
ssl_max_connections: Optional[int] = None,
status: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[VpnGatewayTagArgs]] = None,
update_time: Optional[str] = None,
vpc_id: Optional[str] = None,
vpn_gateway_id: Optional[str] = None,
vpn_gateway_name: Optional[str] = None) -> VpnGatewayfunc GetVpnGateway(ctx *Context, name string, id IDInput, state *VpnGatewayState, opts ...ResourceOption) (*VpnGateway, error)public static VpnGateway Get(string name, Input<string> id, VpnGatewayState? state, CustomResourceOptions? opts = null)public static VpnGateway get(String name, Output<String> id, VpnGatewayState state, CustomResourceOptions options)resources: _: type: volcenginecc:vpn:VpnGateway 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.
- Asn int
- ASN of the VPN gateway.
- Bandwidth int
- VPN gateway bandwidth specification.
- Billing
Type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- Business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- Connection
Count int - Number of IPsec connections associated with the VPN gateway.
- Create
Time string - Time when the VPN gateway was created.
- Deleted
Time string - Expected resource forced reclaim time.
- Description string
- Description of the VPN gateway.
- Dual
Tunnel boolEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- Expired
Time string - VPN gateway expiration time.
- Ip
Address string - VPN gateway public IP address.
- Ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- Ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- Ipsec
Enabled bool - Enable IPSec feature. true: enabled false: disabled
- Is
Blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- Lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- Overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- Period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- Period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- Project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- Route
Count int - Number of route entries for the VPN gateway.
- Secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Ssl
Enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- Ssl
Max intConnections - Maximum SSL connections for the VPN gateway.
- Status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- Subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
-
List<Volcengine.
Vpn Gateway Tag> - Update
Time string - VPN gateway update time.
- Vpc
Id string - VPC ID where the VPN gateway is located.
- Vpn
Gateway stringId - ID of the VPN gateway.
- Vpn
Gateway stringName - Name of the VPN gateway.
- Asn int
- ASN of the VPN gateway.
- Bandwidth int
- VPN gateway bandwidth specification.
- Billing
Type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- Business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- Connection
Count int - Number of IPsec connections associated with the VPN gateway.
- Create
Time string - Time when the VPN gateway was created.
- Deleted
Time string - Expected resource forced reclaim time.
- Description string
- Description of the VPN gateway.
- Dual
Tunnel boolEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- Expired
Time string - VPN gateway expiration time.
- Ip
Address string - VPN gateway public IP address.
- Ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- Ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- Ipsec
Enabled bool - Enable IPSec feature. true: enabled false: disabled
- Is
Blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- Lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- Overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- Period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- Period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- Project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- Route
Count int - Number of route entries for the VPN gateway.
- Secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- Ssl
Enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- Ssl
Max intConnections - Maximum SSL connections for the VPN gateway.
- Status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- Subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
-
[]Vpn
Gateway Tag Args - Update
Time string - VPN gateway update time.
- Vpc
Id string - VPC ID where the VPN gateway is located.
- Vpn
Gateway stringId - ID of the VPN gateway.
- Vpn
Gateway stringName - Name of the VPN gateway.
- asn Integer
- ASN of the VPN gateway.
- bandwidth Integer
- VPN gateway bandwidth specification.
- billing
Type Integer - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- business
Status String - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count Integer - Number of IPsec connections associated with the VPN gateway.
- create
Time String - Time when the VPN gateway was created.
- deleted
Time String - Expected resource forced reclaim time.
- description String
- Description of the VPN gateway.
- dual
Tunnel BooleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- expired
Time String - VPN gateway expiration time.
- ip
Address String - VPN gateway public IP address.
- ip
Stack StringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version String - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled Boolean - Enable IPSec feature. true: enabled false: disabled
- is
Blocked Boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason String - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time String - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- period Integer
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit String - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name String - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- route
Count Integer - Number of route entries for the VPN gateway.
- secondary
Ip StringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- secondary
Subnet StringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled Boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max IntegerConnections - Maximum SSL connections for the VPN gateway.
- status String
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- subnet
Id String - ID of the subnet to which the port used by the VPN gateway belongs.
-
List<Vpn
Gateway Tag> - update
Time String - VPN gateway update time.
- vpc
Id String - VPC ID where the VPN gateway is located.
- vpn
Gateway StringId - ID of the VPN gateway.
- vpn
Gateway StringName - Name of the VPN gateway.
- asn number
- ASN of the VPN gateway.
- bandwidth number
- VPN gateway bandwidth specification.
- billing
Type number - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- business
Status string - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count number - Number of IPsec connections associated with the VPN gateway.
- create
Time string - Time when the VPN gateway was created.
- deleted
Time string - Expected resource forced reclaim time.
- description string
- Description of the VPN gateway.
- dual
Tunnel booleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- expired
Time string - VPN gateway expiration time.
- ip
Address string - VPN gateway public IP address.
- ip
Stack stringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version string - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled boolean - Enable IPSec feature. true: enabled false: disabled
- is
Blocked boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason string - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time string - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- period number
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit string - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name string - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- route
Count number - Number of route entries for the VPN gateway.
- secondary
Ip stringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- secondary
Subnet stringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max numberConnections - Maximum SSL connections for the VPN gateway.
- status string
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- subnet
Id string - ID of the subnet to which the port used by the VPN gateway belongs.
-
Vpn
Gateway Tag[] - update
Time string - VPN gateway update time.
- vpc
Id string - VPC ID where the VPN gateway is located.
- vpn
Gateway stringId - ID of the VPN gateway.
- vpn
Gateway stringName - Name of the VPN gateway.
- asn int
- ASN of the VPN gateway.
- bandwidth int
- VPN gateway bandwidth specification.
- billing_
type int - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- business_
status str - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection_
count int - Number of IPsec connections associated with the VPN gateway.
- create_
time str - Time when the VPN gateway was created.
- deleted_
time str - Expected resource forced reclaim time.
- description str
- Description of the VPN gateway.
- dual_
tunnel_ boolenabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- expired_
time str - VPN gateway expiration time.
- ip_
address str - VPN gateway public IP address.
- ip_
stack_ strtype - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip_
version str - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec_
enabled bool - Enable IPSec feature. true: enabled false: disabled
- is_
blocked bool - Whether the current resource is banned. true: Banned false: Not banned.
- lock_
reason str - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue_
time str - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- period int
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period_
unit str - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project_
name str - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- route_
count int - Number of route entries for the VPN gateway.
- secondary_
ip_ straddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- secondary_
subnet_ strid - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl_
enabled bool - Enable SSL VPN feature. true: enabled false: disabled
- ssl_
max_ intconnections - Maximum SSL connections for the VPN gateway.
- status str
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- subnet_
id str - ID of the subnet to which the port used by the VPN gateway belongs.
-
Sequence[Vpn
Gateway Tag Args] - update_
time str - VPN gateway update time.
- vpc_
id str - VPC ID where the VPN gateway is located.
- vpn_
gateway_ strid - ID of the VPN gateway.
- vpn_
gateway_ strname - Name of the VPN gateway.
- asn Number
- ASN of the VPN gateway.
- bandwidth Number
- VPN gateway bandwidth specification.
- billing
Type Number - VPN gateway billing type. 1: Subscription. 2: Pay-as-you-go (fixed specification)
- business
Status String - VPN gateway billing status. Normal: Normal. FinancialLocked: Locked.
- connection
Count Number - Number of IPsec connections associated with the VPN gateway.
- create
Time String - Time when the VPN gateway was created.
- deleted
Time String - Expected resource forced reclaim time.
- description String
- Description of the VPN gateway.
- dual
Tunnel BooleanEnabled - Whether dual tunnel mode is enabled for the VPN gateway. true: Enabled false: Disabled
- expired
Time String - VPN gateway expiration time.
- ip
Address String - VPN gateway public IP address.
- ip
Stack StringType - VPN gateway protocol type. ipv4only: IPv4 protocol type. ipv6only: IPv6 protocol type. ipv4_ipv6: Dual-stack protocol type.
- ip
Version String - IP address type of the VPN gateway. ipv4: IPv4 address type. ipv6: IPv6 address type.
- ipsec
Enabled Boolean - Enable IPSec feature. true: enabled false: disabled
- is
Blocked Boolean - Whether the current resource is banned. true: Banned false: Not banned.
- lock
Reason String - VPN gateway lock reasons. financial: Locked due to overdue payment. security: Locked for security reasons. unlock: Not locked.
- overdue
Time String - Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns an empty value.
- period Number
- Subscription VPN gateway purchase duration, default is '1'. If PeriodUnit is Month, Period value range: 1–9, 12, 24, 36. If PeriodUnit is Year, Period value range: 1–3.
- period
Unit String - Unit for the purchase duration of subscription-based VPN gateways. Default is 'Month'. Month: month Year: year
- project
Name String - Project to which the VPN gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project. You can call ListProjects to query project information under the current account.
- route
Count Number - Number of route entries for the VPN gateway.
- secondary
Ip StringAddress - Second public IP address of the VPN gateway. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- secondary
Subnet StringId - ID of the second subnet associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances in dual tunnel mode; it is not returned for instances in single tunnel mode.
- ssl
Enabled Boolean - Enable SSL VPN feature. true: enabled false: disabled
- ssl
Max NumberConnections - Maximum SSL connections for the VPN gateway.
- status String
- Status of the VPN gateway. Creating: creating Deleting: deleting Pending: configuring Available: available
- subnet
Id String - ID of the subnet to which the port used by the VPN gateway belongs.
- List<Property Map>
- update
Time String - VPN gateway update time.
- vpc
Id String - VPC ID where the VPN gateway is located.
- vpn
Gateway StringId - ID of the VPN gateway.
- vpn
Gateway StringName - Name of the VPN gateway.
Supporting Types
VpnGatewayTag, VpnGatewayTagArgs
- Key string
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- Value string
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- Key string
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- Value string
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key String
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- value String
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key string
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- value string
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key str
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- value str
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key String
- VPN gateway tag key (Key). Parameter - N: Indicates the sequence number of the tag key, value range: 1–20. Multiple tag keys are separated by &. Naming rules: Cannot start with any combination of volc: or sys: (case-insensitive). Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Length limit: 1–128 characters. Note: Tag keys for the same resource must not be duplicated.
- value String
- VPN gateway tag value (Value). Parameter - N: Indicates the sequence number of the tag value, value range: 1–20. Multiple tag values are separated by &. Naming rules: Can only contain language characters, numbers, spaces, and English symbols '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length limit: 0–256 characters. Case-sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
Import
$ pulumi import volcenginecc:vpn/vpnGateway:VpnGateway example "vpn_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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
