ALIYUN::ElasticSearch::Instance - Create Elasticsearch instance in ROS - Resource Orchestration Service

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.	For more information, see DataNode properties.
Password	String	Yes	Yes	The instance password.	Must be 8 to 32 characters and contain at least three of the following: uppercase letters, lowercase letters, digits, and special characters (`!@#$%&*()_+-=`).
VSwitchId	String	Yes	No	The vSwitch ID.	None
Version	String	Yes	No	The Elasticsearch version to deploy.	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 instance description.	Must be 0 to 30 characters. Must start with a letter, digit, or Chinese character. Can contain letters, digits, Chinese characters, underscores (_), and hyphens (-).
DeleteType	String	No	No	The release type.	Valid values: immediate: The cluster is deleted immediately. All data is removed and the cluster disappears from the list. protective (default): Data is cleared after the instance is frozen for 24 hours. During this period, you can resume or immediately release the instance.
EnableKibanaPublic	Boolean	No	No	Whether to enable public network access for Kibana.	Valid values: true: Enabled. false (default): Disabled.
KibanaWhitelist	List	No	Yes	The Kibana IP address whitelist.	None
PublicWhitelist	List	No	Yes	The public IP address whitelist.	None
InstanceChargeType	String	No	No	The billing method.	Valid values: PrePaid: subscription. PostPaid (pay-as-you-go)
Period	Integer	No	No	The subscription duration.	Valid values: 1 (default) 2 3 4 5 6 7 8 9 12 24 36 Unit: months.
ResourceGroupId	String	No	Yes	The resource group ID.	None
EnablePublic	Boolean	No	Yes	Whether to enable the public endpoint.	Valid values: true: Enabled. false (default): Disabled.
PrivateWhitelist	List	No	Yes	The VPC IP address whitelist.	None
MasterNode	Map	No	Yes	The master node settings.	If specified, 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	Whether to enable private network access for Kibana.	Valid values: true: Enabled. false (default): Disabled.
ZoneCount	Integer	No	No	The number of zones for deployment.	Valid values: 1 (default) 2 3
KibanaNode	Map	No	No	The dedicated Kibana node settings.	None
ZoneId	String	No	No	The zone ID.	None
PeriodUnit	String	No	No	The subscription duration unit.	Valid values: Month Year
InstanceCategory	String	No	No	The instance edition.	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.	Valid values: 2 to 50.
DiskSize	Integer	Yes	Yes	The storage space per data node.	Valid values: If you set DiskType to cloud_ssd: 20 to 6144. If you set DiskType to cloud_efficiency: 20 to 20480. Values above 2,048 are limited to: 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 Note Storing more than 5,120 GB requires Elasticsearch 6.7 or 7.X, or Advanced Edition. If you set DiskType to cloud_essd: 20 to 6144. Unit: GB.
Spec	String	Yes	Yes	The data node specifications.	The specifications of elastic nodes. For more information about the specifications, see Node specifications.
DiskType	String	Yes	Yes	The data node disk type.	Valid values: cloud_ssd: Standard SSD. Suitable for online analysis and search scenarios requiring high IOPS and fast data responses. cloud_efficiency: Ultra disk. Cost-effective storage suitable for log and analysis scenarios with large data volumes. cloud_essd: Enterprise SSD. Low latency, high throughput. Suitable for latency-sensitive or I/O-intensive workloads.
DiskEncryption	Boolean	No	No	Whether to enable disk encryption.	Valid values: true: Enabled. false (default): Disabled.
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 master node specifications.	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 master node disk space.	Default value: 20.
DiskType	String	No	No	The master node disk type.	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.	Must be 1 to 128 characters. Cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
Value	String	No	No	The tag value.	Must be 0 to 128 characters. 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	Whether to enable the audit log index.	Valid values: true: Enables the audit log index. Audit logs record operations such as creation, deletion, modification, and queries. These logs consume disk space and affect performance. Use with caution. Configure audit logs. false (default): Disabled. Note Not supported for Elasticsearch 7.0 and later.
CreateIndex	String	No	No	Whether to automatically create indexes when a document is indexed to a non-existent index.	The corresponding configuration item in the YAML file is action.auto_create_index. Valid values: true: Automatic index creation is allowed. false (default): Automatic index creation is not allowed.
DestructiveRequiresName	Boolean	No	No	Whether an explicit index name is required 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 wildcard characters are allowed when deleting or closing indexes, batch deletion is possible. Deleted indexes cannot be restored. Use with caution.
OtherConfigs	Map	No	No	Other configurations.	Supported configuration items (compatible with Elasticsearch 5.x, 6.x, and 7.x unless noted otherwise): 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 size 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	Whether to enable Watcher.	The corresponding YAML configuration item is xpack.watcher.enabled. Valid values: true: Enables Watcher. Periodically clear `.watcher-history*` indexes to prevent excessive disk usage. false (default): Disabled.

KibanaNode syntax

"KibanaNode": {
  "Spec": String
}

KibanaNode properties

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

Return values

Fn::GetAtt

Status: The instance status.
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