ALIYUN::MSE::Gateway is used to add a gateway.

Syntax

{
  "Type": "ALIYUN::MSE::Gateway",
  "Properties": {
    "BackupVSwitchId": String,
    "EnterpriseSecurityGroup": String,
    "VpcId": String,
    "VSwitchId": String,
    "SlbSpec": String,
    "Spec": String,
    "InternetSlbSpec": String,
    "Replica": Integer,
    "Name": String
  }
}

Properties

Property Type Required Editable Description Constraint
BackupVSwitchId String No No The ID of the secondary vSwitch. N/A
EnterpriseSecurityGroup Boolean No No Specifies whether the gateway belongs to an advanced security group. Valid values:
  • true: The gateway belongs to an advanced security group.
  • false: The gateway does not belong to an advanced security group.
VpcId String Yes No The ID of the virtual private cloud (VPC). N/A
VSwitchId String Yes No The ID of the primary vSwitch. N/A
SlbSpec String No No The instance type of the internal-facing Server Load Balancer (SLB) instance. Sample value: slb.s2.small.
Spec String Yes No The specifications of a gateway node. Valid values:
  • MSE_GTW_2_4_200_c
  • MSE_GTW_4_8_200_c
  • MSE_GTW_8_16_200_c
  • MSE_GTW_16_32_200_c
InternetSlbSpec String No No The instance type of the Internet-facing SLB instance. N/A
Replica Integer Yes No The number of nodes. Valid values: 1 to 30.
Note A gateway is the ingress from which traffic flows in the system. Make sure that the gateway is highly available. We recommend that you use at least two nodes. If only one node is used and it becomes faulty, the system may break down.
Name String No No The name of the gateway. N/A

Response parameters

Fn::GetAtt

  • GatewayUniqueId: the unique ID of the gateway.
  • BackupVSwitchId: the ID of the secondary vSwitch.
  • VpcId: the ID of the VPC.
  • VSwitchId: the ID of the primary vSwitch.
  • PaymentType: the billing method of resources.
  • Spec: the specifications of a gateway node.
  • Replica: the number of nodes.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VSwitchZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Type": "String"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Description": "VpcId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "VpcId",
        "ZoneId": "VSwitchZoneId"
      }
    },
    "Spec": {
      "Type": "String",
      "Description": "Gateway Node Specifications",
      "AllowedValues": [
        "MSE_GTW_2_4_200_c",
        "MSE_GTW_4_8_200_c",
        "MSE_GTW_8_16_200_c",
        "MSE_GTW_16_32_200_c"
      ]
    },
    "Replica": {
      "Type": "Number",
      "Description": "Gateway Node Number",
      "Default": 2
    }
  },
  "Resources": {
    "MSEGateway": {
      "Type": "ALIYUN::MSE::Gateway",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Spec": {
          "Ref": "Spec"
        },
        "Replica": {
          "Ref": "Replica"
        }
      }
    }
  },
  "Outputs": {
    "GatewayUniqueId": {
      "Description": "Gateway unique identification",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "GatewayUniqueId"
        ]
      }
    },
    "BackupVSwitchId": {
      "Description": "VSwitchId For Backup",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "BackupVSwitchId"
        ]
      }
    },
    "VpcId": {
      "Description": "VpcId",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "VpcId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "VSwitchId",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "VSwitchId"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the resource",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "PaymentType"
        ]
      }
    },
    "Spec": {
      "Description": "Gateway Node Specifications",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "Spec"
        ]
      }
    },
    "Replica": {
      "Description": "Gateway Node Number",
      "Value": {
        "Fn::GetAtt": [
          "MSEGateway",
          "Replica"
        ]
      }
    }
  }
}