ALIYUN::MSE::Gateway2 - Resource Orchestration Service - Alibaba Cloud Documentation Center

The ALIYUN::MSE::Use Gateway2 resource type to create cloud-native gateway.

Syntax

{
  "Type": "ALIYUN::MSE::Gateway2",
  "Properties": {
    "VpcId": String,
    "AcceptLanguage": String,
    "ChargeType": String,
    "ClbNetworkType": String,
    "EnterpriseSecurityGroup": Boolean,
    "EnableXtrace": Boolean,
    "EnableSls": Boolean,
    "EnableHardwareAcceleration": Boolean,
    "InternetSlb": String,
    "ManagedEntryNetworkType": String,
    "MserVersion": String,
    "Name": String,
    "NlbNetworkType": String,
    "ResourceGroupId": String,
    "Replica": Integer,
    "SlbSpec": String,
    "Spec": String,
    "Tags": List,
    "VSwitchId2": String,
    "VSwitchId": String,
    "XtraceRatio": Integer,
    "ZoneInfo": List,
    "Period": Number,
    "PeriodUnit": String
  }
}

Properties

Property name	Type	Required	Editable	Description	Constraint
VpcId	String	Yes	No	Virtual private cloud (VPC) ID.	None
AcceptLanguage	String	No	Yes	The language of the return message.	Valid values: zh en
ChargeType	String	No	Yes	The billing method.	Valid values: PREPAY: annual or monthly subscription. POSTPAY: pay-as-you-go.
ClbNetworkType	String	No	No	The network type for purchasing CLB (based on LCU billing).	Valid values: pubnet: Public network privatenet: Private network privatepubnet: Public network + Private network Note Serverless instance: You can only choose NLB or CLB (based on LCU billing) when creating a new instance.
EnterpriseSecurityGroup	Boolean	No	No	Specifies whether to use enterprise security group.	None
EnableXtrace	Boolean	No	No	Specifies whether to enable xTrace log.	None
EnableSls	Boolean	No	No	Specifies whether to enable SLS (Simple Log Service).	None
EnableHardwareAcceleration	Boolean	No	No	Specifies whether to enable hardware acceleration.	None
InternetSlb	String	No	No	Public network SLB (Server Load Balancer) specifications.	Valid values: Basic type I (slb.s1.small) Standard type I (slb.s2.small) Standard type II (slb.s2.medium) Advanced type I (slb.s3.small) Advanced type II (slb.s3.medium) Ultra type I (slb.s3.large)
ManagedEntryNetworkType	String	No	No	The gateway entry type.	Valid values: pubnet: Public network privatenet: Private network privatepubnet: Public network + Private network
MserVersion	String	No	No	The gateway product type.	Valid values: mse_pro: Normal instance standard edition mse_premium: Normal instance professional edition mse_serverless: Serverless Edition
Name	String	No	No	The gateway name.	None
NlbNetworkType	String	No	No	The network type for purchasing NLB.	Valid values: pubnet: Public network privatenet:Private network privatepubnet: Public network + Private network Note Serverless instance: You can only choose NLB or CLB (based on LCU billing) when creating a new instance.
ResourceGroupId	String	No	No	The resource group ID.	None
Replica	Integer	No	No	The number of nodes.	Valid values: 1 to 30.
SlbSpec	String	No	No	Private network SLB (Server Load Balancer) specifications.	Valid values: Basic type I (slb.s1.small) Standard type I (slb.s2.small) Standard type II (slb.s2.medium) Advanced type I (slb.s3.small) Advanced type II (slb.s3.medium) Ultra type I (slb.s3.large) Note Serverless instance: You can only choose NLB or CLB (based on LCU billing) when creating a new instance.
Spec	String	No	No	The node specifications.	Valid values: MSE_GTW_16_32_200_c(16C32G) MSE_GTW_2_4_200_c(2C4G) MSE_GTW_4_8_200_c(4C8G) MSE_GTW_8_16_200_c(8C16G)
Tags	List	No	No	The gateway bound tags.	For more information, see Tags properties.
VSwitchId2	String	No	No	The secondary vSwitch ID.	None
VSwitchId	String	No	No	The primary vSwitch ID.	None
XtraceRatio	Integer	No	No	The xTrace ratio sampling rate.	Valid values: 1 to 100.
ZoneInfo	List	No	No	The zone information.	For more information, see ZoneInfo properties.
Period	Number	No	Yes	The subscription duration of the node group.	Valid values: When PeriodUnit is set to Year, valid value range is 1 to 3. When PeriodUnit is set to Month, valid value range is 1 to 9.
PeriodUnit	String	No	Yes	The payment cycle.	Valid values: Year Month

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property name	Type	Required	Allow updates	Description	Constraint
Key	String	Yes	No	The tag key.	None
Value	String	No	No	The tag value.	None

ZoneInfo syntax

"ZoneInfo": [
  {
    "ZoneId": String,
    "VSwitchId": String
  }
]

ZoneInfo properties

Property name	Type	Required	Allow updates	Description	Constraint
VSwitchId	String	No	No	The vSwitch ID.	None
ZoneId	String	No	No	The zone ID.	None

Return values

Fn::GetAtt

GatewayUniqueId: The gateway unique ID

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VSwitchId:
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    Type: String
    Description:
      en: The primary VSwitch ID.
    Required: false
  ManagedEntryNetworkType:
    Type: String
    Description:
      en: |-
        Gateway entrance type (applicable to the mse_premium instance)
        pubnet: public network
        privatenet: privatenet
        privatepubnet: public + private network
    AllowedValues:
      - pubnet
      - privatenet
      - privatepubnet
    Required: false
  Replica:
    Type: Number
    Description:
      en: The number of nodes you specify when you purchase an normal instance. For high availability, the value for this param is recommended to be greater than 2.
    Required: false
    MinValue: 1
    MaxValue: 30
  Name:
    Type: String
    Description:
      en: The name of the created gateway.
    Required: false
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: The ID of the vpc.
    Required: true
  ChargeType:
    Type: String
    Description:
      en: |-
        The billing method you specify when you purchase an normal instance.
        Valid values:
        PREPAY: subscription
        POSTPAY: pay-as-you-go
    AllowedValues:
      - POSTPAY
      - PREPAY
    Required: false
  Spec:
    Type: String
    Description:
      en: |-
        The node specifications you specify when you purchase an normal instance. Valid values:
        MSE_GTW_16_32_200_c(16C32G)
        MSE_GTW_2_4_200_c(2C4G)
        MSE_GTW_4_8_200_c(4C8G)
        MSE_GTW_8_16_200_c(8C16G)
    AllowedValues:
      - MSE_GTW_16_32_200_c
      - MSE_GTW_2_4_200_c
      - MSE_GTW_4_8_200_c
      - MSE_GTW_8_16_200_c
    Required: false
  NlbNetworkType:
    Type: String
    Description:
      en: |-
        The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.
        pubnet: Internet
        privatenet: private network
        privatepubnet: Internet and private network
    AllowedValues:
      - pubnet
      - privatenet
      - privatepubnet
    Required: false
  ClbNetworkType:
    Type: String
    Description:
      en: |-
        The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.
        pubnet: Internet
        privatenet: private network
        privatepubnet: Internet and private network
    AllowedValues:
      - pubnet
      - privatenet
      - privatepubnet
    Required: false
  MserVersion:
    Type: String
    Description:
      en: |-
        The MSE gateway instance type. Valid values:
        mse_pro: normal instance
        mse_premium: professional normal instancemse_serverless: serverless instance
    Default: mse_serverless
    Required: false
  ZoneInfo:
    AssociationPropertyMetadata:
      Parameters:
        ZoneId:
          AssociationProperty: ZoneId
          Type: String
          Description:
            en: The id of the zone.
          Required: false
        VSwitchId:
          AssociationPropertyMetadata:
            VpcId: ${VpcId}
            ZoneId: ${ZoneId}
          AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
          Type: String
          Description:
            en: The id of the VSwitch.
          Required: false
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: The info details of the available zone.
    Required: false
Resources:
  Gateway2:
    Type: ALIYUN::MSE::Gateway2
    Properties:
      VSwitchId:
        Ref: VSwitchId
      ManagedEntryNetworkType:
        Ref: ManagedEntryNetworkType
      Replica:
        Ref: Replica
      Name:
        Ref: Name
      VpcId:
        Ref: VpcId
      ChargeType:
        Ref: ChargeType
      Spec:
        Ref: Spec
      NlbNetworkType:
        Ref: NlbNetworkType
      ClbNetworkType:
        Ref: ClbNetworkType
      MserVersion:
        Ref: MserVersion
      ZoneInfo:
        Ref: ZoneInfo
Outputs:
  GatewayUniqueId:
    Description: The unique ID of the gateway.
    Value:
      Fn::GetAtt:
        - Gateway2
        - GatewayUniqueId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "en": "The primary VSwitch ID."
      },
      "Required": false
    },
    "ManagedEntryNetworkType": {
      "Type": "String",
      "Description": {
        "en": "Gateway entrance type (applicable to the mse_premium instance)\npubnet: public network\nprivatenet: privatenet\nprivatepubnet: public + private network"
      },
      "AllowedValues": [
        "pubnet",
        "privatenet",
        "privatepubnet"
      ],
      "Required": false
    },
    "Replica": {
      "Type": "Number",
      "Description": {
        "en": "The number of nodes you specify when you purchase an normal instance. For high availability, the value for this param is recommended to be greater than 2."
      },
      "Required": false,
      "MinValue": 1,
      "MaxValue": 30
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the created gateway."
      },
      "Required": false
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The ID of the vpc."
      },
      "Required": true
    },
    "ChargeType": {
      "Type": "String",
      "Description": {
        "en": "The billing method you specify when you purchase an normal instance.\nValid values:\nPREPAY: subscription\nPOSTPAY: pay-as-you-go"
      },
      "AllowedValues": [
        "POSTPAY",
        "PREPAY"
      ],
      "Required": false
    },
    "Spec": {
      "Type": "String",
      "Description": {
        "en": "The node specifications you specify when you purchase an normal instance. Valid values:\nMSE_GTW_16_32_200_c(16C32G)\nMSE_GTW_2_4_200_c(2C4G)\nMSE_GTW_4_8_200_c(4C8G)\nMSE_GTW_8_16_200_c(8C16G)"
      },
      "AllowedValues": [
        "MSE_GTW_16_32_200_c",
        "MSE_GTW_2_4_200_c",
        "MSE_GTW_4_8_200_c",
        "MSE_GTW_8_16_200_c"
      ],
      "Required": false
    },
    "NlbNetworkType": {
      "Type": "String",
      "Description": {
        "en": "The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.\npubnet: Internet\nprivatenet: private network\nprivatepubnet: Internet and private network"
      },
      "AllowedValues": [
        "pubnet",
        "privatenet",
        "privatepubnet"
      ],
      "Required": false
    },
    "ClbNetworkType": {
      "Type": "String",
      "Description": {
        "en": "The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.\npubnet: Internet\nprivatenet: private network\nprivatepubnet: Internet and private network"
      },
      "AllowedValues": [
        "pubnet",
        "privatenet",
        "privatepubnet"
      ],
      "Required": false
    },
    "MserVersion": {
      "Type": "String",
      "Description": {
        "en": "The MSE gateway instance type. Valid values:\nmse_pro: normal instance\nmse_premium: professional normal instancemse_serverless: serverless instance"
      },
      "Default": "mse_serverless",
      "Required": false
    },
    "ZoneInfo": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "ZoneId": {
            "AssociationProperty": "ZoneId",
            "Type": "String",
            "Description": {
              "en": "The id of the zone."
            },
            "Required": false
          },
          "VSwitchId": {
            "AssociationPropertyMetadata": {
              "VpcId": "${VpcId}",
              "ZoneId": "${ZoneId}"
            },
            "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
            "Type": "String",
            "Description": {
              "en": "The id of the VSwitch."
            },
            "Required": false
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "The info details of the available zone."
      },
      "Required": false
    }
  },
  "Resources": {
    "Gateway2": {
      "Type": "ALIYUN::MSE::Gateway2",
      "Properties": {
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "ManagedEntryNetworkType": {
          "Ref": "ManagedEntryNetworkType"
        },
        "Replica": {
          "Ref": "Replica"
        },
        "Name": {
          "Ref": "Name"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "ChargeType": {
          "Ref": "ChargeType"
        },
        "Spec": {
          "Ref": "Spec"
        },
        "NlbNetworkType": {
          "Ref": "NlbNetworkType"
        },
        "ClbNetworkType": {
          "Ref": "ClbNetworkType"
        },
        "MserVersion": {
          "Ref": "MserVersion"
        },
        "ZoneInfo": {
          "Ref": "ZoneInfo"
        }
      }
    }
  },
  "Outputs": {
    "GatewayUniqueId": {
      "Description": "The unique ID of the gateway.",
      "Value": {
        "Fn::GetAtt": [
          "Gateway2",
          "GatewayUniqueId"
        ]
      }
    }
  }
}