Skip to content

SslVpnServer

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

Initializers

import com.aliyun.ros.cdk.vpc.SslVpnServer;
SslVpnServer.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)
//  .cipher(java.lang.String)
//  .cipher(IResolvable)
//  .compress(java.lang.Boolean)
//  .compress(IResolvable)
//  .enableMultiFactorAuth(java.lang.Boolean)
//  .enableMultiFactorAuth(IResolvable)
//  .iDaaSApplicationId(java.lang.String)
//  .iDaaSApplicationId(IResolvable)
//  .iDaaSInstanceId(java.lang.String)
//  .iDaaSInstanceId(IResolvable)
//  .iDaaSRegionId(java.lang.String)
//  .iDaaSRegionId(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .port(java.lang.Number)
//  .port(IResolvable)
//  .proto(java.lang.String)
//  .proto(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: The client CIDR block.
localSubnet java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property localSubnet: The local CIDR block.
vpnGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpnGatewayId: ID of the VPN gateway.
cipher java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cipher: The encryption algorithm used by SSL-VPN.
compress java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property compress: Whether it is compressed.
enableMultiFactorAuth java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableMultiFactorAuth: Whether to enable multi-factor authentication.
iDaaSApplicationId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property iDaaSApplicationId: The ID of the IDaaS application.
iDaaSInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property iDaaSInstanceId: The ID of the IDaaS instance.
iDaaSRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property iDaaSRegionId: The region ID of the IDaaS instance.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The SSL server name.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property port: The port used by the SSL-VPN server.
proto java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property proto: The protocol that is used by the SSL server.

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: The client CIDR block.

The CIDR block from which an IP address is allocated to the virtual network interface controller (NIC) of the client, rather than the private CIDR block. If the client accesses the SSL server over an SSL-VPN connection, the VPN gateway assigns an IP address from the specified client CIDR block for the client to access cloud resources. Make sure that the number of IP addresses in the client CIDR block is at least four times the maximum number of SSL-VPN connections supported by the VPN gateway. ... (omitted for brevity; see metadata URL) ...

  • The subnet mask of the client CIDR block must be 16 to 29 bits in length.
  • Make sure that the client CIDR block does not overlap with the local CIDR block, the VPC CIDR block, or route CIDR blocks associated with the client.

localSubnetRequired

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

Property localSubnet: The local CIDR block.

The CIDR block that your client needs to access by using the SSL-VPN connection. This value can be the CIDR block of a VPC, a vSwitch, a data center that is connected to a VPC by using an Express Connect circuit, or a cloud service such as Object Storage Service (OSS). The subnet mask of the specified local CIDR block must be 8 to 32 bits in length. You cannot specify the following CIDR blocks as the local CIDR blocks:

  • 127.0.0.0~127.255.255.255
  • 169.254.0.0~169.254.255.255
  • 224.0.0.0~239.255.255.255
  • 255.0.0.0~255.255.255.255

vpnGatewayIdRequired

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

Property vpnGatewayId: ID of the VPN gateway.


cipherOptional

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

Property cipher: The encryption algorithm used by SSL-VPN.

Value: AES-128-CBC (default) | AES-192-CBC | AES-256-CBC | none


compressOptional

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

Property compress: Whether it is compressed.


enableMultiFactorAuthOptional

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

Property enableMultiFactorAuth: Whether to enable multi-factor authentication.

The default value is false.


iDaaSApplicationIdOptional

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

Property iDaaSApplicationId: The ID of the IDaaS application.


iDaaSInstanceIdOptional

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

Property iDaaSInstanceId: The ID of the IDaaS instance.


iDaaSRegionIdOptional

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

Property iDaaSRegionId: The region ID of the IDaaS instance.


nameOptional

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

Property name: The SSL server name.

The name must be 1 to 100 characters in length and cannot start with http:\/\/ or https:\/\/.


portOptional

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

Property port: The port used by the SSL-VPN server.

The default value is 1194. Cannot use the following ports: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500


protoOptional

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

Property proto: The protocol that is used by the SSL server.

Valid values:

  • TCP (default)
  • UDP

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.

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

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)

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.SslVpnServer;
SslVpnServer.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.
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.
attrSslVpnServerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SslVpnServerId: ID of the SSL-VPN server.
props SslVpnServerProps 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

attrSslVpnServerIdRequired

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

Attribute SslVpnServerId: ID of the SSL-VPN server.


propsRequired

public SslVpnServerProps getProps();