DATASOURCE::PolarDBX::Databases

DATASOURCE::PolarDBX::Databases类型用于获取PolarDB-X数据库列表。

语法

{
  "Type": "DATASOURCE::PolarDBX::Databases",
  "Properties": {
    "DBInstanceId": String,
    "PolarDBXDatabaseName": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DBInstanceId

String

PolarDB-X实例ID。

PolarDBXDatabaseName

String

PolarDB-X数据库名称。

RefreshOptions

String

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

返回值

Fn::GetAtt

  • PolarDBXDatabaseNames:PolarDB-X数据库名称列表。

  • PolarDBXDatabases:PolarDB-X数据库详情列表。

属性名称

类型

描述

约束

PolarDBXDatabaseNames

List

PolarDB-X数据库名称列表。

PolarDBXDatabases

List

PolarDB-X数据库详情列表。

DatabaseDescription

String

PolarDB-X数据库描述信息。

PolarDBXDatabaseName

String

PolarDB-X数据库名称。

CharacterSetName

String

字符集。

Accounts

String

账户列表。

DBInstanceId

String

PolarDB-X数据库实例ID。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description:
      en: The ID of the PolarDB-X 2.0 instance.
    Required: true
  PolarDBXDatabaseName:
    Type: String
    Description:
      en: The name of the PolarDB-X 2.0 instance.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PolarDBX::Databases
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
      PolarDBXDatabaseName:
        Ref: PolarDBXDatabaseName
Outputs:
  PolarDBXDatabaseNames:
    Description: The list of PolarDB-X 2.0 database names.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PolarDBXDatabaseNames
  PolarDBXDatabases:
    Description: The list of PolarDB-X 2.0 databases.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PolarDBXDatabases
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the PolarDB-X 2.0 instance."
      },
      "Required": true
    },
    "PolarDBXDatabaseName": {
      "Type": "String",
      "Description": {
        "en": "The name of the PolarDB-X 2.0 instance."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PolarDBX::Databases",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "PolarDBXDatabaseName": {
          "Ref": "PolarDBXDatabaseName"
        }
      }
    }
  },
  "Outputs": {
    "PolarDBXDatabaseNames": {
      "Description": "The list of PolarDB-X 2.0 database names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PolarDBXDatabaseNames"
        ]
      }
    },
    "PolarDBXDatabases": {
      "Description": "The list of PolarDB-X 2.0 databases.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PolarDBXDatabases"
        ]
      }
    }
  }
}