Skip to content

VpnGatewayProps

Properties for defining a VpnGateway.

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

Initializer

import com.aliyun.ros.cdk.vpc.VpnGatewayProps;
VpnGatewayProps.builder()
    .bandwidth(java.lang.Number)
    .bandwidth(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disasterRecoveryVSwitchId(java.lang.String)
//  .disasterRecoveryVSwitchId(IResolvable)
//  .enableIpsec(java.lang.Boolean)
//  .enableIpsec(IResolvable)
//  .enableSsl(java.lang.Boolean)
//  .enableSsl(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .sslConnections(java.lang.Number)
//  .sslConnections(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpnType(java.lang.String)
//  .vpnType(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

Properties

Name Type Description
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: The maximum bandwidth of the VPN gateway.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VPC ID to which the VPN gateway belongs.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Specifies whether to enable automatic payment.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the VPN gateway.
disasterRecoveryVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property disasterRecoveryVSwitchId: The second vSwitch with which you want to associate the VPN gateway.
enableIpsec java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableIpsec: Whether to enable IPsec-VPN.
enableSsl java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableSsl: Enable the SSL-VPN function.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The billing method of the VPN gateway.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: Name of the VPN gateway.
networkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property networkType: The network type of the VPN gateway.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Purchase time, value: 1~9|12|24|36.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the VPN gateway belongs.
sslConnections java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sslConnections: The maximum number of clients that can be connected at the same time.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
vpnType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpnType: The type of the VPN gateway.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch with which you want to associate the VPN gateway.

bandwidthRequired

public java.lang.Object getBandwidth();
  • Type: java.lang.Number OR com.aliyun.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.


vpcIdRequired

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


autoPayOptional

public java.lang.Object getAutoPay();
  • Type: java.lang.Boolean OR com.aliyun.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.


descriptionOptional

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDisasterRecoveryVSwitchId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEnableIpsec();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getEnableSsl();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.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.


nameOptional

public java.lang.Object getName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: The network type of the VPN gateway.

Valid values:

  • public (default)
  • private

periodOptional

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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.


resourceGroupIdOptional

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.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.


sslConnectionsOptional

public java.lang.Object getSslConnections();
  • Type: java.lang.Number OR com.aliyun.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.


tagsOptional

public java.util.List<TagsProperty> getTags();

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 java.lang.Object getVpnType();
  • Type: java.lang.String OR com.aliyun.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.


vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.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.