Use ALIYUN::ElasticSearch::Instance to create an Elasticsearch instance - Resource Orchestration Service

The ALIYUN::ElasticSearch::Instance resource is used to create an Elasticsearch instance.

Syntax

{
  "Type": "ALIYUN::ElasticSearch::Instance",
  "Properties": {
    "KibanaWhitelist": List,
    "PublicWhitelist": List,
    "VSwitchId": String,
    "InstanceChargeType": String,
    "Period": Integer,
    "Version": String,
    "DataNode": Map,
    "PrivateWhitelist": List,
    "ResourceGroupId": String,
    "EnablePublic": Boolean,
    "Password": String,
    "MasterNode": Map,
    "Tags": List,
    "Description": String,
    "EnableKibanaPublic": Boolean,
    "YMLConfig": Map,
    "EnableKibanaPrivate": Boolean,
    "ZoneCount": Integer,
    "KibanaNode": Map,
    "ZoneId": String,
    "PeriodUnit": String,
    "InstanceCategory": String,
    "DeleteType": String
  }
}

Properties

Property Name	Type	Required	Update allowed	Description	Constraints
DataNode	Map	Yes	Yes	The data node settings of the Elasticsearch cluster.	For more information, see DataNode properties.
Password	String	Yes	Yes	The password of the instance.	The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: `!@#$%&*()_+-=`.
VSwitchId	String	Yes	No	The ID of the vSwitch.	None
Version	String	Yes	No	The Elasticsearch version.	Valid values: 7.10_with_X-Pack 6.7_with_X-Pack 6.7_with_X-Pack 7.7_with_X-Pack 6.8_with_X-Pack 6.3_with_X-Pack 5.6_with_X-Pack 5.5.3_with_X-Pack
Description	String	No	Yes	The description of the instance.	The description must be 0 to 30 characters in length. It must start with a letter, digit, or Chinese character. It can contain letters, digits, Chinese characters, underscores (_), and hyphens (-).
DeleteType	String	No	No	The release type.	Valid values: immediate: The cluster is immediately deleted after it is released. After the cluster is deleted, the data stored in the cluster is deleted and the system removes the cluster from the Logstash cluster list. protective (default): The data is completely cleared only after the instance is frozen for 24 hours. During this period, the instance is still displayed in the instance list. You can resume the instance or release it immediately.
EnableKibanaPublic	Boolean	No	No	Specifies whether to enable public network access for Kibana.	Valid values: true: Enabled. false (default): The feature is disabled.
KibanaWhitelist	List	No	Yes	The IP address whitelist of Kibana.	None
PublicWhitelist	List	No	Yes	The public IP address whitelist of the instance.	None
InstanceChargeType	String	No	No	The billing method of the instance.	Valid values: PrePaid: subscription. PostPaid (pay-as-you-go)
Period	Integer	No	No	The subscription duration of the Elasticsearch instance.	Valid values: 1 (default) 2 3 4 5 6 7 8 9 12 24 36 Unit: months.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
EnablePublic	Boolean	No	Yes	Specifies whether to enable the public endpoint of the instance.	Valid values: true: It is enabled. false (default): The feature is disabled.
PrivateWhitelist	List	No	Yes	The IP address whitelist for accessing the instance in a virtual private cloud (VPC).	None
MasterNode	Map	No	Yes	The settings of the master node.	If you specify this parameter, a dedicated master node is created. For more information, see MasterNode properties.
Tags	List	No	Yes	The tags.	You can add up to 20 tags. For more information, see Tags properties.
YMLConfig	Map	No	No	The YAML file configuration.	For more information, see YMLConfig properties.
EnableKibanaPrivate	Boolean	No	No	Specifies whether to enable private network access for Kibana.	Valid values: true: The functionality is enabled. false (default): The feature is disabled.
ZoneCount	Integer	No	No	The number of zones in which the instance is deployed.	Valid values: 1 (default) 2 3
KibanaNode	Map	No	No	The settings of the dedicated Kibana node.	None
ZoneId	String	No	No	The ID of the zone.	None
PeriodUnit	String	No	No	The unit of the subscription duration.	Valid values: Month: The calendar month. Year:
InstanceCategory	String	No	No	The version type of the instance.	Valid values: x-pack: Creates a Commercial Edition instance or a Kernel-enhanced Edition instance for which Indexing Service and OpenStore are disabled. IS: Creates a Kernel-enhanced Edition instance for which Indexing Service or OpenStore is enabled.

DataNode syntax

"DataNode": {
  "Amount": Integer,
  "DiskSize": Integer,
  "Spec": String,
  "DiskType": String,
  "DiskEncryption": Boolean,
  "PerformanceLevel": String
}

DataNode properties

Property Name	Type	Required	Update allowed	Description	Constraints
Amount	Integer	Yes	Yes	The number of data nodes in the Elasticsearch cluster.	Valid values: 2 to 50.
DiskSize	Integer	Yes	Yes	The storage space of a single data node.	Valid values: If you set DiskType to cloud_ssd: 20 to 6144. If you set DiskType to cloud_efficiency: 20 to 20480. If you want to store more than 2,048 GB of data, only the following values are supported for this parameter: 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 Note If you want to store more than 5,120 GB of data, the Elasticsearch version must be 6.7 or 7.X, or the instance must be of the Advanced Edition. If you set DiskType to cloud_essd: 20 to 6144. Unit: GB.
Spec	String	Yes	Yes	The specifications of the data nodes of the Elasticsearch instance.	The specifications of elastic nodes. For more information about the specifications, see Node specifications.
DiskType	String	Yes	Yes	The disk type of the data node.	Valid values: cloud_ssd: standard SSD. This disk type is suitable for online analysis and search scenarios that require high IOPS and high data responsiveness. cloud_efficiency: ultra disk. This disk type provides cost-effective storage and is suitable for log and analysis scenarios that involve large data volumes. cloud_essd: enterprise SSD. This disk type features low latency, fast responses, and high throughput. It is suitable for latency-sensitive applications or I/O-intensive business scenarios.
DiskEncryption	Boolean	No	No	Specifies whether to enable disk encryption.	Valid values: true: Indicates an enabled state. false (default): Disables the setting.
PerformanceLevel	String	No	No	The performance level (PL) of the enterprise SSD.	This parameter is required if you set DiskType to cloud_essd. Valid values: PL1 PL2 PL3

MasterNode syntax

"MasterNode": {
  "Amount": Integer,
  "DiskSize": Integer,
  "Spec": String,
  "DiskType": String
}

MasterNode properties

Property Name	Type	Required	Update allowed	Description	Constraints
Spec	String	Yes	No	The specifications of the master node.	The specifications of the dedicated master node. For more information about the specifications, see Node specifications.
Amount	Integer	No	Yes	The number of master nodes.	Default value: 3.
DiskSize	Integer	No	No	The disk space of the master node.	Default value: 20.
DiskType	String	No	No	The disk type of the master node.	Valid values: cloud_ssd: standard SSD cloud_essd (default): enterprise SSD

Tags syntax

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

Tags properties

Property Name	Type	Required	Update allowed	Description	Constraints
Key	String	Yes	No	The tag key.	The key can be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:` and 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:` and cannot contain `http://` or `https://`.

YMLConfig syntax

"YMLConfig": {
    "CreateIndex": String,
    "Watcher": String,
    "DestructiveRequiresName": Boolean,
    "AuditLog": Boolean,
    "OtherConfigs": Map
  }

YMLConfig properties

Property Name	Type	Required	Update allowed	Description	Constraints
AuditLog	Boolean	No	No	Specifies whether to enable the audit log index.	Valid values: true: enables the audit log index. If you enable the audit log index, the system records the audit logs that are generated for operations such as the creation, deletion, modification, and query of the Elasticsearch instance. The log information consumes disk space and affects performance. We recommend that you do not enable this feature. Use this configuration with caution. For more information, see Configure audit logs. false (default): Shutdown. Note This parameter is not supported for Elasticsearch 7.0 and later versions.
CreateIndex	String	No	No	Specifies whether to allow the system to automatically create an index if the corresponding index does not exist after the Elasticsearch instance receives a new file.	The corresponding configuration item in the YAML file is action.auto_create_index. Valid values: true: allows the system to automatically create an index. false (default): does not allow the system to automatically create an index.
DestructiveRequiresName	Boolean	No	No	Do I have to specify an index name to delete an index?	The corresponding configuration item in the YAML file is action.destructive_requires_name. Valid values: true (default): You must explicitly specify the index name when you delete an index. false: You do not need to explicitly specify the index name when you delete an index. Note If you allow the use of wildcard characters for the index name when you delete or close an index, you can use a wildcard character to delete indexes in batches. Deleted indexes cannot be restored. Use this configuration with caution.
OtherConfigs	Map	No	No	Other configurations.	The following configuration items are supported. Unless otherwise specified, the configuration items are compatible with Elasticsearch 5.x, 6.x, and 7.x. Configure CORS access http.cors.enabled http.cors.allow-origin http.cors.max-age http.cors.allow-methods http.cors.allow-headers http.cors.allow-credentials Configure a reindex whitelist reindex.remote.whitelist Configure audit logs xpack.security.audit.enabled xpack.security.audit.index.bulk_size xpack.security.audit.index.flush_interval xpack.security.audit.index.rollover xpack.security.audit.index.events.include xpack.security.audit.index.events.exclude xpack.security.audit.index.events.emit_request_body Configure queue sizes thread_pool.bulk.queue_size (for Elasticsearch 5.x) thread_pool.write.queue_size (for Elasticsearch 6.x and 7.x) thread_pool.search.queue_size Custom SQL plugin configuration xpack.sql.enabled: By default, an Elasticsearch instance uses the SQL plugin that comes with X-Pack. If you want to upload a custom SQL plugin, set xpack.sql.enabled to false.
Watcher	Boolean	No	No	Specifies whether to enable Watcher.	The corresponding configuration item in the YAML file is xpack.watcher.enabled. Valid values: true: enables Watcher. After you enable Watcher, you can use the Watcher feature of X-Pack. Periodically clear the `.watcher-history*` indexes to prevent the indexes from occupying a large amount of disk space. false (default): Shutdown.

KibanaNode syntax

"KibanaNode": {
  "Spec": String
}

KibanaNode properties

Property Name	Type	Required	Update allowed	Description	Constraints
Spec	String	Yes	No	The specifications of the dedicated Kibana node.	None

Return values

Fn::GetAtt

Status: The status of the Elasticsearch instance.
KibanaDomain: The Kibana endpoint.
PublicDomain: The public endpoint of the instance.
Domain: The internal endpoint of the instance.
InstanceId: The ID of the Elasticsearch instance.
KibanaPort: The Kibana access port.
Port: The connection port of the instance.
VSwitchId: The ID of the vSwitch.
Version: The version of the instance.
InstanceChargeType: The billing method of the instance.
Arn: The Alibaba Cloud Resource Name (ARN).

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Description: Test ElasticSearch Instance
Parameters:
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
Resources:
  Instance:
    Type: ALIYUN::ElasticSearch::Instance
    Properties:
      DataNode:
        Spec: elasticsearch.sn1ne.large
        Amount: 2
        DiskSize: 20
        DiskType: cloud_essd
      InstanceChargeType: PostPaid
      Version: 7.10_with_X-Pack
      VSwitchId:
        Ref: VSwitchId
      Password: Admin@123!
Outputs: {}

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ElasticSearch Instance",
  "Parameters": {
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId"
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ElasticSearch::Instance",
      "Properties": {
        "DataNode": {
          "Spec": "elasticsearch.sn1ne.large",
          "Amount": 2,
          "DiskSize": 20,
          "DiskType": "cloud_essd"
        },
        "InstanceChargeType": "PostPaid",
        "Version": "7.10_with_X-Pack",
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Password": "Admin@123!"
      }
    }
  },
  "Outputs": {
  }
}

Syntax

Properties

DataNode syntax

DataNode properties

MasterNode syntax

MasterNode properties

Tags syntax

Tags properties

YMLConfig syntax

YMLConfig properties

KibanaNode syntax

KibanaNode properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format