Skip to content

VpnGatewayProps

Properties for defining a VpnGateway.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-vpngateway

Initializer 

import { VpnGatewayProps } from '@alicloud/ros-cdk-vpc'
const vpnGatewayProps: VpnGatewayProps = { ... }

Properties

Name Type Description
bandwidth number | @alicloud/ros-cdk-core.IResolvable Property bandwidth: The public network bandwidth of the VPN gateway, in Mbps.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: VPC ID to which the VPN gateway belongs.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Whether to automatically pay the bill of the VPN gateway, the value: true: Automatically pays the bill for the VPN gateway.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the VPN gateway.
disasterRecoveryVSwitchId string | @alicloud/ros-cdk-core.IResolvable Property disasterRecoveryVSwitchId: The second vSwitch with which you want to associate the VPN gateway.
enableIpsec boolean | @alicloud/ros-cdk-core.IResolvable Property enableIpsec: Whether to enable IPsec-VPN.
enableSsl boolean | @alicloud/ros-cdk-core.IResolvable Property enableSsl: Enable the SSL-VPN function.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: Accounting type of the VPN gateway, the value is: PREPAY, POSTPAY.
name string | @alicloud/ros-cdk-core.IResolvable Property name: Name of the VPN gateway.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The network type of the VPN gateway.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Purchase time, value: 1~9|12|24|36.
sslConnections number | @alicloud/ros-cdk-core.IResolvable Property sslConnections: The maximum number of clients allowed to connect at the same time.
tags TagsProperty[] Property tags: Tags to attach to instance.
vpnType string | @alicloud/ros-cdk-core.IResolvable Property vpnType: VPN gateway type.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the VSwitch to which the VPN gateway belongs.

bandwidthRequired 

public readonly bandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property bandwidth: The public network bandwidth of the VPN gateway, in Mbps.

Value: 5|10|20|50|100|200.

vpcIdRequired 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: VPC ID to which the VPN gateway belongs.

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Whether to automatically pay the bill of the VPN gateway, the value: true: Automatically pays the bill for the VPN gateway.

false: Does not automatically pay the bill for the VPN gateway. Default true.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of the VPN gateway.

The length is 2-256 characters and must start with a letter or Chinese, but cannot start with http:\/\/ or https:\/\/.

disasterRecoveryVSwitchIdOptional 

public readonly disasterRecoveryVSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property disasterRecoveryVSwitchId: The second vSwitch with which you want to associate the VPN gateway.

If you call this operation in a region that supports the dual-tunnel mode, this parameter is required. You need to specify two vSwitches in different zones from the VPC associated with the VPN gateway to implement disaster recovery across zones. For a region that supports only one zone, disaster recovery across zones is not supported. We recommend that you specify two vSwitches in the zone to implement high availability. You can specify the same vSwitch. For more information about the regions and zones that support the dual-tunnel mode, see Upgrade a VPN gateway to enable the dual-tunnel mode.

enableIpsecOptional 

public readonly enableIpsec: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableIpsec: Whether to enable IPsec-VPN.

The IPsec-VPN feature provides a site-to-site connection. You can securely connect your local data center network to a private network or two proprietary networks by creating an IPsec tunnel. Value: True (default): Enables the IPsec-VPN feature. False: The IPsec-VPN function is not enabled.

enableSslOptional 

public readonly enableSsl: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableSsl: Enable the SSL-VPN function.

Provide point-to-site VPN connection, no need to configure customer gateway, terminal directly access. Value: True: Enable SSL-VPN. False (default): Does not enable SSL-VPN.

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: Accounting type of the VPN gateway, the value is: PREPAY, POSTPAY.

nameOptional 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: Name of the VPN gateway.

The default value is the ID of the VPN gateway. The length is 2~100 English or Chinese characters. It must start with a large or small letter or Chinese. It can contain numbers, underscores (_) and dashes (-). It cannot start with http:\/\/ or https:\/\/.

networkTypeOptional 

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The network type of the VPN gateway.

Valid values: public|private

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: Purchase time, value: 1~9|12|24|36.

When the value of the InstanceChargeType parameter is PREPAY, this parameter is mandatory.

sslConnectionsOptional 

public readonly sslConnections: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property sslConnections: The maximum number of clients allowed to connect at the same time.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

vpnTypeOptional 

public readonly vpnType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpnType: VPN gateway type.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch to which the VPN gateway belongs.