すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:DATASOURCE::GraphDatabase::DbInstance

    ドキュメントセンター

    Resource Orchestration Service:DATASOURCE::GraphDatabase::DbInstance

    最終更新日:Mar 17, 2025

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

    構文

    {
  "Type": "DATASOURCE::GraphDatabase::DbInstance",
  "Properties": {
    "DbInstanceId": String,
    "RefreshOptions": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    DbInstanceId

    String

    はい

    はい

    インスタンス ID。

    なし。

    RefreshOptions

    String

    いいえ

    はい

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

    有効な値:

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

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

    戻り値

    Fn::GetAtt

    • ResourceGroupId: リソースグループの ID。

    • DbInstanceNetworkType: インスタンスのネットワークタイプ。

    • Port: アプリケーションへのアクセスに使用するポート。

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

    • DbInstanceStorageType: インスタンスのストレージタイプ。

    • DbNodeStorage: データベースのストレージ容量。

    • DbInstanceCategory: インスタンスのエディション。

    • DbVersion: データベースのバージョン。

    • CurrentMinorVersion: データベースのカーネルバージョン。

    • PaymentType: 課金方法。

    • PublicConnectionString: インスタンスへの接続に使用するパブリックエンドポイントのプレフィックス。

    • DBInstanceId: インスタンス ID。

    • LockReason: インスタンスがロックされている理由。

    • DbNodeClass: ノードタイプ。

    • MaintainTime: インスタンスのメンテナンスウィンドウ。

    • Tags: インスタンスに追加されているタグ。

    • ZoneId: インスタンスのゾーン ID。

    • VSwitchId: インスタンスの vSwitch ID。

    • CreateTime: インスタンスの作成時間。

    • DbNodeCount: ノード数。

    • LatestMinorVersion: インスタンスでサポートされている最新のカーネルバージョン。

    • Expired: インスタンスの有効期限。

    • EcsSecurityGroupRelations: 関連付けられているセキュリティグループ。

    • LockMode: インスタンスのロックモード。

    • DbInstanceMemory: インスタンスのメモリサイズ。

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

    • VpcId: インスタンスが存在する VPC (Virtual Private Cloud) の ID。

    • DBInstanceIPArray: IP アドレスのホワイトリスト。

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

    • DbInstanceCpu: インスタンスの vCPU 数。

    • ConnectionString: データベースへの接続に使用するエンドポイント。

    • ExpireTime: サブスクリプションインスタンスのデータベースの有効期限。

    • PublicPort: データベースへの接続に使用するポート。

    例

    • YAML 形式

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DbInstanceId:
    Type: String
    Description:
      ja: GDB インスタンスの ID。
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::GraphDatabase::DbInstance
    Properties:
      DbInstanceId:
        Ref: DbInstanceId
Outputs:
  ResourceGroupId:
    Description: リソースグループ ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DbInstanceNetworkType:
    Description: DB インスタンスのネットワークタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceNetworkType
  Port:
    Description: アプリケーションポート。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Port
  DbInstanceType:
    Description: DB インスタンスのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceType
  DbInstanceStorageType:
    Description: クラウドディスク。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceStorageType
  DbNodeStorage:
    Description: インスタンスのストレージ容量 (GB 単位)。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeStorage
  DbInstanceCategory:
    Description: DB インスタンスのカテゴリ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceCategory
  DbVersion:
    Description: カーネルバージョン 1.0 は gremlin,1 として表されます。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbVersion
  CurrentMinorVersion:
    Description: 現在のカーネルイメージバージョン。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CurrentMinorVersion
  PaymentType:
    Description: 支払いタイプを表す DB インスタンスの属性フィールド。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  PublicConnectionString:
    Description: DB インスタンスのパブリック接続文字列 ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicConnectionString
  DbInstanceId:
    Description: GDB インスタンスの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceId
  LockReason:
    Description: インスタンスがロックされている理由。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LockReason
  DbNodeClass:
    Description: DB ノードのクラス。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeClass
  MaintainTime:
    Description: インスタンスのメンテナンス時間。たとえば、00:00Z-02:00Z は、0 時から 2 時まで定期メンテナンスを実行することを示します。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MaintainTime
  Tags:
    Description: GDB インスタンスのタグ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  ZoneId:
    Description: インスタンスのゾーン ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  VSwitchId:
    Description: DB インスタンスの vSwitch ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: 作成時刻。YYYY-MM-DD 'T'hh:mm:ssZ の形式 (例: 2011-05-30 T12:11:4Z)。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  DbNodeCount:
    Description: DB ノードの数。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeCount
  LatestMinorVersion:
    Description: 最新のカーネルイメージバージョン。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LatestMinorVersion
  Expired:
    Description: DB インスタンスの有効期限切れステータス。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Expired
  EcsSecurityGroupRelations:
    Description: セキュリティグループ情報配列。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EcsSecurityGroupRelations
  LockMode:
    Description: インスタンスのロック状態。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LockMode
  DbInstanceMemory:
    Description: インスタンスメモリ (MB 単位)。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceMemory
  ReadOnlyDbInstanceIds:
    Description: 読み取り専用 DB インスタンスの配列。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReadOnlyDbInstanceIds
  VpcId:
    Description: DB インスタンスの VPC ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  DBInstanceIPArray:
    Description: インスタンスグループリストの IP アドレスホワイトリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIPArray
  DbInstanceDescription:
    Description: 実用的な例またはメモ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceDescription
  DbInstanceCpu:
    Description: たとえば、インスタンスは CPU コア数に応じてグループ化できます。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceCpu
  ConnectionString:
    Description: VPN 接続や専用回線などの Virtual Private Cloud (VPC) 接続のドメイン名。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ConnectionString
  ExpireTime:
    Description: サブスクリプションインスタンスの有効期限後のインスタンス。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpireTime
  PublicPort:
    Description: DB インスタンスのパブリックポート ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicPort

    • JSON 形式

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DbInstanceId": {
      "Type": "String",
      "Description": {
        "ja": "GDB インスタンスの ID。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::GraphDatabase::DbInstance",
      "Properties": {
        "DbInstanceId": {
          "Ref": "DbInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "リソースグループ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DbInstanceNetworkType": {
      "Description": "DB インスタンスのネットワークタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceNetworkType"
        ]
      }
    },
    "Port": {
      "Description": "アプリケーションポート。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "DbInstanceType": {
      "Description": "DB インスタンスのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceType"
        ]
      }
    },
    "DbInstanceStorageType": {
      "Description": "クラウドディスク。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceStorageType"
        ]
      }
    },
    "DbNodeStorage": {
      "Description": "インスタンスのストレージ容量 (GB 単位)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeStorage"
        ]
      }
    },
    "DbInstanceCategory": {
      "Description": "DB インスタンスのカテゴリ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceCategory"
        ]
      }
    },
    "DbVersion": {
      "Description": "カーネルバージョン 1.0 は gremlin,1 として表されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbVersion"
        ]
      }
    },
    "CurrentMinorVersion": {
      "Description": "現在のカーネルイメージバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CurrentMinorVersion"
        ]
      }
    },
    "PaymentType": {
      "Description": "支払いタイプを表す DB インスタンスの属性フィールド。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "PublicConnectionString": {
      "Description": "DB インスタンスのパブリック接続文字列 ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicConnectionString"
        ]
      }
    },
    "DbInstanceId": {
      "Description": "GDB インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceId"
        ]
      }
    },
    "LockReason": {
      "Description": "インスタンスがロックされている理由。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockReason"
        ]
      }
    },
    "DbNodeClass": {
      "Description": "DB ノードのクラス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeClass"
        ]
      }
    },
    "MaintainTime": {
      "Description": "インスタンスのメンテナンス時間。たとえば、00:00Z-02:00Z は、0 時から 2 時まで定期メンテナンスを実行することを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainTime"
        ]
      }
    },
    "Tags": {
      "Description": "GDB インスタンスのタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "ZoneId": {
      "Description": "インスタンスのゾーン ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "DB インスタンスの vSwitch ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "作成時刻。YYYY-MM-DD 'T'hh:mm:ssZ の形式 (例: 2011-05-30 T12:11:4Z)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "DbNodeCount": {
      "Description": "DB ノードの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeCount"
        ]
      }
    },
    "LatestMinorVersion": {
      "Description": "最新のカーネルイメージバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LatestMinorVersion"
        ]
      }
    },
    "Expired": {
      "Description": "DB インスタンスの有効期限切れステータス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Expired"
        ]
      }
    },
    "EcsSecurityGroupRelations": {
      "Description": "セキュリティグループ情報配列。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EcsSecurityGroupRelations"
        ]
      }
    },
    "LockMode": {
      "Description": "インスタンスのロック状態。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockMode"
        ]
      }
    },
    "DbInstanceMemory": {
      "Description": "インスタンスメモリ (MB 単位)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceMemory"
        ]
      }
    },
    "ReadOnlyDbInstanceIds": {
      "Description": "読み取り専用 DB インスタンスの配列。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadOnlyDbInstanceIds"
        ]
      }
    },
    "VpcId": {
      "Description": "DB インスタンスの VPC ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DBInstanceIPArray": {
      "Description": "インスタンスグループリストの IP アドレスホワイトリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIPArray"
        ]
      }
    },
    "DbInstanceDescription": {
      "Description": "実用的な例またはメモ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceDescription"
        ]
      }
    },
    "DbInstanceCpu": {
      "Description": "たとえば、インスタンスは CPU コア数に応じてグループ化できます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceCpu"
        ]
      }
    },
    "ConnectionString": {
      "Description": "VPN 接続や専用回線などの Virtual Private Cloud (VPC) 接続のドメイン名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionString"
        ]
      }
    },
    "ExpireTime": {
      "Description": "サブスクリプションインスタンスの有効期限後のインスタンス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "PublicPort": {
      "Description": "DB インスタンスのパブリックポート ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicPort"
        ]
      }
    }
  }
}