IpsecServer
- Implements: IIpsecServer
This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpsecServer.
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 1 to 100 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
- Type: com.aliyun.ros.cdk.core.IResolvable OR IkeConfigProperty
Property ikeConfig: Negotiation parameter configuration in the first phase.
ipsecConfigOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR IpsecConfigProperty
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 1 to 100 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
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.IpsecServer;
IpsecServer.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. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpsecServerId: IPsec server ID. |
attrIpsecServerName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpsecServerName: IPsec server name. |
props | IpsecServerProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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 java.lang.Object getAttrIpsecServerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpsecServerId: IPsec server ID.
attrIpsecServerNameRequired
public java.lang.Object getAttrIpsecServerName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpsecServerName: IPsec server name.
propsRequired
public IpsecServerProps getProps();
- Type: IpsecServerProps