Skip to content

VpnGateway

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpnGateway, which is used to create a VPN gateway.

Initializers 

import com.aliyun.ros.cdk.vpc.VpnGateway;
VpnGateway.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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)
//  .sslConnections(java.lang.Number)
//  .sslConnections(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpnType(java.lang.String)
//  .vpnType(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: The public network bandwidth of the VPN gateway, in Mbps.
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: Whether to automatically pay the bill of the VPN gateway, the value: true: Automatically pays the bill for the VPN gateway.
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: Accounting type of the VPN gateway, the value is: PREPAY, POSTPAY.
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.
sslConnections java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sslConnections: The maximum number of clients allowed to connect 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: VPN gateway type.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the VSwitch to which the VPN gateway belongs.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bandwidthRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

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

vpcIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

autoPayOptional

  • Type: java.lang.Boolean OR com.aliyun.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

  • 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

  • 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

  • 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

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

nameOptional

  • 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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: The network type of the VPN gateway.

Valid values: public|private

periodOptional

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

sslConnectionsOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

tagsOptional

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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpnType: VPN gateway type.

vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.vpc.VpnGateway;
VpnGateway.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrDisasterRecoveryInternetIp com.aliyun.ros.cdk.core.IResolvable Attribute DisasterRecoveryInternetIp: The second IP address assigned by the system to create an IPsec-VPN connection.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.
attrDisasterRecoveryVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute DisasterRecoveryVSwitchId: The ID of the second vSwitch associated with the VPN gateway.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.
attrInternetIp com.aliyun.ros.cdk.core.IResolvable Attribute InternetIp: The public IP address of the VPN gateway.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: The order ID.
attrSpec com.aliyun.ros.cdk.core.IResolvable Attribute Spec: The specification of the VPN gateway.
attrSslMaxConnections com.aliyun.ros.cdk.core.IResolvable Attribute SslMaxConnections: The maximum number of concurrent SSL-VPN connections.
attrSslVpnInternetIp com.aliyun.ros.cdk.core.IResolvable Attribute SslVpnInternetIp: The IP address of the SSL-VPN connection.This attribute is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.
attrVpnGatewayId com.aliyun.ros.cdk.core.IResolvable Attribute VpnGatewayId: ID of the VPN gateway.
attrVpnType com.aliyun.ros.cdk.core.IResolvable Attribute VpnType: The type of the VPN gateway.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the VPN gateway belongs.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDisasterRecoveryInternetIpRequired 

public IResolvable getAttrDisasterRecoveryInternetIp();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DisasterRecoveryInternetIp: The second IP address assigned by the system to create an IPsec-VPN connection.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.

attrDisasterRecoveryVSwitchIdRequired 

public IResolvable getAttrDisasterRecoveryVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DisasterRecoveryVSwitchId: The ID of the second vSwitch associated with the VPN gateway.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.

attrInternetIpRequired 

public IResolvable getAttrInternetIp();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InternetIp: The public IP address of the VPN gateway.

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The order ID.

attrSpecRequired 

public IResolvable getAttrSpec();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Spec: The specification of the VPN gateway.

attrSslMaxConnectionsRequired 

public IResolvable getAttrSslMaxConnections();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SslMaxConnections: The maximum number of concurrent SSL-VPN connections.

attrSslVpnInternetIpRequired 

public IResolvable getAttrSslVpnInternetIp();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SslVpnInternetIp: The IP address of the SSL-VPN connection.This attribute is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.

attrVpcIdRequired 

public IResolvable getAttrVpcId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.

attrVpnGatewayIdRequired 

public IResolvable getAttrVpnGatewayId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpnGatewayId: ID of the VPN gateway.

attrVpnTypeRequired 

public IResolvable getAttrVpnType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpnType: The type of the VPN gateway.

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of the vSwitch to which the VPN gateway belongs.