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

bandwidth^Required

public readonly bandwidth: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property bandwidth: The maximum bandwidth of the VPN gateway.

Unit: Mbit\/s. * If you want to create a public VPN gateway, valid values are 10, 100, 200, 500, and 1000. * If you want to create a private VPN gateway, valid values are 200 and 1000.

The maximum bandwidth supported by VPN gateways in some regions is 500 Mbit\/s.

vpcId^Required

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

autoPay^Optional

public readonly autoPay: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Specifies whether to enable automatic payment.

Valid values: * true * false (default)

To create a VPN gateway, we recommend that you enable automatic payment. If you disable automatic payment, you must manually pay the bill to create the VPN gateway.

description^Optional

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:\/\/.

disasterRecoveryVSwitchId^Optional

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.

enableIpsec^Optional

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.

enableSsl^Optional

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.

instanceChargeType^Optional

public readonly instanceChargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: The billing method of the VPN gateway.

Set the value to POSTPAY, which specifies the pay-as-you-go billing method.

name^Optional

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:\/\/.

networkType^Optional

public readonly networkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The network type of the VPN gateway.

Valid values: * public (default) * private

period^Optional

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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group to which the VPN gateway belongs.

If you do not specify a resource group ID, the VPN gateway will belong to the default resource group after creation. - After the VPN gateway is created, if you create SSL server, SSL client certificate, IPsec server, or IPsec connection (in the scenario where the IPsec connection is bound to the VPN gateway), these resources will directly belong to the resource group of the VPN gateway and cannot be modified.

If you change the resource group of the VPN gateway, the resource group of the above resources will also be changed.

sslConnections^Optional

public readonly sslConnections: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property sslConnections: The maximum number of clients that can be connected at the same time.

Valid values: 5 (default), 10, 20, 50, 100, 200, 500, and 1000.

tags^Optional

public readonly tags: TagsProperty[];

• Type: 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.

vpnType^Optional

public readonly vpnType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpnType: The type of the VPN gateway.

Valid values: Set the value to Normal (default), which specifies a standard NAT gateway.

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

• If you call this operation in a region that supports the IPsec-VPN connections in dual-tunnel mode, this parameter is required. You must specify a vSwitch and specify DisasterRecoveryVSwitchId.
• If you call this operation in a region that supports the IPsec-VPN connections in single-tunnel mode and do not specify a vSwitch, the system automatically specifies a vSwitch.