ALIYUN::SearchEngine::Instance is used to create an OpenSearch instance that uses the HA3 architecture.

Syntax

{
  "Type": "ALIYUN::SearchEngine::Instance",
  "Properties": {
    "QrsNum": Integer,
    "QrsSpec": String,
    "UserName": String,
    "VpcId": String,
    "SearcherSpec": String,
    "ChargeType": String,
    "VSwitchId": String,
    "SearcherNum": Integer,
    "SearcherDocSize": Integer,
    "Password": String
  }
}

Properties

Property Type Required Editable Description Constraint
QrsNum Integer Yes No The number of Query Result Searcher (QRS) workers. None
QrsSpec String Yes No The specifications of QRS workers. None
UserName String Yes No The name of the user. None
VpcId String Yes No The ID of the virtual private cloud (VPC). None
SearcherSpec String Yes No The specifications of searcher workers. None
ChargeType String Yes No The billing method of the instance. Valid value:

Postpay: pay-as-you-go

VSwitchId String Yes No The ID of the vSwitch. None
SearcherNum Integer Yes No The number of searcher workers. None
SearcherDocSize Integer Yes No The storage space of each searcher worker. None
Password String Yes No The password of the user. None

Response parameters

Fn::GetAtt

  • Endpoint: the endpoint of the instance.
  • InstanceId: the ID of the instance.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QrsNum": {
      "Type": "Number",
      "Description": "The number of query nodes.",
      "MinValue": 1
    },
    "QrsSpec": {
      "Type": "String",
      "Description": "The specification of query nodes."
    },
    "UserName": {
      "Type": "String",
      "Description": "The user name of instance. Begin with a letter, support upper and lower case letters, numbers, underscores, length 1-30 characters.",
      "MinLength": 1,
      "MaxLength": 30
    },
    "VpcId": {
      "Type": "String",
      "Description": "The ID of VPC."
    },
    "SearcherSpec": {
      "Type": "String",
      "Description": "The specification of data nodes."
    },
    "ChargeType": {
      "Type": "String",
      "Description": "The billing method. Valid values: POSTPAY.\nPOSTPAY: pay-as-you-go.",
      "AllowedValues": [
        "POSTPAY"
      ],
      "Default": "POSTPAY"
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The ID of vSwitch."
    },
    "SearcherNum": {
      "Type": "Number",
      "Description": "The number of data nodes.",
      "MinValue": 1
    },
    "SearcherDocSize": {
      "Type": "Number",
      "Description": "The storage size of single data node."
    },
    "Password": {
      "Type": "String",
      "Description": "The password of instance. It consists of lowercase letters and numbers, and the length is 6-8 characters."
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::SearchEngine::Instance",
      "Properties": {
        "QrsNum": {
          "Ref": "QrsNum"
        },
        "QrsSpec": {
          "Ref": "QrsSpec"
        },
        "UserName": {
          "Ref": "UserName"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "SearcherSpec": {
          "Ref": "SearcherSpec"
        },
        "ChargeType": {
          "Ref": "ChargeType"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "SearcherNum": {
          "Ref": "SearcherNum"
        },
        "SearcherDocSize": {
          "Ref": "SearcherDocSize"
        },
        "Password": {
          "Ref": "Password"
        }
      }
    }
  },
  "Outputs": {
    "Endpoint": {
      "Description": "The endpoint of instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Endpoint"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    }
  }
}