DATASOURCE::GraphDatabase::DbInstances リファレンス - ROS

DATASOURCE::GraphDatabase::DbInstances は、Graph Database (GDB) インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::GraphDatabase::DbInstances",
  "Properties": {
    "ResourceGroupId": String,
    "DbInstanceDescription": String,
    "DbInstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
DbInstanceDescription	String	いいえ	はい	インスタンスの説明。	なし。
DbInstanceId	String	いいえ	はい	インスタンス ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

DbInstances: インスタンスの詳細。
DbInstanceIds: インスタンスの ID。

プロパティ	タイプ	説明	制約
DbInstanceIds	List	インスタンスの ID。	なし。
DbInstances	List	インスタンスの詳細。	なし。
DbInstanceDescription	String	説明。	なし。
LockMode	String	インスタンスのロックモード。	なし。
DbInstanceCategory	String	インスタンスのエディション。	なし。
DbVersion	String	データベースバージョン。	なし。
DbInstanceId	String	インスタンス ID。	なし。
LockReason	String	インスタンスがロックされている理由。	なし。
Status	String	インスタンスのステータス。	なし。
VpcId	String	仮想プライベートクラウド (VPC) の ID。	なし。
Tags	List	カスタムタグ。	なし。
RegionId	String	リージョン情報。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
VSwitchId	String	vSwitch ID。	なし。
DbNodeClass	String	データベースのノードタイプ。	なし。
Expired	String	インスタンスの有効期限。	なし。
DbNodeCount	String	ノード数。	なし。
ZoneId	String	インスタンスのゾーン ID。	なし。
DbInstanceType	String	インスタンスタイプ。	なし。
DbNodeStorage	String	インスタンスのストレージ容量。	なし。
ExpireTime	String	データベースの有効期限。	なし。
PaymentType	String	課金方法。	なし。
ReadOnlyDbInstanceIds	List	読み取り専用インスタンスの ID。	なし。
CreateTime	String	インスタンスが作成された時刻。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DbInstanceId:
    Type: String
    Description: The first ID of the resource.  # リソースの最初の ID。
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::GraphDatabase::DbInstances
    Properties:
      DbInstanceId:
        Ref: DbInstanceId
Outputs:
  DbInstances:
    Description: The list of db instances. # DB インスタンスのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstances
  DbInstanceIds:
    Description: The list of db instance IDs. # DB インスタンス ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DbInstanceId": {
      "Type": "String",
      "Description": "The first ID of the resource." // リソースの最初の ID。
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::GraphDatabase::DbInstances",
      "Properties": {
        "DbInstanceId": {
          "Ref": "DbInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DbInstances": {
      "Description": "The list of db instances.", // DB インスタンスのリスト。
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstances"
        ]
      }
    },
    "DbInstanceIds": {
      "Description": "The list of db instance IDs.", // DB インスタンス ID のリスト。
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceIds"
        ]
      }
    }
  }
}