DATASOURCE::Lindorm::Instances の概要 - Resource Orchestration Service

DATASOURCE::Lindorm::インスタンスは、Lindorm インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::Lindorm::Instances",
  "Properties": {
    "ResourceGroupId": String,
    "ServiceType": String,
    "QueryStr": String,
    "InstanceIds": List,
    "SupportEngine": Integer,
    "Tags": List,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
ServiceType	String	いいえ	はい	インスタンスのカテゴリ。	有効な値: lindorm: シングルゾーン Lindorm インスタンス lindorm_multizone: マルチゾーン Lindorm インスタンス serverless_lindorm: Lindorm Serverless インスタンス lindorm_standalone: シングルノード Lindorm インスタンス lts: Lindorm Tunnel Service (LTS) インスタンス
QueryStr	String	いいえ	はい	インスタンス名をあいまい検索するためのキーワード。	なし。
InstanceIds	List	いいえ	はい	インスタンスの ID。	最大 20 個のインスタンス ID を指定できます。
SupportEngine	Integer	いいえ	はい	インスタンスでサポートされているエンジンタイプ。	有効な値: 1: LindormSearch 2: LindormTSDB 4: LindormTable 8: LindormDFS 説明たとえば、SupportEngine を 15 ( 8 + 4 + 2 + 1 ) に設定すると、インスタンスは LindormSearch、LindormTSDB、LindormTable、および LindormDFS エンジンをサポートします。 SupportEngine を 6 ( 4 + 2 ) に設定すると、インスタンスは LindormTSDB および LindormTable エンジンをサポートします。
Tags	List	いいえ	はい	タグ。	最大 5 つのタグを追加できます。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースのリフレッシュポリシー。	有効な値: Never ( デフォルト ): スタックの更新時にデータソースリソースをリフレッシュしません。 Always: スタックの更新時にデータソースリソースをリフレッシュします。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	タグ値。	なし。
Key	String	はい	いいえ	タグキー。	なし。

戻り値

Fn::GetAtt

Instances: インスタンスの詳細。
InstanceIds: インスタンスの ID。

プロパティ	タイプ	説明	制約
InstanceIds	List	インスタンスの ID。	なし。
Instances	List	インスタンスの詳細。	なし。
EnableBlob	Boolean	インスタンスでバイナリラージオブジェクト ( BLOB ) が有効になっているかどうかを示します。	有効な値: true false
CreateTime	String	インスタンスが作成された時刻。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
EnableShs	Boolean	Lindorm 分散処理システム ( LDPS ) の履歴サーバーが有効になっているかどうかを示します。	有効な値: true false
VpcId	String	インスタンスが存在する仮想プライベートクラウド ( VPC ) の ID。	なし。
MaintainStartTime	String	メンテナンスウィンドウの開始時刻。	なし。
ServiceType	String	インスタンスのカテゴリ。	なし。
EnableML	String	機械学習 ( ML ) が有効になっているかどうかを示します。	なし。
EnableBDS	String	LTS が有効になっているかどうかを示します。	なし。
CoreNum	String	コアノードの数。このプロパティは、マルチゾーンインスタンスの場合にのみ返されます。	なし。
EngineType	String	サポートされているエンジンタイプ。	なし。
DiskThreshold	String	ディスク容量のしきい値。	なし。
EnableSSL	Boolean	SSL 暗号化が有効になっているかどうかを示します。	有効な値: true false
MaintainEndTime	String	メンテナンスウィンドウの終了時刻。	なし。
LogNum	Integer	ログノードの数。このプロパティは、マルチゾーンインスタンスの場合にのみ返されます。	なし。
DiskCategory	String	ストレージタイプ。	なし。
EnablePhoenix	String	Phoenix が有効になっているかどうかを示します。	なし。
EnableLTS	String	インスタンスで LTS エンジンが有効になっているかどうかを示します。	なし。
LocalCloudStorage	String	オンプレミス環境で設定されているクラウドストレージサービス。	なし。
VswitchId	String	vSwitch ID。	なし。
EnableLsqlVersionV3	String	LsqlVersionV3 が有効になっているかどうかを示します。	なし。
ColdStorage	String	Capacity ストレージサイズ。	なし。
CoreSingleStorage	Integer	コアノードのディスク容量。このプロパティは、マルチゾーンインスタンスの場合にのみ返されます。	なし。
InstanceStorage	String	インスタンスのストレージサイズ。	なし。
EngineList	List	エンジンの情報。	なし。
ExpiredMilliseconds	String	インスタンスの有効期限。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	なし。
EnableKms	Boolean	Key Management Service ( KMS ) が有効になっているかどうかを示します。	なし。
NetworkType	String	インスタンスのネットワークタイプ。	なし。
CreateMilliseconds	Integer	インスタンスが作成された時刻。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	なし。
PayType	String	インスタンスの課金方法。	なし。
DeletionProtection	String	削除保護が有効になっているかどうかを示します。	なし。
EnableCdc	String	インスタンスでデータサブスクリプションが有効になっているかどうかを示します。	なし。
InstanceId	String	インスタンス ID。	なし。
InstanceStatus	String	インスタンスの状態。	なし。
EnableCompute	Boolean	インスタンスで LDPS が有効になっているかどうかを示します。	有効な値: true false
DiskUsage	String	ディスク使用率。	なし。
InstanceAlias	String	インスタンス名。	なし。
EnableMLCtrl	String	AI コントロールノードが有効になっているかどうかを示します。	なし。
LocalCloudCategory	String	オンプレミス環境で設定されているクラウドストレージサービスのカテゴリ。	なし。
LogSingleStorage	Integer	ログノードのディスク容量。このプロパティは、マルチゾーンインスタンスの場合にのみ返されます。	なし。
ArchVersion	String	デプロイメントアーキテクチャ。	なし。
EnableStream	String	インスタンスでストリーミングエンジンが有効になっているかどうかを示します。	なし。
ZoneId	String	ゾーン ID。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueryStr:
    Type: String
    Description: インスタンス名のキーワード。あいまい検索に使用できます。
    Default: test
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::Lindorm::Instances
    Properties:
      QueryStr:
        Ref: QueryStr
Outputs:
  Instances:
    Description: インスタンスの詳細リスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Instances
  InstanceIds:
    Description: インスタンス ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueryStr": {
      "Type": "String",
      "Description": "インスタンス名のキーワード。あいまい検索に使用できます。",
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::Lindorm::Instances",
      "Properties": {
        "QueryStr": {
          "Ref": "QueryStr"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "インスタンスの詳細リスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "インスタンス ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}