Elasticsearch クラスタを作成するための ALIYUN::ElasticSearch::Instance の使用方法 - Resource Orchestration Service

ALIYUN::ElasticSearch::Instance は、Elasticsearch クラスターを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ElasticSearch::Instance",
  "Properties": {
    "KibanaWhitelist": List, // Kibana の IP アドレス ホワイトリスト
    "PublicWhitelist": List, // パブリックアクセスを許可する IP アドレス ホワイトリスト
    "VSwitchId": String, // vSwitch ID
    "InstanceChargeType": String, // 課金方法
    "Period": Integer, // サブスクリプション期間
    "Version": String, // Elasticsearch のバージョン
    "DataNode": Map, // データノードの構成
    "PrivateWhitelist": List, // VPC アクセスを許可する IP アドレス ホワイトリスト
    "ResourceGroupId": String, // リソースグループ ID
    "EnablePublic": Boolean, // パブリックエンドポイントを有効にするかどうか
    "Password": String, // Elasticsearch クラスタのパスワード
    "MasterNode": Map, // プライマリノードの構成
    "Tags": List, // タグ
    "Description": String, // Elasticsearch クラスタの説明
    "EnableKibanaPublic": Boolean, // Kibana のインターネットアクセスを有効にするかどうか
    "YMLConfig": Map, // YAML ファイルの構成
    "EnableKibanaPrivate": Boolean, // Kibana の内部ネットワークアクセスを有効にするかどうか
    "ZoneCount": Integer, // Elasticsearch クラスタが存在するゾーンの数
    "KibanaNode": Map, // 専用 Kibana ノードの構成
    "ZoneId": String, // ゾーン ID
    "PeriodUnit": String, // サブスクリプション期間の単位
    "InstanceCategory": String, // Elasticsearch クラスタのエディション
    "DeleteType": String // リリースタイプ
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DataNode	Map	はい	はい	Elasticsearch クラスターのデータノード構成。	詳細については、「DataNode プロパティ」をご参照ください。
Password	String	はい	はい	Elasticsearch クラスターのパスワード。	パスワードは 8 ～ 32 文字で、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類を含める必要があります。次の特殊文字がサポートされています: `! @ # $ % & * ( ) _ + - =`。
VSwitchId	String	はい	いいえ	vSwitch ID。	なし。
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
Description	String	いいえ	はい	Elasticsearch クラスターの説明。	説明は最大 30 文字で、文字、数字、アンダースコア（_）、ハイフン（-）を含めることができます。数字または文字で始める必要があります。
DeleteType	String	いいえ	いいえ	リリースタイプ。	有効な値: immediate: リリース後すぐにクラスタが削除されます。クラスタに保存されているすべてのデータは完全に削除され、クラスタは LogStash クラスタリストから削除されます。 protective (デフォルト): データが完全にクリアされる前に、インスタンスは 24 時間凍結されます。この期間中、インスタンスはインスタンスリストに表示されたままになります。 [インスタンスの復元] または [即時リリース] を選択できます。
EnableKibanaPublic	Boolean	いいえ	いいえ	Kibana のインターネットアクセスを有効にするかどうかを指定します。	有効な値： true false (デフォルト)
KibanaWhitelist	List	いいえ	はい	Kibana の IP アドレスのホワイトリスト。	なし。
PublicWhitelist	List	いいえ	はい	インターネット経由で Elasticsearch クラスターへのアクセスを許可する IP アドレスのホワイトリスト。	なし。
InstanceChargeType	String	いいえ	いいえ	Elasticsearch クラスターの課金方法。	有効な値： PrePaid: サブスクリプション PostPaid: 従量課金
Period	Integer	いいえ	いいえ	Elasticsearch クラスターのサブスクリプション期間。	有効な値： 1 (デフォルト) 2 3 4 5 6 7 8 9 12 24 36 単位：月。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
EnablePublic	Boolean	いいえ	はい	Elasticsearch クラスターのパブリックエンドポイントを有効にするかどうかを指定します。	有効な値： true false (デフォルト)
PrivateWhitelist	List	いいえ	はい	仮想プライベートクラウド ( VPC ) 経由で Elasticsearch クラスターへのアクセスを許可する IP アドレスのホワイトリスト。	なし。
MasterNode	Map	いいえ	はい	Elasticsearch クラスターのプライマリノード構成。	このプロパティを指定すると、専用のプライマリノードが作成されます。詳細については、「MasterNode プロパティ」をご参照ください。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「Tags プロパティ」をご参照ください。
YMLConfig	Map	いいえ	いいえ	YAML ファイルの構成。	詳細については、「YMLConfig プロパティ」をご参照ください。
EnableKibanaPrivate	Boolean	いいえ	いいえ	Kibana の内部ネットワークアクセスを有効にするかどうかを指定します。	有効な値： true false (デフォルト)
ZoneCount	Integer	いいえ	いいえ	Elasticsearch クラスターが存在するゾーンの数。	有効な値： 1 (デフォルト) 2 3
KibanaNode	Map	いいえ	いいえ	専用 Kibana ノードの構成。	なし。
ZoneId	String	いいえ	いいえ	ゾーン ID。	なし。
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値： Month Year
InstanceCategory	String	いいえ	いいえ	Elasticsearch クラスターのエディション。	有効な値： x-pack: Standard Edition、または Indexing Service と OpenStore が有効になっていない Kernel-enhanced Edition IS: Indexing Service と OpenStore が有効になっている Kernel-enhanced Edition

DataNode 構文

"DataNode": {
  "Amount": Integer, // Elasticsearch クラスター内のデータノードの数
  "DiskSize": Integer, // データノードのストレージ容量
  "Spec": String, // Elasticsearch クラスター内のデータノードのカテゴリ
  "DiskType": String, // データノードのディスクカテゴリ
  "DiskEncryption": Boolean, // ディスクの暗号化を有効にするかどうかを指定します
  "PerformanceLevel": String // ESSD のパフォーマンスレベル (PL)
}

DataNode プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Amount	Integer	はい	はい	Elasticsearch クラスター内のデータノードの数。	有効な値：2 ～ 50。
DiskSize	Integer	はい	はい	データノードのストレージ容量。	DiskType が cloud_ssd に設定されている場合の有効な値：20 ～ 6144。 DiskType が cloud_efficiency に設定されている場合の有効な値：20 ～ 20480。2,048 GB を超えるデータを保存する場合、DiskType が cloud_efficiency に設定されている場合、DiskSize の有効な値は次のとおりです。 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 説明 5,120 GB を超えるデータを保存する場合、Elasticsearch のバージョンは V6.7 または V7.X であるか、Elasticsearch のエディションは Advanced Edition である必要があります。 DiskType が cloud_essd に設定されている場合の有効な値：20 ～ 6144。単位：GB。
Spec	String	はい	はい	Elasticsearch クラスター内のデータノードのカテゴリ。	なし。
DiskType	String	はい	はい	データノードのディスクカテゴリ。	有効な値： cloud_ssd: 標準 SSD 。このカテゴリのディスクは、高い IOPS と高速な応答を必要とするオンラインデータ分析と検索に適しています。 cloud_efficiency: Ultra ディスク。このカテゴリのディスクは費用対効果の高いストレージを提供し、大量のデータのログ記録と分析に適しています。 cloud_essd: 企業向け SSD （ ESSD ）。このカテゴリのディスクは、低レイテンシ、高速応答、強力なデータスループットを特長としており、遅延の影響を受けやすいアプリケーションや I/O 集中型のビジネスシナリオに適しています。
DiskEncryption	Boolean	いいえ	いいえ	ディスクの暗号化を有効にするかどうかを指定します。	有効な値： true false (デフォルト)
PerformanceLevel	String	いいえ	いいえ	ESSD のパフォーマンスレベル ( PL )。	DiskType が cloud_essd に設定されている場合は、このプロパティを指定する必要があります。有効な値： PL1 PL2 PL3

MasterNode 構文

"MasterNode": {
  "Amount": Integer, // プライマリノードの数
  "DiskSize": Integer, // プライマリノードのストレージ容量
  "Spec": String, // プライマリノードのカテゴリ
  "DiskType": String // プライマリノードのディスクカテゴリ
}

MasterNode プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Spec	String	はい	いいえ	プライマリノードのカテゴリ。	なし。
Amount	Integer	いいえ	はい	プライマリノードの数。	デフォルト値：3。
DiskSize	Integer	いいえ	いいえ	プライマリノードのストレージ容量。	デフォルト値：20。
DiskType	String	いいえ	いいえ	プライマリノードのディスクカテゴリ。	なし。

Tags 構文

"Tags": [
  {
    "Key": String, // タグキー
    "Value": String // タグ値
  }
]

Tags プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

YMLConfig 構文

"YMLConfig": {
    "CreateIndex": String, // インデックスが存在しない場合、Elasticsearch クラスターにアップロードされた新しいドキュメントのインデックスを自動的に作成するかどうかを指定します。
    "Watcher": String, // Watcher を有効にするかどうかを指定します
    "DestructiveRequiresName": Boolean, // インデックスを削除するときにインデックス名を指定する必要があるかどうかを指定します
    "AuditLog": Boolean, // 監査ログのインデックス作成を有効にするかどうかを指定します
    "OtherConfigs": Map // YAML ファイルのその他の構成
  }

YMLConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AuditLog	Boolean	いいえ	いいえ	監査ログのインデックス作成を有効にするかどうかを指定します。	有効な値： true: 監査ログのインデックス作成を有効にします。監査ログのインデックス作成を有効にすると、システムは Elasticsearch クラスターで実行される作成、削除、変更、および検索操作の監査ログを生成します。これらのログはディスク容量を消費し、パフォーマンスに影響します。監査ログのインデックス作成を無効にすることをお勧めします。このプロパティを指定する際は注意してください。詳細については、「監査ログのインデックス作成機能を構成する」をご参照ください。 false (デフォルト): 監査ログのインデックス作成を無効にします。説明このプロパティは、Elasticsearch V7.0 以降では使用できません。
CreateIndex	String	いいえ	いいえ	インデックスが存在しない場合、Elasticsearch クラスターにアップロードされた新しいドキュメントのインデックスを自動的に作成するかどうかを指定します。	YAML ファイルの対応するフィールドは action.auto_create_index です。有効な値： true false (デフォルト)
DestructiveRequiresName	Boolean	いいえ	いいえ	インデックスを削除するときにインデックス名を指定する必要があるかどうかを指定します。	YAML ファイルの対応するフィールドは action.destructive_requires_name です。有効な値： true (デフォルト) false 説明このプロパティを false に設定すると、ワイルドカードを使用して一度に複数のインデックスを削除できます。削除されたインデックスは復元できません。このプロパティを指定する際は注意してください。
OtherConfigs	Map	いいえ	いいえ	YAML ファイルのその他の構成。	YAML ファイルでサポートされている特定のフィールドについて、以下に説明します。特に明記されていない限り、これらのフィールドは Elasticsearch V5.X、V6.X、および V7.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 監査ログのインデックス作成機能を構成する： 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 キューサイズを設定する： thread_pool.bulk.queue_size ( Elasticsearch V5.X で使用可能 ) thread_pool.write.queue_size ( Elasticsearch V6.X および V7.X で使用可能 ) thread_pool.search.queue_size カスタム SQL プラグインを構成する： xpack.sql.enabled: デフォルトでは、Elasticsearch クラスターは X-Pack によって提供される組み込み SQL プラグインを使用します。カスタム SQL プラグインを Elasticsearch クラスターにアップロードする場合は、xpack.sql.enabled フィールドを false に設定します。
Watcher	Boolean	いいえ	いいえ	Watcher を有効にするかどうかを指定します。	YAML ファイルの対応するフィールドは xpack.watcher.enabled です。有効な値： true: Watcher を有効にします。Watcher を有効にすると、X-Pack Watcher 機能を使用できます。ディスク容量を節約するために、`.watcher-history*` インデックスを定期的にクリアする必要があります。 false (デフォルト): Watcher を無効にします。

KibanaNode 構文

"KibanaNode": {
  "Spec": String // 専用 Kibana ノードのカテゴリ
}

KibanaNode プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Spec	String	はい	いいえ	専用 Kibana ノードのカテゴリ。	なし。

戻り値

Fn::GetAtt

Status: Elasticsearch クラスターの状態。
KibanaDomain: Kibana のアドレス。
PublicDomain: Elasticsearch クラスターのパブリックエンドポイント。
Domain: Elasticsearch クラスターの内部エンドポイント。
InstanceId: Elasticsearch クラスターの ID。
KibanaPort: Kibana のポート番号。
Port: Elasticsearch クラスターのポート番号。
VSwitchId: vSwitch ID。
Version: Elasticsearch のバージョン。
InstanceChargeType: Elasticsearch クラスターの課金方法。
Arn: Alibaba Cloud リソースネーム ( ARN )。

例

`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", // Elasticsearch インスタンステスト
  "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` 形式