ApsaraDB RDSインスタンスをクエリするためにDATASOURCE::RDS::DBInstancesを使用する - Resource Orchestration Service

DATASOURCE::RDS::DBInstancesは、ApsaraDB RDSインスタンスをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::RDS::DBInstances",
  "Properties": {
    "DedicatedHostId": String,
    "EngineVersion": String,
    "DBInstanceStatus": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "DBInstanceClass": String,
    "DedicatedHostGroupId": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "InstanceLevel": Number,
    "Expired": String,
    "PayType": String,
    "InstanceNetworkType": String,
    "VpcId": String,
    "DBInstanceId": String,
    "SearchKey": String,
    "ConnectionMode": String,
    "ConnectionString": String,
    "Engine": String,
    "proxyId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DedicatedHostId	String	いいえ	はい	専用クラスター内のホストのID。	なし。
EngineVersion	String	いいえ	はい	データベースエンジンのバージョン。	なし。
DBInstanceStatus	String	いいえ	はい	インスタンスの状態。	詳細については、「インスタンス状態表」をご参照ください。
ResourceGroupId	String	いいえ	はい	リソースグループのID。	なし。
ZoneId	String	いいえ	はい	ゾーンID。	なし。
DBInstanceClass	String	いいえ	はい	インスタンスタイプ。	詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。
DedicatedHostGroupId	String	いいえ	はい	専用クラスターのID。	なし。
VSwitchId	String	いいえ	はい	vSwitch ID。	なし。
DBInstanceType	String	いいえ	はい	インスタンスのカテゴリ。	有効な値: Primary: プライマリインスタンス Readonly: 読み取り専用インスタンス Guard: ディザスタリカバリインスタンス Temp: 一時インスタンス
InstanceLevel	Number	いいえ	はい	インスタンスのエディションを返すかどうかを指定します。	有効な値: 0: インスタンスのエディションを返しません。 1: インスタンスのエディションを返します。
Expired	String	いいえ	はい	インスタンスの有効期限が切れているかどうかを指定します。	有効な値: true false
PayType	String	いいえ	はい	課金方法。	有効な値: Postpaid: 従量課金制 Prepaid: サブスクリプション
InstanceNetworkType	String	いいえ	はい	インスタンスのネットワークタイプ。	有効な値: VPC Classic
VpcId	String	いいえ	はい	仮想プライベートクラウド ( VPC ) のID。	なし。
DBInstanceId	String	いいえ	はい	インスタンス ID。	なし。
SearchKey	String	いいえ	はい	インスタンス ID または説明のキーワード。インスタンスのあいまい検索を実行するために使用されます。	なし。
ConnectionMode	String	いいえ	はい	インスタンスの接続モード。	有効な値: Standard: 標準モード Safe: データベースプロキシモード
ConnectionString	String	いいえ	はい	インスタンスのエンドポイント。	なし。
Engine	String	いいえ	はい	データベースエンジンのタイプ。	有効な値: MySQL SQLServer PostgreSQL MariaDB
proxyId	String	いいえ	はい	プロキシモードの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値: Never ( デフォルト ): スタックの更新時にデータソースリソースを更新しません。 Always: スタックの更新時にデータソースリソースを更新します。

戻り値 ( Fn::GetAtt )

DBInstanceIds: インスタンスの ID。
DBInstances: インスタンスの詳細。

プロパティ	タイプ	説明	制約
DBInstanceIds	List	インスタンスの ID。	なし。
DBInstances	List	インスタンスの詳細。	なし。
VpcId	String	VPC ID。	なし。
CreateTime	String	作成時刻。	時刻は ISO 8601 標準 ( yyyy-MM-ddTHH:mm:ssZ 形式 ) に従います。時刻は UTC で表示されます。
PayType	String	インスタンスの課金方法。	有効な値: Postpaid: 従量課金制 Prepaid: サブスクリプション
EngineVersion	String	データベースエンジンのバージョン。	なし。
VpcName	String	VPC 名。	なし。
ConnectionString	String	インスタンスのエンドポイント。	なし。
InstanceNetworkType	String	インスタンスのネットワークタイプ。	有効な値: Classic VPC
MasterInstanceId	String	プライマリインスタンスの ID。	null 値は、インスタンスがプライマリインスタンスであることを示します。
ExpireTime	String	有効期限。	時刻は ISO 8601 標準 ( yyyy-MM-ddTHH:mm:ssZ 形式 ) に従います。時刻は UTC で表示されます。説明このプロパティは、従量課金制インスタンスでは返されません。
GuardDBInstanceId	String	ディザスタリカバリインスタンスの ID。	なし。
ZoneId	String	ゾーン ID。	なし。
DBInstanceId	String	インスタンス ID。	なし。
TempDBInstanceId	String	一時インスタンスの ID。	なし。
DBInstanceStorageType	String	インスタンスのストレージタイプ。	なし。
ConnectionMode	String	インスタンスの接続モード。	有効な値: Standard: 標準モード Safe: データベースプロキシモード
DBInstanceDescription	String	インスタンスの説明。	なし。
DBInstanceNetType	String	インスタンスのネットワーク接続タイプ。	有効な値: Internet Intranet
DBInstanceType	String	インスタンスのカテゴリ。	有効な値: Primary: プライマリインスタンス Readonly: 読み取り専用インスタンス Guard: ディザスタリカバリインスタンス Temp: 一時インスタンス
DBInstanceStatus	String	インスタンスの状態。	詳細については、「インスタンス状態表」をご参照ください。
VSwitchId	String	vSwitch ID。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
Category	String	インスタンスのエディション。	有効な値: Basic: RDS ベーシックエディション HighAvailability: RDS 高可用性エディション Finance: RDS エンタープライズエディション説明このプロパティは、InstanceLevel が 1 に設定されている場合に返されます。
Engine	String	データベースエンジンのタイプ。	有効な値: MySQL SQLServer PostgreSQL MariaDB
DBInstanceClass	String	インスタンスタイプ。	詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。
ReadOnlyDBInstanceIds	List	読み取り専用インスタンスの ID。	なし。
DeletionProtection	Boolean	リリース保護機能が有効になっているかどうかを示します。	有効な値: true false

例

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "インスタンスのID。" // The ID of the instance.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstances",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstances": {
      "Description": "RDS データベースインスタンスのリスト。", // The list of The RDS Database instances.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstances"
        ]
      }
    },
    "DBInstanceIds": {
      "Description": "RDS データベースインスタンス ID のリスト。", // The list of The RDS Database instance Ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: インスタンスのID。 # The ID of the instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::RDS::DBInstances
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  DBInstances:
    Description: RDS データベースインスタンスのリスト。 # The list of The RDS Database instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstances
  DBInstanceIds:
    Description: RDS データベースインスタンス ID のリスト。 # The list of The RDS Database instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIds