What is ALIYUN::Lindorm::Instance of Lindorm - Resource Orchestration Service

ALIYUN::Lindorm::Instance is used to create a Lindorm instance.

Syntax

{
  "Type": "ALIYUN::Lindorm::Instance",
  "Properties": {
    "InstanceStorage": Integer,
    "ResourceGroupId": String,
    "ZoneId": String,
    "InstanceChargeType": String,
    "VSwitchId": String,
    "ColdStorage": Integer,
    "Period": Integer,
    "DiskCategory": String,
    "InstanceName": String,
    "SolrNum": Integer,
    "SolrSpec": String,
    "VpcId": String,
    "FilestoreNum": Integer,
    "SecurityIpList": List,
    "LindormSpec": String,
    "TsdbSpec": String,
    "CoreSpec": String,
    "LindormNum": Integer,
    "TsdbNum": Integer,
    "FilestoreSpec": String,
    "PeriodUnit": String,
    "StreamSpec": String,
    "StreamNum": Integer,
    "DeletionProtection": Boolean
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
InstanceStorage	Integer	No	No	The storage capacity of the instance.	Unit: GB.
ResourceGroupId	String	No	No	The ID of the resource group.	None.
ZoneId	String	No	No	The zone ID of the instance.	None.
InstanceChargeType	String	No	No	The billing method of the instance.	Valid values: PREPAY: subscription POSTPAY: pay-as-you-go
VSwitchId	String	No	No	The vSwitch ID.	None.
ColdStorage	Integer	No	No	The cold storage capacity of the instance.	If you leave ColdStorage empty, cold storage is not enabled by default. Unit: GB. Valid values: 800 to 1000000.
Period	Integer	No	No	The subscription duration of the instance.	Valid values when PeriodUnit is set to Month: 1 to 9. Valid values when PeriodUnit is set to Year: 1 to 3. Note You must specify Period when InstanceChargeType is set to PREPAY.
DiskCategory	String	Yes	No	The storage type of the instance.	Valid values: cloud_efficiency: standard storage cloud_ssd: performance-optimized storage capacity_cloud_storage: capacity-optimized storage local_ssd_pro: local SSD local_hdd_pro: local HDD
InstanceName	String	Yes	No	The instance name.	None.
SolrNum	Integer	No	No	The number of LindormSearch nodes in the instance.	Valid values: 0 to 60.
SolrSpec	String	No	No	The specification of LindormSearch nodes in the instance.	Valid values: lindorm.g.xlarge: dedicated specification of 4 vCPUs and 16 GB memory lindorm.g.2xlarge: dedicated specification of 8 vCPUs and 32 GB memory lindorm.g.4xlarge: dedicated specification of 16 vCPUs and 64 GB memory lindorm.g.8xlarge: dedicated specification of 32 vCPUs and 128 GB memory
VpcId	String	Yes	No	The ID of the virtual private cloud (VPC) in which the instance resides.	None.
FilestoreNum	Integer	No	No	The number of LindormDFS nodes in the instance.	Valid values when InstanceChargeType is set to PREPAY: 0 to 60. Valid values when InstanceChargeType is set to POSTPAY: 0 to 8.
SecurityIpList	List	No	Yes	The IP addresses that you want to add to the whitelist.	Note If the whitelist includes the IP address 127.0.0.1, no IP addresses are allowed to access the Lindorm instance. If you add the CIDR block 192.168.0.0/24 to the whitelist, you can use all IP addresses in the CIDR block to access the Lindorm instance. Separate multiple segments in the whitelist with commas (,).
LindormSpec	String	No	No	The specification of LindormTable nodes in the instance.	Valid values: lindorm.g.xlarge: dedicated specification of 4 vCPUs and 16 GB memory lindorm.c.2xlarge: dedicated specification of 8 vCPUs and 16 GB memory lindorm.g.2xlarge: dedicated specification of 8 vCPUs and 32 GB memory lindorm.c.4xlarge: dedicated specification of 16 vCPUs and 32 GB memory lindorm.g.4xlarge: dedicated specification of 16 vCPUs and 64 GB memory lindorm.c.8xlarge: dedicated specification of 32 vCPUs and 64 GB memory lindorm.g.8xlarge: dedicated specification of 32 vCPUs and 128 GB memory
TsdbSpec	String	No	No	The specification of LindormTSDB nodes in the instance.	Valid values: lindorm.g.xlarge: dedicated specification of 4 vCPUs and 16 GB memory lindorm.g.2xlarge: dedicated specification of 8 vCPUs and 32 GB memory lindorm.g.4xlarge: dedicated specification of 16 vCPUs and 64 GB memory lindorm.g.8xlarge: dedicated specification of 32 vCPUs and 128 GB memory lindorm.r.8xlarge: dedicated specification of 32 vCPUs and 256 GB memory
CoreSpec	String	No	No	The specification of nodes in the instance when DiskCategory is set to local_ssd_pro or local_hdd_pro.	Valid values when DiskCategory is set to local_ssd_pro: lindorm.i2.xlarge: dedicated specification of 4 vCPUs and 32 GB memory lindorm.i2.2xlarge: dedicated specification of 8 vCPUs and 64 GB memory lindorm.i2.4xlarge: dedicated specification of 16 vCPUs and 128 GB memory lindorm.i2.8xlarge: dedicated specification of 32 vCPUs and 256 GB memory Valid values when DiskCategory is set to local_hdd_pro: lindorm.d2c.6xlarge: dedicated specification of 24 vCPUs and 88 GB memory lindorm.d2c.12xlarge: dedicated specification of 48 vCPUs and 176 GB memory lindorm.d2c.24xlarge: dedicated specification of 96 vCPUs and 352 GB memory lindorm.d2s.5xlarge: dedicated specification of 20 vCPUs and 88 GB memory lindorm.d2s.10xlarge: dedicated specification of 40 vCPUs and 176 GB memory lindorm.d1.2xlarge: dedicated specification of 8 vCPUs and 32 GB memory lindorm.d1.4xlarge: dedicated specification of 16 vCPUs and 64 GB memory lindorm.d1.6xlarge: dedicated specification of 24 vCPUs and 96 GB memory
LindormNum	Integer	No	No	The number of LindormTable nodes in the instance.	Valid values when you create a single-zone instance: 0 to 90.
TsdbNum	Integer	No	No	The number of LindormTSDB nodes in the instance.	Valid values when InstanceChargeType is set to PREPAY: 0 to 24. Valid values when InstanceChargeType is set to POSTPAY: 0 to 32.
FilestoreSpec	String	No	No	The specification of LindormDFS nodes in the instance.	Set the value to lindorm.c.xlarge. A value of lindorm.c.xlarge specifies a standard specification of 4 vCPUs and 8 GB memory.
PeriodUnit	String	No	No	The unit of the subscription duration of the instance.	Valid values: Month Year Note You must specify this property when InstanceChargeType is set to PREPAY.
StreamSpec	String	No	No	The specification of Lindorm streaming engine nodes in the instance.	Valid values: lindorm.g.xlarge: dedicated specification of 4 vCPUs and 16 GB memory lindorm.c.2xlarge: dedicated specification of 8 vCPUs and 16 GB memory lindorm.g.2xlarge: dedicated specification of 8 vCPUs and 32 GB memory lindorm.c.4xlarge: dedicated specification of 16 vCPUs and 32 GB memory lindorm.g.4xlarge: dedicated specification of 16 vCPUs and 64 GB memory lindorm.c.8xlarge: dedicated specification of 32 vCPUs and 64 GB memory lindorm.g.8xlarge: dedicated specification of 32 vCPUs and 128 GB memory
StreamNum	Integer	No	No	The number of Lindorm streaming engine nodes in the instance.	Valid values: 0 to 60.
DeletionProtection	Boolean	No	Yes	Specifies whether to enable deletion protection.	Valid values: true false

Return values

Fn::GetAtt

JdbcUrlList: the Java Database Connectivity (JDBC) endpoints of databases.
InstanceId: the instance ID.
AuthInfos: the authorization information about the instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
Resources:
  LindormInstance:
    Type: ALIYUN::Lindorm::Instance
    Properties:
      InstanceStorage: 480
      ZoneId:
        Ref: ZoneId
      InstanceChargeType: POSTPAY
      VSwitchId:
        Ref: VSwitchId
      DiskCategory: cloud_efficiency
      InstanceName: TestLindormDB
      VpcId:
        Ref: VpcId
      LindormSpec: lindorm.c.2xlarge
      LindormNum: 2
Outputs:
  JdbcUrlList:
    Description: The list of the jdbc connection address.
    Value:
      Fn::GetAtt:
        - LindormInstance
        - JdbcUrlList
  InstanceId:
    Description: The ID of the Lindorm instance that is created.
    Value:
      Fn::GetAtt:
        - LindormInstance
        - InstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "LindormInstance": {
      "Type": "ALIYUN::Lindorm::Instance",
      "Properties": {
        "InstanceStorage": 480,
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "InstanceChargeType": "POSTPAY",
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DiskCategory": "cloud_efficiency",
        "InstanceName": "TestLindormDB",
        "VpcId": {
          "Ref": "VpcId"
        },
        "LindormSpec": "lindorm.c.2xlarge",
        "LindormNum": 2
      }
    }
  },
  "Outputs": {
    "JdbcUrlList": {
      "Description": "The list of the jdbc connection address.",
      "Value": {
        "Fn::GetAtt": [
          "LindormInstance",
          "JdbcUrlList"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the Lindorm instance that is created.",
      "Value": {
        "Fn::GetAtt": [
          "LindormInstance",
          "InstanceId"
        ]
      }
    }
  }
}