ALIYUN::MSE::GatewayService - Resource Orchestration Service

The ALIYUN::MSE::GatewayService resource is used to import a service into a gateway.

Syntax

{
  "Type": "ALIYUN::MSE::GatewayService",
  "Properties": {
    "GatewayUniqueId": String,
    "Name": String,
    "SourceType": String,
    "DnsServerList": List,
    "FcVersion": String,
    "FcAlias": String,
    "FcServiceName": String,
    "GroupName": String,
    "Ips": List,
    "Namespace": String,
    "ServicePort": Integer,
    "SaeAppId": String,
    "SourceId": Integer,
    "ServiceProtocol": String,
    "TlsSetting": Map
  }
}

Properties

Property Name	Type	Required	Update Allowed	Description	Constraints
GatewayUniqueId	String	Yes	No	The unique ID of the gateway.	None
Name	String	Yes	No	The service name.	None
SourceType	String	Yes	No	The source of the service.	Valid values: MSE K8s VIP DNS FC EDAS MSE_ZK SAE
DnsServerList	List	No	No	The list of DNS servers.	None
FcVersion	String	No	No	The version number of the FC service.	This property takes effect only when SourceType is set to FC.
FcAlias	String	No	No	The alias of the FC service.	This property takes effect only when SourceType is set to FC.
FcServiceName	String	No	No	The name of the FC service.	This property takes effect only when SourceType is set to FC.
GroupName	String	No	No	The service group.	None
Ips	List	No	No	The list of IP addresses.	None
Namespace	String	No	No	The namespace.	None
ServicePort	Integer	No	No	The port of the service.	None
SaeAppId	String	No	No	The ID of the SAE application.	None
SourceId	Integer	No	No	The ID of the service source.	This property is used when you add a service from a specified source.
ServiceProtocol	String	No	No	The protocol of the service.	Valid values: DUBBO HTTP GRPC
TlsSetting	Map	No	No	The TLS settings.	Values: TLS mode certId: The certificate ID. caCertId: The CA certificate ID. caCertContent: The public key of the CA certificate. Service Name Indication (SNI) Example: `{ "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "test" }`

Return values

Fn::GetAtt

ServiceId: The ID of the gateway service.
Name: The service name.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SourceType:
    Type: String
    Description:
      en: |
        Type of service source. Valid values:
        - MSE: MSE-NACOS
        - K8s: ACK container service
        - VIP: Fixed address
        - DNS: DNS domain name
        - FC: Function Compute
        - EDAS: EDAS
        - MSE_ZK: MSE-Zookeeper
        - SAE: SAE
    AllowedValues:
      - MSE
      - K8s
      - VIP
      - DNS
      - FC
      - EDAS
      - MSE_ZK
      - SAE
    Required: true
  Name:
    Type: String
    Description:
      en: Name of the service.
    Required: true
  GatewayUniqueId:
    Type: String
    Description:
      en: Unique identifier of the gateway.
    Required: true
Resources:
  GatewayService:
    Type: ALIYUN::MSE::GatewayService
    Properties:
      SourceType:
        Ref: SourceType
      Name:
        Ref: Name
      GatewayUniqueId:
        Ref: GatewayUniqueId
Outputs:
  ServiceId:
    Description: The ID of the gateway service.
    Value:
      Fn::GetAtt:
        - GatewayService
        - ServiceId
  Name:
    Description: The name of the service.
    Value:
      Fn::GetAtt:
        - GatewayService
        - Name

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SourceType": {
      "Type": "String",
      "Description": {
        "en": "Type of service source. Valid values:\n- MSE: MSE-NACOS\n- K8s: ACK container service\n- VIP: Fixed address\n- DNS: DNS domain name\n- FC: Function Compute\n- EDAS: EDAS\n- MSE_ZK: MSE-Zookeeper\n- SAE: SAE\n"
      },
      "AllowedValues": [
        "MSE",
        "K8s",
        "VIP",
        "DNS",
        "FC",
        "EDAS",
        "MSE_ZK",
        "SAE"
      ],
      "Required": true
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "Name of the service."
      },
      "Required": true
    },
    "GatewayUniqueId": {
      "Type": "String",
      "Description": {
        "en": "Unique identifier of the gateway."
      },
      "Required": true
    }
  },
  "Resources": {
    "GatewayService": {
      "Type": "ALIYUN::MSE::GatewayService",
      "Properties": {
        "SourceType": {
          "Ref": "SourceType"
        },
        "Name": {
          "Ref": "Name"
        },
        "GatewayUniqueId": {
          "Ref": "GatewayUniqueId"
        }
      }
    }
  },
  "Outputs": {
    "ServiceId": {
      "Description": "The ID of the gateway service.",
      "Value": {
        "Fn::GetAtt": [
          "GatewayService",
          "ServiceId"
        ]
      }
    },
    "Name": {
      "Description": "The name of the service.",
      "Value": {
        "Fn::GetAtt": [
          "GatewayService",
          "Name"
        ]
      }
    }
  }
}