すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:データソース::DRDS::DrdsInstance

最終更新日:Mar 17, 2025

DATASOURCE::DRDS::DrdsInstance は、PolarDB-X 1.0 インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::DRDS::DrdsInstance",
  "Properties": {
    "DrdsInstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

DrdsInstanceId

String

はい

はい

インスタンス ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

  • Never(デフォルト):スタックの更新時にデータソースリソースをリフレッシュしません。

  • Always:スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

  • InstanceSpec: インスタンスの仕様。

  • Description: インスタンスの説明。

  • StorageType: データベースのパーティションモード。

  • ExpireDate: 有効期限のタイムスタンプ。

  • ResourceGroupId: インスタンスが属するリソースグループの ID。

  • ZoneId: ゾーン。

  • CreateTime: 作成タイムスタンプ。

  • Label: インスタンスのラベル。

  • MachineType: インスタンスのマシンタイプ。

  • InstanceSeries: インスタンスタイプ。

  • VersionAction: インスタンスのバージョンで実行できる操作。

  • MysqlVersion: MySQL バージョン。

  • Type: インスタンスのタイプ。

  • DrdsInstanceId: インスタンス ID。

  • MasterInstanceId: プライマリインスタンスの ID。

  • Version: インスタンスのバージョン。

  • OrderInstanceId: 購入したインスタンスの ID。

  • InstRole: インスタンスのロール。

  • NetworkType: ネットワークタイプ。

  • ReadOnlyDBInstanceIds: 読み取り専用インスタンスの ID。

  • CommodityCode: 商品コード。

  • VpcCloudInstanceId: VPC(Virtual Private Cloud)にデプロイされているインスタンスの ID。

  • Vips: 仮想 IP アドレス(VIP)。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DrdsInstanceId:
        Type: String
        Description:
          ja: DRDS インスタンスの ID。
        Required: true
    Resources:
      ExtensionDataSource:
        Type: DATASOURCE::DRDS::DrdsInstance
        Properties:
          DrdsInstanceId:
            Ref: DrdsInstanceId
    Outputs:
      InstanceSpec:
        Description: インスタンスの仕様。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstanceSpec
      Description:
        Description: インスタンスの説明。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Description
      StorageType:
        Description: |-
          DRDS データベースのストレージタイプ。有効な値:
          * RDS
          * PolarDB
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - StorageType
      ExpireDate:
        Description: インスタンスの有効期限を示すタイムスタンプ。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ExpireDate
      ResourceGroupId:
        Description: インスタンスが属するリソースグループの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ResourceGroupId
      ZoneId:
        Description: リソースが配置されているゾーンの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ZoneId
      CreateTime:
        Description: インスタンスが作成された日時を示すタイムスタンプ。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - CreateTime
      Label:
        Description: |-
          インスタンスのタグ。有効な値:
          * NORMAL: インスタンスは標準インスタンスです。
          * HA: インスタンスは高可用性(HA)インスタンスです。
          * VPC: インスタンスは VPC ベースのインスタンスです。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Label
      MachineType:
        Description: 'インスタンスのマシンタイプ。有効な値:ecs。'
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - MachineType
      InstanceSeries:
        Description: |-
          インスタンスのエディション。有効な値:
          * starter: Starter Edition
          * enterprise: Enterprise Edition
          * standard: Standard Edition
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstanceSeries
      VersionAction:
        Description: インスタンスのバージョンをアップグレードできるかどうかを示します。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - VersionAction
      MysqlVersion:
        Description: エンジンバージョン。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - MysqlVersion
      Type:
        Description: |-
          インスタンスのタイプ。有効な値:
          * PUBLIC: 返されるインスタンスは共有インスタンスです。
          * PRIVATE: 返されるインスタンスは専用インスタンスです。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Type
      DrdsInstanceId:
        Description: DRDS インスタンスの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DrdsInstanceId
      MasterInstanceId:
        Description: プライマリインスタンスの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - MasterInstanceId
      Version:
        Description: インスタンスのバージョン。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Version
      OrderInstanceId:
        Description: 購入したインスタンスの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - OrderInstanceId
      InstRole:
        Description: |-
          インスタンスのロール。有効な値:
          * MASTER: インスタンスはプライマリインスタンスです。
          * SLAVE: インスタンスは、複雑なクエリを分析するための読み取り専用インスタンスです。
          * SLAVE_FLOW: インスタンスは、高並列シナリオ向けの読み取り専用インスタンスです。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstRole
      NetworkType:
        Description: |-
          インスタンスのネットワークタイプ。有効な値:
          * CLASSIC
          * VPC
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - NetworkType
      ReadOnlyDBInstanceIds:
        Description: インスタンスに関連付けられている読み取り専用インスタンスの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ReadOnlyDBInstanceIds
      CommodityCode:
        Description: サービスの商品コード。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - CommodityCode
      VpcCloudInstanceId:
        Description: VPC にデプロイされているインスタンスの ID。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - VpcCloudInstanceId
      Vips:
        Description: 返される仮想 IP アドレス(VIP)のリスト。
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Vips
    
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DrdsInstanceId": {
          "Type": "String",
          "Description": {
            "ja": "DRDS インスタンスの ID。"
          },
          "Required": true
        }
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::DRDS::DrdsInstance",
          "Properties": {
            "DrdsInstanceId": {
              "Ref": "DrdsInstanceId"
            }
          }
        }
      },
      "Outputs": {
        "InstanceSpec": {
          "Description": "インスタンスの仕様。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstanceSpec"
            ]
          }
        },
        "Description": {
          "Description": "インスタンスの説明。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Description"
            ]
          }
        },
        "StorageType": {
          "Description": "DRDS データベースのストレージタイプ。有効な値:\n* RDS\n* PolarDB",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "StorageType"
            ]
          }
        },
        "ExpireDate": {
          "Description": "インスタンスの有効期限を示すタイムスタンプ。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ExpireDate"
            ]
          }
        },
        "ResourceGroupId": {
          "Description": "インスタンスが属するリソースグループの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ResourceGroupId"
            ]
          }
        },
        "ZoneId": {
          "Description": "リソースが配置されているゾーンの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ZoneId"
            ]
          }
        },
        "CreateTime": {
          "Description": "インスタンスが作成された日時を示すタイムスタンプ。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "CreateTime"
            ]
          }
        },
        "Label": {
          "Description": "インスタンスのタグ。有効な値:\n* NORMAL: インスタンスは標準インスタンスです。\n* HA: インスタンスは高可用性(HA)インスタンスです。\n* VPC: インスタンスは VPC ベースのインスタンスです。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Label"
            ]
          }
        },
        "MachineType": {
          "Description": "インスタンスのマシンタイプ。有効な値:ecs。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "MachineType"
            ]
          }
        },
        "InstanceSeries": {
          "Description": "インスタンスのエディション。有効な値:\n* starter: Starter Edition\n* enterprise: Enterprise Edition\n* standard: Standard Edition",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstanceSeries"
            ]
          }
        },
        "VersionAction": {
          "Description": "インスタンスのバージョンをアップグレードできるかどうかを示します。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "VersionAction"
            ]
          }
        },
        "MysqlVersion": {
          "Description": "エンジンバージョン。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "MysqlVersion"
            ]
          }
        },
        "Type": {
          "Description": "インスタンスのタイプ。有効な値:\n* PUBLIC: 返されるインスタンスは共有インスタンスです。\n* PRIVATE: 返されるインスタンスは専用インスタンスです。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Type"
            ]
          }
        },
        "DrdsInstanceId": {
          "Description": "DRDS インスタンスの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DrdsInstanceId"
            ]
          }
        },
        "MasterInstanceId": {
          "Description": "プライマリインスタンスの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "MasterInstanceId"
            ]
          }
        },
        "Version": {
          "Description": "インスタンスのバージョン。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Version"
            ]
          }
        },
        "OrderInstanceId": {
          "Description": "購入したインスタンスの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "OrderInstanceId"
            ]
          }
        },
        "InstRole": {
          "Description": "インスタンスのロール。有効な値:\n* MASTER: インスタンスはプライマリインスタンスです。\n* SLAVE: インスタンスは、複雑なクエリを分析するための読み取り専用インスタンスです。\n* SLAVE_FLOW: インスタンスは、高並列シナリオ向けの読み取り専用インスタンスです。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstRole"
            ]
          }
        },
        "NetworkType": {
          "Description": "インスタンスのネットワークタイプ。有効な値:\n* CLASSIC\n* VPC",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "NetworkType"
            ]
          }
        },
        "ReadOnlyDBInstanceIds": {
          "Description": "インスタンスに関連付けられている読み取り専用インスタンスの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ReadOnlyDBInstanceIds"
            ]
          }
        },
        "CommodityCode": {
          "Description": "サービスの商品コード。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "CommodityCode"
            ]
          }
        },
        "VpcCloudInstanceId": {
          "Description": "VPC にデプロイされているインスタンスの ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "VpcCloudInstanceId"
            ]
          }
        },
        "Vips": {
          "Description": "返される仮想 IP アドレス(VIP)のリスト。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Vips"
            ]
          }
        }
      }
    }