ALIYUN::MSE::Gateway2资源类型语法与属性参考-资源编排-阿里云

ALIYUN::MSE::Gateway2类型用于创建云原生网关。

语法

{
  "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
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
VpcId	String	是	否	专有网络 ID。	无
AcceptLanguage	String	否	是	返回信息的语言类型。	取值： zh en
ChargeType	String	否	是	付费类型	取值： PREPAY：包年包月。 POSTPAY：按量付费。
ClbNetworkType	String	否	否	代购按 LCU 计费的 CLB 的网络类型。	取值： pubnet：公网 privatenet：私网 privatepubnet：公网+私网说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
EnterpriseSecurityGroup	Boolean	否	否	是否企业安全组类型。	无
EnableXtrace	Boolean	否	否	是否启用链路追踪。	无
EnableSls	Boolean	否	否	是否启用 SLS 日志投递。	无
EnableHardwareAcceleration	Boolean	否	否	是否开启硬件加速。	无
InternetSlb	String	否	否	公网 SLB 规格。	取值：简约型I（slb.s1.small）标准型I（slb.s2.small）标准型II（slb.s2.medium）高阶型I（slb.s3.small）高阶型II（slb.s3.medium）超强型I（slb.s3.large）
ManagedEntryNetworkType	String	否	否	网关入口类型。	取值： pubnet：公网 privatenet：私网 privatepubnet：公网+私网
MserVersion	String	否	否	网关产品类型。	取值： mse_pro：普通实例标准版 mse_premium：普通实例专业版 mse_serverless：Serverless版
Name	String	否	否	网关名称。	无
NlbNetworkType	String	否	否	代购的 NLB 网络类型。	取值： pubnet：公网 privatenet：私网 privatepubnet：公网+私网说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
ResourceGroupId	String	否	否	资源组 ID。	无
Replica	Integer	否	否	节点数量。	取值范围：1~30 个。
SlbSpec	String	否	否	私网 SLB 规格。	取值：简约型I（slb.s1.small）标准型I（slb.s2.small）标准型II（slb.s2.medium）高阶型I（slb.s3.small）高阶型II（slb.s3.medium）超强型I（slb.s3.large）说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
Spec	String	否	否	节点规格。	取值： 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	否	否	网关绑定的标签。	更多信息，请参考Tags属性。
VSwitchId2	String	否	否	备交换机 ID。	无
VSwitchId	String	否	否	主交换机 ID。	无
XtraceRatio	Integer	否	否	链路追踪采样率。	取值：1~100。
ZoneInfo	List	否	否	可用区信息。	更多信息，请参考ZoneInfo属性。
Period	Number	否	是	包年包月时长。	取值：当 PeriodUnit为Year时，取值范围为1~3。当PeriodUnit为Month时，取值范围为1~9。
PeriodUnit	String	否	是	付费周期。	取值： Year：年。 Month：月。

Tags语法

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

Tags属性

属性名称	类型	必须	允许更新	描述	约束
Key	String	是	否	标签键。	无
Value	String	否	否	标签值。	无

ZoneInfo语法

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

ZoneInfo属性

属性名称	类型	必须	允许更新	描述	约束
VSwitchId	String	否	否	交换机 ID。	无
ZoneId	String	否	否	可用区 ID。	无

返回值

Fn::GetAtt

GatewayUniqueId：网关唯一标识 ID。

示例

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"
        ]
      }
    }
  }
}