VpnConnection
This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpnConnection
, which is used to create an IPsec-VPN connection.
Initializers
import com.aliyun.ros.cdk.vpc.VpnConnection;
VpnConnection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.localSubnet(java.lang.String)
.localSubnet(IResolvable)
.remoteSubnet(java.lang.String)
.remoteSubnet(IResolvable)
.vpnGatewayId(java.lang.String)
.vpnGatewayId(IResolvable)
// .autoConfigRoute(java.lang.Boolean)
// .autoConfigRoute(IResolvable)
// .bgpConfig(IResolvable)
// .bgpConfig(BgpConfigProperty)
// .customerGatewayId(java.lang.String)
// .customerGatewayId(IResolvable)
// .effectImmediately(java.lang.Boolean)
// .effectImmediately(IResolvable)
// .enableDpd(java.lang.Boolean)
// .enableDpd(IResolvable)
// .enableNatTraversal(java.lang.Boolean)
// .enableNatTraversal(IResolvable)
// .enableTunnelsBgp(java.lang.Boolean)
// .enableTunnelsBgp(IResolvable)
// .healthCheckConfig(IResolvable)
// .healthCheckConfig(HealthCheckConfigProperty)
// .ikeConfig(IResolvable)
// .ikeConfig(IkeConfigProperty)
// .ipsecConfig(IResolvable)
// .ipsecConfig(IpsecConfigProperty)
// .name(java.lang.String)
// .name(IResolvable)
// .remoteCaCertificate(java.lang.String)
// .remoteCaCertificate(IResolvable)
// .tunnelOptionsSpecification(IResolvable)
// .tunnelOptionsSpecification(java.util.List<IResolvable)
// .tunnelOptionsSpecification(TunnelOptionsSpecificationProperty>)
.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. |
localSubnet |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property localSubnet: A network segment on the VPC side that needs to be interconnected with the local IDC for the second phase negotiation. |
remoteSubnet |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation. |
vpnGatewayId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property vpnGatewayId: ID of the VPN gateway. |
autoConfigRoute |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property autoConfigRoute: Specifies whether to automatically configure routes. |
bgpConfig |
com.aliyun.ros.cdk.core.IResolvable OR BgpConfigProperty |
Property bgpConfig: The Border Gateway Protocol (BGP) configuration. |
customerGatewayId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property customerGatewayId: The ID of the user gateway. |
effectImmediately |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation. |
enableDpd |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature. |
enableNatTraversal |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property enableNatTraversal: Specifies whether to enable NAT traversal. |
enableTunnelsBgp |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel. |
healthCheckConfig |
com.aliyun.ros.cdk.core.IResolvable OR HealthCheckConfigProperty |
Property healthCheckConfig: Whether to enable the health check configuration. |
ikeConfig |
com.aliyun.ros.cdk.core.IResolvable OR IkeConfigProperty |
Property ikeConfig: Configuration information for the first phase of negotiation. |
ipsecConfig |
com.aliyun.ros.cdk.core.IResolvable OR IpsecConfigProperty |
Property ipsecConfig: Configuration information for the second phase negotiation. |
name |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property name: The name of the IPsec connection. |
remoteCaCertificate |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property remoteCaCertificate: The peer CA certificate when a ShangMi (SM) VPN gateway is used to establish the IPsec-VPN connection. |
tunnelOptionsSpecification |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
localSubnet
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property localSubnet: A network segment on the VPC side that needs to be interconnected with the local IDC for the second phase negotiation.
Multiple network segments are separated by commas, for example: 192.168.1.0/24, 192.168.2.0/24.
remoteSubnet
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation.
Multiple network segments are separated by commas, for example: 192.168.3.0/24, 192.168.4.0/24.
vpnGatewayId
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpnGatewayId: ID of the VPN gateway.
autoConfigRoute
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoConfigRoute: Specifies whether to automatically configure routes.
Valid values: true (default) false
bgpConfig
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR BgpConfigProperty
Property bgpConfig: The Border Gateway Protocol (BGP) configuration.
This parameter is required when the VPN gateway has dynamic BGP enabled. Before you configure BGP, we recommend that you learn about how BGP works and its limits. For more information, see VPN Gateway supports BGP dynamic routing. We recommend that you use a private ASN to establish a connection with Alibaba Cloud over BGP. Refer to the relevant documentation for the private ASN range.
customerGatewayId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property customerGatewayId: The ID of the user gateway.
effectImmediately
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation.
Value: True: Negotiate immediately after the configuration is complete. False (default): Negotiate when traffic enters.
enableDpd
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature.
Valid values: true (default) The initiator of the IPsec-VPN connection sends DPD packets to verify the existence and availability of the peer. If no response is received from the peer within a specified period of time, the connection fails. ISAKMP SAs and IPsec SAs are deleted. The IPsec tunnel is also deleted. false: disables DPD. The IPsec initiator does not send DPD packets.
enableNatTraversal
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableNatTraversal: Specifies whether to enable NAT traversal.
Valid values: true (default) After NAT traversal is enabled, the initiator does not check the UDP ports during IKE negotiations and can automatically discover NAT gateway devices along the VPN tunnel. false
enableTunnelsBgp
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel.
Valid values: true and false. Default value: false.
healthCheckConfig
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR HealthCheckConfigProperty
Property healthCheckConfig: Whether to enable the health check configuration.
ikeConfig
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR IkeConfigProperty
Property ikeConfig: Configuration information for the first phase of negotiation.
ipsecConfig
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR IpsecConfigProperty
Property ipsecConfig: Configuration information for the second phase negotiation.
name
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the IPsec connection.
The length is 2-128 characters and must start with a letter or Chinese. It can contain numbers, periods (.), underscores (_) and dashes (-), but cannot start with http:// or https:// .
remoteCaCertificate
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remoteCaCertificate: The peer CA certificate when a ShangMi (SM) VPN gateway is used to establish the IPsec-VPN connection.
This parameter is required when an SM VPN gateway is used to establish the IPsec-VPN connection. You can ignore this parameter when a standard VPN gateway is used to create the IPsec-VPN connection.
tunnelOptionsSpecification
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
TunnelOptionsSpecificationProperty>
Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways.
You can modify both the active and standby tunnels of the IPsec-VPN connection.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vpc.VpnConnection;
VpnConnection.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrPeerVpnConnectionConfig |
com.aliyun.ros.cdk.core.IResolvable |
Attribute PeerVpnConnectionConfig: Peer vpc connection config. |
attrStatus |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Status: Status of the IPsec connection. |
attrVpnConnectionId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute VpnConnectionId: ID of the IPsec connection. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrPeerVpnConnectionConfig
Required
public IResolvable getAttrPeerVpnConnectionConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute PeerVpnConnectionConfig: Peer vpc connection config.
attrStatus
Required
public IResolvable getAttrStatus();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Status: Status of the IPsec connection.
attrVpnConnectionId
Required
public IResolvable getAttrVpnConnectionId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute VpnConnectionId: ID of the IPsec connection.