DATASOURCE::DRDS::DrdsDBs is used to query the details of databases on an instance.

Syntax

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

Properties

PropertyTypeRequiredEditableDescriptionConstraint
InstanceIdStringYesYesThe ID of the instance on which the databases reside. None.

Return values

Fn::GetAtt

  • DrdsDatabaseNames: the names of the databases.
  • Databases: details of the databases.
PropertyTypeDescriptionConstraint
DrdsDatabaseNamesListThe names of the databases. None.
DatabasesListDetails of the databases. None.
StatusStringThe state of the database. None.
StorageTypeStringThe partition mode of the database. Valid values:
  • HORIZONTAL: The database is horizontally partitioned.
  • VERTICAL: The database is vertically partitioned.
SplitModeStringThe engine of the database. Valid values:
  • RDS
  • PolarDB
SchemaStringThe schema ID that is assigned to the partitioned database by the system. None.
CreateTimeStringThe 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.
DrdsDatabaseNameStringThe name of the database. 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"
            ]
          }
        }
      }
    }