Use ALIYUN::MSE::Cluster to create a cluster - Resource Orchestration Service

The ALIYUN::MSE::Cluster resource creates a Microservices Engine (MSE) cluster.

Syntax

{
  "Type": "ALIYUN::MSE::Cluster",
  "Properties": {
    "DiskType": String,
    "InstanceCount": Integer,
    "PrivateSlbSpecification": String,
    "VpcId": String,
    "ClusterVersion": String,
    "PubNetworkFlow": String,
    "ClusterSpecification": String,
    "VSwitchId": String,
    "PubSlbSpecification": String,
    "EipEnabled": Boolean,
    "ChargeType": String,
    "SecurityGroupType": String,
    "ClusterType": String,
    "NetType": String,
    "ClusterAliasName": String,
    "AcceptLanguage": String,
    "MseVersion": String,
    "ConnectionType": String,
    "RequestPars": String,
    "AclEntryList": List,
    "Tags": List,
    "ResourceGroupId": String
  }
}

Properties

Property	Type	Required	Allow Updates	Description	Constraint
ClusterVersion	String	Yes	No	The cluster version.	Valid values: ZooKeeper_3_4_14 ZooKeeper_3_5_5 NACOS_ANS_1_2_1 NACOS_2_0_0
ClusterSpecification	String	Yes	No	The engine specification.	Valid values: MSE_GTW_2_4_200_c: 2 vCPUs and 4 GB of memory. MSE_GTW_4_8_200_c: 4 vCPUs and 8 GB of memory. MSE_GTW_8_16_200_c: 8 vCPUs and 16 GB of memory. MSE_GTW_16_32_200_c: 16 vCPUs and 32 GB of memory.
ClusterType	String	Yes	No	The cluster type.	Valid values: ZooKeeper Nacos-Ans Eureka
InstanceCount	Integer	Yes	No	The number of instances.	Valid values: 1 to 9.
NetType	String	Yes	No	The network type.	Valid values: privatenet: virtual private cloud (VPC) pubnet: public network
DiskType	String	No	No	The disk type.	Valid value: alicloud-disk-ssd-multi-zone.
AcceptLanguage	String	No	No	The language of the response.	None.
EipEnabled	Boolean	No	No	Specifies whether to enable public network access using an Elastic IP Address (EIP).	This parameter is valid only when ConnectionType is set to `single_eni`. Valid values: true: The setting is enabled. false: Disabled.
ChargeType	String	No	No	The billing method.	Valid values: PREPAY and POSTPAY. PREPAY is for subscription. POSTPAY is for pay-as-you-go. This parameter is ignored for Serverless clusters.
SecurityGroupType	String	No	No	The type of the security group to which the instance belongs.	This parameter is valid only when ConnectionType is set to `single_eni`.
MseVersion	String	No	No	Cluster version	Valid values: mse_dev: Developer Edition. mse_pro: Professional Edition.
PrivateSlbSpecification	String	No	No	The specification of the private SLB instance.	Valid values: slb.s1.small slb.s3.medium
VpcId	String	No	No	The ID of the VPC.	None.
PubNetworkFlow	String	No	No	The public bandwidth.	Valid values: 0 to 5000. Unit: Mbit/s. Note A value of 0 indicates that the cluster cannot be accessed from the public network.
VSwitchId	String	No	No	The vSwitch ID.	None.
PubSlbSpecification	String	No	No	The specification of the Internet-facing SLB instance.	Valid values: slb.s1.small slb.s3.medium
ClusterAliasName	String	No	Yes	The cluster alias.	Fuzzy match is supported.
ConnectionType	String	No	No	The network connection type.	None.
RequestPars	String	No	No	The extended request parameters.	The parameters must be in the JSON format.
AclEntryList	List	No	Yes	The whitelist.	Separate multiple IP addresses with commas (,).
Tags	List	No	Yes	The custom tags.	For more information, see Tags properties.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.

Tags syntax

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

Tags properties

Property	Type	Required	Allow updates	Description	Constraint
Key	String	Yes	No	The tag key.	The tag key can be 1 to 128 characters in length. The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
Value	String	No	No	The tag value.	The tag value can be 0 to 128 characters in length. The value cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.

Return values

Fn::GetAtt

InternetAddress: The public endpoint.
IntranetAddress: The private endpoint.
AclEntryList: The whitelist.
Cpu: The number of vCPUs.
InternetPort: The public port.
IntranetPort: The private port.
DiskType: The disk type.
AppVersion: The application version.
PayInfo: The billing method.
ClusterName: The cluster name.
IntranetDomain: The internal same-region endpoint.
NetType: The network type.
ClusterVersion: The cluster version.
InstanceId: The instance ID.
ClusterId: The cluster ID.
InternetDomain: The public endpoint.
AclId: The ID of the access control list (ACL).
VSwitchId: The vSwitch ID.
ClusterSpecification: The cluster specification.
HealthStatus: The health status.
MemoryCapacity: The memory capacity.
ClusterType: The cluster type.
ClusterAliasName: The cluster alias.
InstanceCount: The number of instances.
DiskCapacity: The disk capacity.
VpcId: The ID of the virtual private cloud (VPC).
PubNetworkFlow: The public bandwidth.
ConnectionType: The network connection type.
MseVersion: The cluster edition.
ConfigSecretEnabled: Indicates whether the configuration password is enabled.
MCPEnabled: Indicates whether the Mesh Configuration Protocol (MCP) is enabled.
ConfigAuthEnabled: Indicates whether configuration authentication is enabled for the cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test MSE Cluster
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
Resources:
  MseCluster:
    Type: ALIYUN::MSE::Cluster
    Properties:
      MseVersion: mse_pro
      InstanceCount: 3
      ClusterVersion: NACOS_2_0_0
      PubNetworkFlow: 1
      ClusterType: Nacos-Ans
      ClusterSpecification: MSE_SC_2_4_200_c
      NetType: pubnet
      DiskType: alicloud-disk-ssd-multi-zone
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      PubSlbSpecification: slb.s1.small
Outputs:
  InstanceId:
    Value:
      Fn::GetAtt:
        - MseCluster
        - InstanceId
  ClusterId:
    Value:
      Fn::GetAtt:
        - MseCluster
        - ClusterId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test MSE Cluster",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "MseCluster": {
      "Type": "ALIYUN::MSE::Cluster",
      "Properties": {
        "MseVersion": "mse_pro",
        "InstanceCount": 3,
        "ClusterVersion": "NACOS_2_0_0",
        "PubNetworkFlow": 1,
        "ClusterType": "Nacos-Ans",
        "ClusterSpecification": "MSE_SC_2_4_200_c",
        "NetType": "pubnet",
        "DiskType": "alicloud-disk-ssd-multi-zone",
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "PubSlbSpecification": "slb.s1.small"
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "MseCluster",
          "InstanceId"
        ]
      }
    },
    "ClusterId": {
      "Value": {
        "Fn::GetAtt": [
          "MseCluster",
          "ClusterId"
        ]
      }
    }
  }
}