Create a cluster by calling ALIYUN::MSE::Cluster - Resource Orchestration Service

Use ALIYUN::MSE::Cluster to create a cluster.

Syntax

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

Properties

Property name	Type	Required	Update allowed	Description	Constraints
ClusterSpecification	String	Yes	No	The engine specifications.	Valid values: MSE_GTW_2_4_200_c: 2 cores, 4 GB memory. MSE_GTW_4_8_200_c: 4 cores, 8 GB memory. MSE_GTW_8_16_200_c: 8 cores, 16 GB memory. MSE_GTW_16_32_200_c: 16 cores, 32 GB memory.
ClusterType	String	Yes	No	The type of the cluster.	Valid values: ZooKeeper Nacos-Ans Eureka
ClusterVersion	String	Yes	No	The version of the cluster.	Valid values: ZooKeeper_3_4_14 ZooKeeper_3_5_5 NACOS_ANS_1_2_1 NACOS_2_0_0
InstanceCount	Integer	Yes	No	The number of instances.	Valid values: 1 to 9.
NetType	String	Yes	No	The network type.	Valid values: privatenet: a virtual private cloud (VPC). pubnet: the public network.
AclEntryList	List	No	Yes	The whitelist.	Separate multiple IP addresses with commas (,).
ChargeType	String	No	No	The billing method.	Valid values are PREPAY (subscription) and POSTPAY (pay-as-you-go). This parameter is ignored for Serverless editions.
ClusterAliasName	String	No	Yes	The alias of the cluster.	Fuzzy match is supported.
ConnectionType	String	No	No	The network connection type.	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: Enabled. false: The setting is disabled.
MseVersion	String	No	No	The edition of the cluster.	Valid values: mse_dev: Developer Edition. mse_pro: Professional Edition.
PubNetworkFlow	Integer	No	No	The public bandwidth.	Valid values: 0 to 5000. Unit: Mbps. Note A value of 0 indicates that the cluster is not connected to the public network.
RequestPars	String	No	No	The extended request parameters.	The parameters are in JSON format.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
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`.
Tags	List	No	Yes	The custom tags.	For more information, see Tags properties.
VpcId	String	No	No	The ID of the VPC.	None
VSwitchId	String	No	No	The ID of the vSwitch.	None

Tags syntax

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

Tags properties

Property Name	Type	Required	Update allowed	Description	Constraints
Key	String	Yes	No	The tag key.	The value must be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
Value	String	No	No	The tag value.	The value can be 0 to 128 characters in length. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.

Return values

Fn::GetAtt

InternetAddress: The public endpoint.
IntranetAddress: The private endpoint.
AclEntryList: The whitelist.
Cpu: The number of CPU cores.
InternetPort: The interface that connects to the internet.
IntranetPort: The private network port.
AppVersion: The application version.
PayInfo: The billing method.
ClusterName: The name of the cluster.
IntranetDomain: The internal same-region endpoint.
NetType: The network type.
ClusterVersion: The version of the cluster.
InstanceId: The ID of the instance.
ClusterId: The ID of the cluster.
InternetDomain: the public domain name.
DiskType: The disk type.
AclId: The ID of the access control list.
VSwitchId: The ID of the vSwitch.
ClusterSpecification: The engine specifications.
HealthStatus: The health status.
MemoryCapacity: The memory capacity.
ClusterType: The type of the cluster.
ClusterAliasName: The alias of the cluster.
InstanceCount: The number of instances.
DiskCapacity: The disk capacity.
VpcId: The ID of the VPC.
PubNetworkFlow: The public bandwidth.
ConnectionType: The network connection type.
MseVersion: The edition of the cluster.
ConfigSecretEnabled: Indicates whether the configuration password is enabled.
MCPEnabled: Indicates whether Mesh Configuration Protocol (MCP) is enabled.
ConfigAuthEnabled: Specifies whether cluster configuration is enabled.
Arn: The Alibaba Cloud Resource Name (ARN).

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
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
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",
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "MseCluster",
          "InstanceId"
        ]
      }
    },
    "ClusterId": {
      "Value": {
        "Fn::GetAtt": [
          "MseCluster",
          "ClusterId"
        ]
      }
    }
  }
}