調用ALIYUN::Elasticsearch::Instance建立Elasticsearch執行個體 -

ALIYUN::Elasticsearch::Instance類型用於建立Elasticsearch執行個體。

文法

{
  "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
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
KibanaWhitelist	List	否	是	Kibana的IP白名單列表。	無
PublicWhitelist	List	否	是	執行個體的公網IP白名單列表。	無
VSwitchId	String	是	否	交換器ID。	無
InstanceChargeType	String	否	否	執行個體付費類型。	取值： PrePaid：預付費。 PostPaid：後付費。
Period	Integer	否	否	購買Elasticsearch執行個體的期間。	取值： 1（預設值） 2 3 4 5 6 7 8 9 12 24 36 單位：月。
Version	String	是	否	Elasticsearch版本。	取值： 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
ResourceGroupId	String	否	是	資源群組ID。	無
EnablePublic	Boolean	否	是	是否開啟執行個體的公網地址。	取值： true：開啟。 false（預設值）：關閉。
DataNode	Map	是	是	Elasticsearch叢集的資料節點設定。	更多資訊，請參見DataNode屬性。
PrivateWhitelist	List	否	是	在專用網路中設定執行個體的IP白名單列表。	無
Password	String	是	是	執行個體的密碼。	長度為8~32個字元，必須同時包含大寫英文字母、小寫英文字母、數字和特殊字元中的三項。支援的特殊字元為：`!@#$%&*()_+-=`。
MasterNode	Map	否	是	主節點設定。	如果指定該參數，將建立專用主節點。更多資訊，請參見MasterNode屬性。
Tags	List	否	是	標籤。	最多支援添加20個標籤。更多資訊，請參見Tags屬性。
Description	String	否	是	執行個體的描述。	長度為0~30個字元，必須以英文字母、數字或漢字開頭，可包含英文字母、數字、漢字、底線（_）和短劃線（-）。
EnableKibanaPublic	Boolean	否	否	是否開啟Kibana公網訪問。	取值： true：開啟。 false（預設值）：關閉。
YMLConfig	Map	否	否	YAML檔案配置。	更多資訊，請參見YMLConfig屬性。
EnableKibanaPrivate	Boolean	否	否	是否開啟Kibana私網訪問。	取值： true：開啟。 false（預設值）：關閉。
ZoneCount	Integer	否	否	執行個體的可用性區域個數。	取值： 1（預設值） 2 3
KibanaNode	Map	否	否	Kibana專用節點設定。	無
ZoneId	String	否	否	可用性區域ID。	無
PeriodUnit	String	否	否	訂用帳戶計費方式的時間長度單位。	取值： Month：月。 Year：年。
InstanceCategory	String	否	否	執行個體版本類型。	取值： x-pack：建立商業版執行個體，或不開啟Indexing Service和OpenStore的核心增強版執行個體。 IS：建立開啟Indexing Service或OpenStore的核心增強版執行個體。

DataNode文法

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

DataNode屬性

屬性名稱	類型	必須	允許更新	描述	約束
Amount	Integer	是	是	Elasticsearch叢集的資料節點數量。	取值範圍：2~50。
DiskSize	Integer	是	是	單資料節點儲存空間。	取值範圍：當DiskType取值為cloud_ssd時：20~6144。當DiskType取值為cloud_efficiency時：20~20480。如果要儲存的資料大於2048 GB，cloud_efficiency只能支援以下資料大小： 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 說明如果要儲存的資料大於5120 GB，Elasticsearch版本必須為6.7、7.X或日誌增強版。當DiskType取值為cloud_essd時：20~6144。單位：GB。
Spec	String	是	是	Elasticsearch執行個體的資料節點規格。	無
DiskType	String	是	是	資料節點磁碟類型。	取值： cloud_ssd：SSD雲端硬碟。適合擁有高IOPS，資料響應度較高的線上分析和搜尋情境。 cloud_efficiency：高效雲端硬碟。提供較為低廉的儲存能力，適合大規模資料量的日誌及分析情境。 cloud_essd：ESSD雲端硬碟。具有低時延、快速響應、強大的資料輸送量等優勢，適合時延敏感的應用或者I/O密集型業務情境。
DiskEncryption	Boolean	否	否	是否開啟雲端硬碟加密。	取值： true：開啟。 false（預設值）：關閉。
PerformanceLevel	String	否	否	ESSD雲端硬碟的效能層級。	當DiskType取值為cloud_essd時，該參數必選。取值： PL1 PL2 PL3

MasterNode文法

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

MasterNode屬性

屬性名稱	類型	必須	允許更新	描述	約束
Amount	Integer	否	是	主節點數量。	預設值：3。
DiskSize	Integer	否	否	主節點儲存空間。	預設值：20。
Spec	String	是	否	主節點規格。	無
DiskType	String	否	否	主節點磁碟類型。	無

Tags文法

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

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	是	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://` 。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://` 。

YMLConfig文法

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

YMLConfig屬性

屬性名稱	類型	必須	允許更新	描述	約束
CreateIndex	String	否	否	當Elasticsearch執行個體接收到新檔案後，如果沒有對應索引，是否允許系統自動建立索引。	對應的YAML檔案的配置項為action.auto_create_index。取值： true：允許系統自動建立索引。 false（預設值）：不允許系統自動建立索引。
Watcher	Boolean	否	否	是否開啟Watcher。	對應的YAML檔案的配置項為xpack.watcher.enabled。取值： true：開啟。開啟Watcher後，可使用X-Pack的Watcher功能。請注意定時清理`.watcher-history*`索引，避免佔用大量磁碟空間。 false（預設值）：關閉。
DestructiveRequiresName	Boolean	否	否	在刪除索引時，是否需要明確指定索引名稱。	對應的YAML檔案的配置項為action.destructive_requires_name。取值： true（預設值）：在刪除索引時，需要明確指定索引名稱。 false：在刪除索引時，不需要明確指定索引名稱。說明如果選擇刪除或關閉時索引名稱支援萬用字元，則可以使用萬用字元進行大量刪除索引。索引刪除後不可恢複，請謹慎使用此配置。
AuditLog	Boolean	否	否	是否開啟Auditlog索引。	取值： true：開啟。開啟Auditlog索引後，系統會記錄Elasticsearch執行個體對應的增、刪、改、查等操作產生的審計日誌，該日誌資訊會佔用您的磁碟空間，同時也會影響效能。不建議開啟，請謹慎使用此配置。更多資訊，請參見配置Auditlog（審計日誌）。 false（預設值）：關閉。說明 Elasticsearch 7.0及以上版本暫不支援配置該參數。
OtherConfigs	Map	否	否	其他配置。	支援的部分配置項如下（以下配置項，如果沒有標識Elasticsearch的適用版本，則預設相容Elasticsearch 5.x、6.x和7.x版本）：配置CORS訪問 http.cors.enabled http.cors.allow-origin http.cors.max-age http.cors.allow-methods http.cors.allow-headers http.cors.allow-credentials 配置reindex白名單 reindex.remote.whitelist 配置Auditlog（審計日誌） 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 配置queue大小 thread_pool.bulk.queue_size（適用於Elasticsearch 5.x版本） thread_pool.write.queue_size（適用於Elasticsearch 6.x及7.x版本） thread_pool.search.queue_size 自訂SQL外掛程式配置 xpack.sql.enabled：預設情況下Elasticsearch執行個體會啟用X-Pack內建的SQL外掛程式，如需上傳自訂的SQL外掛程式，請將xpack.sql.enabled設定為false。

KibanaNode文法

"KibanaNode": {
  "Spec": String
}

KibanaNode屬性

屬性名稱	類型	必須	允許更新	描述	約束
Spec	String	是	否	專用Kibana節點規範。	無

傳回值

Fn::GetAtt

Status：Elasticsearch執行個體的狀態。
KibanaDomain：Kibana地址。
PublicDomain：執行個體的公網地址。
Domain：執行個體的內網地址。
InstanceId：Elasticsearch執行個體的ID。
KibanaPort：Kibana的訪問連接埠。
Port：執行個體串連連接埠。
VSwitchId：交換器ID。
Version：執行個體版本。
InstanceChargeType：執行個體付費類型。

樣本

`YAML`格式

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`格式

{
  "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": {
  }
}

文法

屬性

DataNode文法

DataNode屬性

MasterNode文法

MasterNode屬性

Tags文法

Tags屬性

YMLConfig文法

YMLConfig屬性

KibanaNode文法

KibanaNode屬性

傳回值

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式