How to use DATASOURCE::DRDS::DrdsDBs to query the database details of an instance - Resource Orchestration Service

DATASOURCE::DRDS::DrdsDBs is used to query the information about databases on an instance.

Syntax

{
  "Type": "DATASOURCE::DRDS::DrdsDBs",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

InstanceId

String

Yes

The ID of the instance on which the databases reside.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

DrdsDatabaseNames: the names of the databases.
Databases: details of the databases.

Property	Type	Description	Constraint
DrdsDatabaseNames	List	The names of the databases.	None.
Databases	List	Details of the databases.	None.
Status	String	The status of the database.	None.
StorageType	String	The partition mode of the database.	Valid values: HORIZONTAL: The database is horizontally partitioned. VERTICAL: The database is vertically partitioned.
SplitMode	String	The type of the database engine.	Valid values: RDS PolarDB
Schema	String	The schema ID that the system assigns to the partitioned database.	None.
CreateTime	String	The time when the database was created.	This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
DrdsDatabaseName	String	The database name.	None.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description: Drds Instance ID.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
    Type: DATASOURCE::DRDS::DrdsDBs
Outputs:
  Databases:
    Description: The list of drds databases.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Databases
  DrdsDatabaseNames:
    Description: The list of drds database names.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DrdsDatabaseNames

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "Drds Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DRDS::DrdsDBs",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DrdsDatabaseNames": {
      "Description": "The list of drds database names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DrdsDatabaseNames"
        ]
      }
    },
    "Databases": {
      "Description": "The list of drds databases.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Databases"
        ]
      }
    }
  }
}