ALIYUN::UIS::UisConnection is used to create a tunnel connection.

Syntax

{
  "Type": "ALIYUN::UIS::UisConnection",
  "Properties": {
    "GreConfig": List,
    "Description": String,
    "UisProtocol": String,
    "UisNodeId": String,
    "SslConfig": Map,
    "Name": String
  }
}

Properties

Name Type Required Editable Description Validity
GreConfig List No Yes The GRE configurations of the tunnel connection. None
Description String No Yes The description of the tunnel connection. None
UisProtocol String Yes No The name of the communication protocol used between the client and the server. Default value: SSLVPN. Valid values: GRE, SDK, and SSLVPN.
UisNodeId String Yes No The ID of the access node. None
SslConfig Map No Yes The SSL configurations of the tunnel connection. This parameter is valid only when the UisProtocol parameter is set to SSLVPN. None
Name String No Yes The name of the tunnel connection. None

GreConfig syntax

"GreConfig": [
  {
    "CustomerSubnet": String,
    "LocalIP": String,
    "CustomerIP": String,
    "CustomerTunnelIP": String,
    "LocalTunnelIP": String
  }
]

GreConfig properties

Name Type Required Editable Description Validity
CustomerSubnet String No No The CIDR block of the customer's GRE VPN. None
LocalIP String No No The IP address of the access node. None
CustomerIP String No No The public IP address for the customer. None
CustomerTunnelIP String No No The GRE tunnel IP address for the customer. None
LocalTunnelIP String No No The GRE tunnel IP address of the access node. None

SslConfig syntax

"SslConfig": {
  "Cipher": String,
  "Protocol": String,
  "Port": Integer
}

SslConfig properties

Name Type Required Editable Description Validity
Cipher String No No The encryption algorithm used by the SSL-VPN server. Valid values: AES-128-CBC, AES-192-CBC, AES-256-CBC, and none.
Protocol String No No The protocol used by the SSL-VPN server. Default value: UDP. Valid values: UDP and TCP.
Port Integer No No The port used by the SSL-VPN server. Default value: 1194. Valid values: 1025 to 10000. You cannot use the following commonly used port numbers: 2222, 4500, 4510, 4560, 7505, 9000, 9001, and 9002.

Response parameters

Fn::GetAtt

  • UisConnectionId: the ID of the SSL-VPN server. This ID does not distinguish between protocols.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "UisConnection": {
      "Type": "ALIYUN::UIS::UisConnection",
      "Properties": {
        "GreConfig": {
          "Ref": "GreConfig"
        },
        "Description": {
          "Ref": "Description"
        },
        "UisProtocol": {
          "Ref": "UisProtocol"
        },
        "UisNodeId": {
          "Ref": "UisNodeId"
        },
        "SslConfig": {
          "Ref": "SslConfig"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Parameters": {
    "GreConfig": {
      "Type": "Json",
      "Description": "The config for GRE. Item can be overwritten, but removed."
    },
    "Description": {
      "Type": "String",
      "Description": "A description of the tunnel connection."
    },
    "UisProtocol": {
      "Default": "SSLVPN",
      "Type": "String",
      "Description": "The protocol name used by the software and server. The default value is SSLVPN.",
      "AllowedValues": [
        "GRE",
        "SDK",
        "SSLVPN"
      ]
    },
    "UisNodeId": {
      "Type": "String",
      "Description": "Node instance ID."
    },
    "SslConfig": {
      "Type": "Json",
      "Description": "The config for SSLVPN."
    },
    "Name": {
      "Type": "String",
      "Description": "The name of the tunnel connection."
    }
  },
  "Outputs": {
    "UisConnectionId": {
      "Description": "ID of the VPN server. This ID does not distinguish between protocols.",
      "Value": {
        "Fn::GetAtt": [
          "UisConnection",
          "UisConnectionId"
        ]
      }
    }
  }
}