ALIYUN::ElasticSearch::Instance を使用した Elasticsearch インスタンスの作成 - 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	はい	はい	インスタンスのパスワード。	パスワードは 8～32 文字で、大文字、小文字、数字、特殊文字の 4 種類のうち、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	いいえ	はい	インスタンスの説明。	説明は 0～30 文字である必要があります。先頭は英字、数字、または中国語文字である必要があります。英字、数字、中国語文字、アンダースコア (_)、ハイフン (-) を含めることができます。
DeleteType	String	いいえ	いいえ	リリースタイプ。	有効値： immediate：クラスターはリリース後すぐに削除されます。クラスターが削除されると、クラスターに保存されているデータが削除され、システムは Logstash クラスターリストからクラスターを削除します。 protective (デフォルト)：インスタンスが 24 時間凍結された後にのみ、データは完全にクリアされます。この期間中、インスタンスはインスタンスリストに引き続き表示されます。インスタンスを再開するか、すぐにリリースすることができます。
EnableKibanaPublic	Boolean	いいえ	いいえ	Kibana のパブリックネットワークアクセスを有効にするかどうかを指定します。	有効な値： true：有効。 false (デフォルト)：無効。
KibanaWhitelist	List	いいえ	はい	Kibana の IP アドレスのホワイトリスト。	なし
PublicWhitelist	List	いいえ	はい	インスタンスのパブリック IP アドレスホワイトリスト。	なし
InstanceChargeType	String	いいえ	いいえ	インスタンスの課金方法。	有効な値： PrePaid：サブスクリプション。 PostPaid (従量課金)
Period	Integer	いいえ	いいえ	Elasticsearch インスタンスのサブスクリプション期間。	有効な値： 1 (デフォルト) 2 3 4 5 6 7 8 9 12 24 36 単位：月。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし
EnablePublic	Boolean	いいえ	はい	インスタンスのパブリックエンドポイントを有効にするかどうかを指定します。	有効な値： true：有効。 false (デフォルト)：無効。
PrivateWhitelist	List	いいえ	はい	VPC (Virtual Private Cloud) でインスタンスにアクセスするための IP アドレスホワイトリスト。	なし
MasterNode	Map	いいえ	はい	マスターノードの設定。	このパラメーターを指定すると、専用マスターノードが作成されます。詳細については、「MasterNode プロパティ」をご参照ください。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「Tags プロパティ」をご参照ください。
YMLConfig	Map	いいえ	いいえ	YAML ファイル設定。	詳細については、「YMLConfig プロパティ」をご参照ください。
EnableKibanaPrivate	Boolean	いいえ	いいえ	Kibana のプライベートネットワークアクセスを有効にするかどうかを指定します。	有効な値： true：有効。 false (デフォルト)：無効。
ZoneCount	Integer	いいえ	いいえ	インスタンスがデプロイされるゾーンの数。	有効な値： 1 (デフォルト) 2 3
KibanaNode	Map	いいえ	いいえ	専用 Kibana ノードの設定。	なし
ZoneId	String	いいえ	いいえ	ゾーンの ID。	なし
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値： Month：暦月。年：
InstanceCategory	String	いいえ	いいえ	インスタンスのバージョンタイプ。	有効な値： x-pack：商用版インスタンス、またはインデックスサービスと OpenStore が無効になっているカーネル拡張版インスタンスを作成します。 IS：インデックスサービスまたは OpenStore が有効になっているカーネル拡張版インスタンスを作成します。

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 を超えるデータを保存する場合、このパラメーターでは次の値のみがサポートされます： 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 説明 5,120 GB を超えるデータを保存する場合、Elasticsearch のバージョンは 6.7 または 7.X であるか、インスタンスがアドバンスト版である必要があります。 DiskType を cloud_essd に設定した場合：20～6144。単位：GB。
Spec	String	はい	はい	Elasticsearch インスタンスのデータノードの仕様。	エラスティックノードの仕様。仕様の詳細については、「ノード仕様」をご参照ください。
DiskType	String	はい	はい	データノードのディスクタイプ。	有効な値： cloud_ssd：標準 SSD。このディスクタイプは、高い IOPS と高いデータ応答性が要求されるオンライン分析および検索シナリオに適しています。 cloud_efficiency：Ultra ディスク。このディスクタイプは、コスト効率の高いストレージを提供し、大量のデータを扱うログおよび分析シナリオに適しています。 cloud_essd：ESSD (Enterprise SSD)。このディスクタイプは、低遅延、高速応答、高スループットを特徴とします。遅延の影響を受けやすいアプリケーションや 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	いいえ	いいえ	マスターノードのディスクタイプ。	有効値： cloud_ssd：標準 SSD cloud_essd (デフォルト)：ESSD (Enterprise SSD)

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

YMLConfig プロパティ

プロパティ名	タイプ	必須	更新の許可	説明	制約
AuditLog	Boolean	いいえ	いいえ	監査ログインデックスを有効にするかどうかを指定します。	有効な値： true：監査ログインデックスを有効にします。監査ログインデックスを有効にすると、Elasticsearch インスタンスの作成、削除、変更、クエリなどの操作に対して生成された監査ログがシステムに記録されます。ログ情報はディスク領域を消費し、パフォーマンスに影響を与えます。この機能を有効にしないことを推奨します。この設定は注意して使用してください。詳細については、「監査ログの設定」をご参照ください。 false (デフォルト)：無効。説明このパラメーターは Elasticsearch 7.0 以降のバージョンではサポートされていません。
CreateIndex	String	いいえ	いいえ	Elasticsearch インスタンスが新しいファイルを受信した後、対応するインデックスが存在しない場合に、システムが自動的にインデックスを作成することを許可するかどうかを指定します。	YAML ファイル内の対応する設定項目は action.auto_create_index です。有効な値： true：システムが自動的にインデックスを作成することを許可します。 false (デフォルト)：システムが自動的にインデックスを作成することを許可しません。
DestructiveRequiresName	Boolean	いいえ	いいえ	インデックスを削除するには、インデックス名を指定する必要がありますか？	YAML ファイル内の対応する設定項目は action.destructive_requires_name です。有効な値： true (デフォルト)：インデックスを削除する際には、インデックス名を明示的に指定する必要があります。 false：インデックスを削除する際に、インデックス名を明示的に指定する必要はありません。説明インデックスを削除またはクローズする際にインデックス名にワイルドカード文字の使用を許可すると、ワイルドカード文字を使用してバッチでインデックスを削除できます。削除されたインデックスは復元できません。この設定は注意して使用してください。
OtherConfigs	Map	いいえ	いいえ	その他の設定。	以下の設定項目がサポートされています。特に指定がない限り、これらの設定項目は 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.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 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 に設定します。
Watcher	Boolean	いいえ	いいえ	Watcher を有効にするかどうかを指定します。	YAML ファイル内の対応する設定項目は xpack.watcher.enabled です。有効な値： true：Watcher を有効にします。Watcher を有効にすると、X-Pack の Watcher 機能を使用できます。インデックスが大量のディスク領域を占有するのを防ぐために、`.watcher-history*` インデックスを定期的にクリアしてください。 false (デフォルト)：無効。

KibanaNode 構文

"KibanaNode": {
  "Spec": String
}

KibanaNode プロパティ

プロパティ名	タイプ	必須	更新の許可	説明	制約
Spec	String	はい	いいえ	専用 Kibana ノードの仕様。	なし

戻り値

Fn::GetAtt

Status：Elasticsearch インスタンスのステータス。
KibanaDomain：Kibana エンドポイント。
PublicDomain：インスタンスのパブリックエンドポイント。
Domain：インスタンスの内部エンドポイント。
InstanceId：Elasticsearch インスタンスの ID。
KibanaPort：Kibana アクセスポート。
Port：インスタンスの接続ポート。
VSwitchId：vSwitch の ID。
Version：インスタンスのバージョン。
InstanceChargeType：インスタンスの課金方法。
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` 形式