Skip to content

IpsecServer

This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpsecServer, which is used to create an IPsec-VPN server.

Initializers 

import com.aliyun.ros.cdk.vpc.IpsecServer;
IpsecServer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .clientIpPool(java.lang.String)
    .clientIpPool(IResolvable)
    .localSubnet(java.lang.String)
    .localSubnet(IResolvable)
    .vpnGatewayId(java.lang.String)
    .vpnGatewayId(IResolvable)
//  .effectImmediately(java.lang.Boolean)
//  .effectImmediately(IResolvable)
//  .ikeConfig(IResolvable)
//  .ikeConfig(IkeConfigProperty)
//  .ipsecConfig(IResolvable)
//  .ipsecConfig(IpsecConfigProperty)
//  .ipsecServerName(java.lang.String)
//  .ipsecServerName(IResolvable)
//  .psk(java.lang.String)
//  .psk(IResolvable)
//  .pskEnabled(java.lang.Boolean)
//  .pskEnabled(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.
clientIpPool java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clientIpPool: Client network segment refers to the address segment that assigns access addresses to the virtual network card of the client.
localSubnet java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property localSubnet: The local network segment refers to the network segment on the VPC side that needs to be interconnected with the client network segment.
vpnGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpnGatewayId: VPN gateway instance ID.
effectImmediately java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property effectImmediately: true: Apply the new configuration and trigger a reconnection immediately.
ikeConfig com.aliyun.ros.cdk.core.IResolvable OR IkeConfigProperty Property ikeConfig: Negotiation parameter configuration in the first phase.
ipsecConfig com.aliyun.ros.cdk.core.IResolvable OR IpsecConfigProperty Property ipsecConfig: Negotiation parameter configuration in the second phase.
ipsecServerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipsecServerName: The value must be 2 to 128 characters in length and start with a letter or Chinese character.
psk java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property psk: Pre-Shared key.
pskEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property pskEnabled: Whether to enable the pre-shared key authentication method.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

clientIpPoolRequired

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

Property clientIpPool: Client network segment refers to the address segment that assigns access addresses to the virtual network card of the client.

Note: The client network segment cannot conflict with the VPC side network segment.

localSubnetRequired

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

Property localSubnet: The local network segment refers to the network segment on the VPC side that needs to be interconnected with the client network segment.

Use half-width commas (,) to separate multiple network segments, for example: 192.168.1.0/24,192.168.2.0/24.

vpnGatewayIdRequired

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

Property vpnGatewayId: VPN gateway instance ID.

effectImmediatelyOptional

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

Property effectImmediately: true: Apply the new configuration and trigger a reconnection immediately.

false: Trigger a reconnection only when network traffic occurs. (The reconnection may cause the network to be unavailable for a brief moment)

ikeConfigOptional

Property ikeConfig: Negotiation parameter configuration in the first phase.

ipsecConfigOptional

Property ipsecConfig: Negotiation parameter configuration in the second phase.

ipsecServerNameOptional

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

Property ipsecServerName: The value must be 2 to 128 characters in length and start with a letter or Chinese character.

It can contain digits, underscores (_), and hyphens (-).

pskOptional

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

Property psk: Pre-Shared key.

Used for identity authentication between the VPN gateway and the client. A 16-bit random string is randomly generated by default, or you can manually specify the key. The length is limited to 100 characters.

pskEnabledOptional

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

Property pskEnabled: Whether to enable the pre-shared key authentication method.

Only the value is true, which means that the pre-shared key authentication mode is enabled.

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.IpsecServer;
IpsecServer.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.
attrIpsecServerId com.aliyun.ros.cdk.core.IResolvable Attribute IpsecServerId: IPsec server ID.
attrIpsecServerName com.aliyun.ros.cdk.core.IResolvable Attribute IpsecServerName: IPsec server name.

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

attrIpsecServerIdRequired 

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

Attribute IpsecServerId: IPsec server ID.

attrIpsecServerNameRequired 

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

Attribute IpsecServerName: IPsec server name.