All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::Lindorm::MultiZoneInstance

Last Updated:Sep 14, 2024

ALIYUN::Lindorm::MultiZoneInstance is used to create a multi-zone Lindorm instance.

Syntax

{
  "Type": "ALIYUN::Lindorm::MultiZoneInstance",
  "Properties": {
    "StandbyZoneId": String,
    "ResourceGroupId": String,
    "InstanceChargeType": String,
    "LogDiskCategory": String,
    "StandbyVSwitchId": String,
    "SolrNum": Integer,
    "SolrSpec": String,
    "CoreSpec": String,
    "FilestoreSpec": String,
    "TsdbNum": Integer,
    "ArbiterZoneId": String,
    "PrimaryZoneId": String,
    "MultiZoneCombination": String,
    "CoreSingleStorage": Integer,
    "ColdStorage": Integer,
    "DiskCategory": String,
    "LogSpec": String,
    "Period": Integer,
    "PrimaryVSwitchId": String,
    "ArbiterVSwitchId": String,
    "InstanceName": String,
    "FilestoreNum": Integer,
    "VpcId": String,
    "SecurityIpList": List,
    "LindormSpec": String,
    "TsdbSpec": String,
    "LogSingleStorage": Integer,
    "LindormNum": Integer,
    "LogNum": Integer,
    "PeriodUnit": String,
    "StreamSpec": String,
    "StreamNum": Integer
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

StandbyZoneId

String

No

No

The ID of the secondary zone of the instance.

None.

ResourceGroupId

String

No

No

The ID of the resource group.

None.

InstanceChargeType

String

No

No

The billing method of the instance.

Valid values:

  • PREPAY: subscription

  • POSTPAY: pay-as-you-go

LogDiskCategory

String

No

No

The storage type of disks that you want to use for log nodes in the instance.

Valid values:

  • cloud_efficiency: standard storage

  • cloud_ssd: performance-optimized storage

StandbyVSwitchId

String

No

No

The ID of the vSwitch that resides in the secondary zone.

The vSwitch must reside in the zone that is specified by StandbyZoneId.

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

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

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.

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.

ArbiterZoneId

String

No

No

The ID of the zone in which the coordinate node of the instance resides.

None.

PrimaryZoneId

String

No

No

The ID of the primary zone.

None.

MultiZoneCombination

String

No

No

The combination of zones that are available for the instance.

Valid values:

  • ap-southeast-5abc-aliyun: Jakarta Zone A, B, and C

  • cn-hangzhou-ehi-aliyun: Hangzhou Zone E, H, and I

  • cn-beijing-acd-aliyun: Beijing Zone A, C, and D

  • ap-southeast-1-abc-aliyun: Singapore Zone A, B, and C

  • cn-zhangjiakou-abc-aliyun: Zhangjiakou Zone A, B, and C

  • cn-shanghai-efg-aliyun: Shanghai Zone E, F, and G

  • cn-shanghai-abd-aliyun: Shanghai Zone A, B, and D

  • cn-hangzhou-bef-aliyun: Hangzhou Zone B, E, and F

  • cn-hangzhou-bce-aliyun: Hangzhou Zone B, C, and E

  • cn-beijing-fgh-aliyun: Beijing Zone F, G, and H

  • cn-shenzhen-abc-aliyun: Shenzhen Zone A, B, and C

CoreSingleStorage

Integer

No

No

The storage capacity of the disk of a core node.

Valid values: 400 to 64000.

Unit: GB.

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.

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

LogSpec

String

No

No

The specification of the log nodes.

Valid values:

  • lindorm.sn1.large: dedicated specification of 4 vCPUs and 8 GB memory

  • lindorm.sn1.2xlarge: dedicated specification of 8 vCPUs and 16 GB memory

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 this property when InstanceChargeType is set to PREPAY.

PrimaryVSwitchId

String

No

No

The ID of the vSwitch that resides in the primary zone.

The vSwitch must reside in the zone that is specified by PrimaryZoneId.

ArbiterVSwitchId

String

No

No

The ID of the vSwitch that resides in the zone of the coordinate node.

The vSwitch must reside in the zone that is specified by ArbiterZoneId.

InstanceName

String

Yes

No

The instance name.

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.

VpcId

String

Yes

No

The ID of the virtual private cloud (VPC) in which the instance resides.

None.

SecurityIpList

List

No

Yes

The IP addresses or CIDR blocks 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 192.168.0.X format to access the Lindorm instance. Separate multiple segments in the whitelist with commas (,).

LindormSpec

String

No

No

The specification of the 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

LogSingleStorage

Integer

No

No

The storage capacity of the disk of a log node.

Valid values: 400 to 64000.

Unit: GB.

LindormNum

Integer

No

No

The number of LindormTable nodes in the instance.

Valid values when the instance is attached with non-local disks: 4 to 400.

Valid values when the instance is attached with local disks: 6 to 400.

LogNum

Integer

No

No

The number of log nodes.

Valid values: 4 to 400.

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.

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 format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  StandbyZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  ArbiterZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  PrimaryZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  StandbyVSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${StandbyZoneId}
      VpcId: ${VpcId}
  PrimaryVSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${PrimaryZoneId}
      VpcId: ${VpcId}
  ArbiterVSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ArbiterZoneId}
      VpcId: ${VpcId}
Resources:
  MultiZoneInstance:
    Type: ALIYUN::Lindorm::MultiZoneInstance
    Properties:
      PrimaryVSwitchId:
        Ref: PrimaryVSwitchId
      ArbiterVSwitchId:
        Ref: ArbiterVSwitchId
      LogSpec: lindorm.sn1.large
      CoreSingleStorage: 400
      LogDiskCategory: cloud_efficiency
      ArbiterZoneId:
        Ref: ArbiterZoneId
      PrimaryZoneId:
        Ref: PrimaryZoneId
      StandbyZoneId:
        Ref: StandbyZoneId
      InstanceChargeType: POSTPAY
      StandbyVSwitchId:
        Ref: StandbyVSwitchId
      DiskCategory: cloud_efficiency
      InstanceName: TestLindormDB
      VpcId:
        Ref: VpcId
      LindormSpec: lindorm.c.2xlarge
      LindormNum: 4
      LogNum: 4
      LogSingleStorage: 400
Outputs:
  JdbcUrlList:
    Description: The list of the jdbc connection address.
    Value:
      Fn::GetAtt:
        - MultiZoneInstance
        - JdbcUrlList
  InstanceId:
    Description: The ID of the Lindorm instance that is created.
    Value:
      Fn::GetAtt:
        - MultiZoneInstance
        - InstanceId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "StandbyZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "ArbiterZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "PrimaryZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "StandbyVSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${StandbyZoneId}",
        "VpcId": "${VpcId}"
      }
    },
    "PrimaryVSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${PrimaryZoneId}",
        "VpcId": "${VpcId}"
      }
    },
    "ArbiterVSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ArbiterZoneId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "MultiZoneInstance": {
      "Type": "ALIYUN::Lindorm::MultiZoneInstance",
      "Properties": {
        "PrimaryVSwitchId": {
          "Ref": "PrimaryVSwitchId"
        },
        "ArbiterVSwitchId": {
          "Ref": "ArbiterVSwitchId"
        },
        "LogSpec": "lindorm.sn1.large",
        "CoreSingleStorage": 400,
        "LogDiskCategory": "cloud_efficiency",
        "ArbiterZoneId": {
          "Ref": "ArbiterZoneId"
        },
        "PrimaryZoneId": {
          "Ref": "PrimaryZoneId"
        },
        "StandbyZoneId": {
          "Ref": "StandbyZoneId"
        },
        "InstanceChargeType": "POSTPAY",
        "StandbyVSwitchId": {
          "Ref": "StandbyVSwitchId"
        },
        "DiskCategory": "cloud_efficiency",
        "InstanceName": "TestLindormDB",
        "VpcId": {
          "Ref": "VpcId"
        },
        "LindormSpec": "lindorm.c.2xlarge",
        "LindormNum": 4,
        "LogNum": 4,
        "LogSingleStorage": 400
      }
    }
  },
  "Outputs": {
    "JdbcUrlList": {
      "Description": "The list of the jdbc connection address.",
      "Value": {
        "Fn::GetAtt": [
          "MultiZoneInstance",
          "JdbcUrlList"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the Lindorm instance that is created.",
      "Value": {
        "Fn::GetAtt": [
          "MultiZoneInstance",
          "InstanceId"
        ]
      }
    }
  }
}