DATASOURCE::GraphDatabase::DbInstances - Resource Orchestration Service

DATASOURCE::GraphDatabase::DbInstances is used to query the information about Graph Database (GDB) instances.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
DbInstanceDescription	String	No	Yes	The description of the instance.	None.
DbInstanceId	String	No	Yes	The ID of the instance.	None.

Return values

Fn::GetAtt

DbInstances: details of the instances.
DbInstanceIds: the IDs of the instances.

Property	Type	Description	Constraint
DbInstanceIds	List	The IDs of the instances.	None.
DbInstances	List	Details of the instances.	None.
DbInstanceDescription	String	The description of the instance.	None.
LockMode	String	The lock mode of the instance.	None.
DbInstanceCategory	String	The edition of the instance.	None.
DbVersion	String	The database engine version of the instance.	None.
DbInstanceId	String	The ID of the instance.	None.
LockReason	String	The reason why the instance is locked.	None.
Status	String	The state of the instance.	None.
VpcId	String	The ID of the virtual private cloud (VPC) in which the instance resides.	None.
Tags	List	The tags of the instance.	None.
RegionId	String	The region ID.	None.
ResourceGroupId	String	The ID of the resource group.	None.
VSwitchId	String	The vSwitch ID.	None.
DbNodeClass	String	The node type of the database.	None.
Expired	String	The expiration time of the instance.	None.
DbNodeCount	String	The number of nodes on the instance.	None.
ZoneId	String	The ID of the zone in which the instance resides.	None.
DbInstanceType	String	The instance type.	None.
DbNodeStorage	String	The storage capacity of the instance.	None.
ExpireTime	String	The expiration time of the database.	None.
PaymentType	String	The billing method of the instance.	None.
ReadOnlyDbInstanceIds	List	The IDs of the read-only instances.	None.
CreateTime	String	The time when the instance was created.	None.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DbInstanceId:
    Type: String
    Description: The first ID of the resource.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::GraphDatabase::DbInstances
    Properties:
      DbInstanceId:
        Ref: DbInstanceId
Outputs:
  DbInstances:
    Description: The list of db instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstances
  DbInstanceIds:
    Description: The list of db instance IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceIds

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DbInstanceId": {
      "Type": "String",
      "Description": "The first ID of the resource."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::GraphDatabase::DbInstances",
      "Properties": {
        "DbInstanceId": {
          "Ref": "DbInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DbInstances": {
      "Description": "The list of db instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstances"
        ]
      }
    },
    "DbInstanceIds": {
      "Description": "The list of db instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceIds"
        ]
      }
    }
  }
}