DATASOURCE::PolarDBX::Database

更新时间:2025-04-03 10:19:43

DATASOURCE::PolarDBX::Database类型用于获取PolarDB-X单个数据库详情。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

属性名称

类型

必须

允许更新

描述

约束

DBInstanceId

String

PolarDB-X实例ID。

PolarDBXDatabaseName

String

PolarDB-X数据库名称。

RefreshOptions

String

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

有效值:

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

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

返回值

Fn::GetAtt

  • CharacterSetName:字符集。

  • DBInstanceId:PolarDB-X实例ID。

  • PolarDBXDatabaseName:PolarDB-X数据库名称。

  • DatabaseDescription:PolarDB-X数据库描述。

  • Accounts:账户列表。

示例

YAML
JSON
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: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PolarDBX::Database
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
      PolarDBXDatabaseName:
        Ref: PolarDBXDatabaseName
Outputs:
  CharacterSetName:
    Description: The character set that is supported by the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CharacterSetName
  DBInstanceId:
    Description: The ID of the PolarDB-X 2.0 instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceId
  PolarDBXDatabaseName:
    Description: The name of the PolarDB-X instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PolarDBXDatabaseName
  DatabaseDescription:
    Description: The description of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DatabaseDescription
  Accounts:
    Description: The list of accounts that can be used to access the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Accounts
{
  "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": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PolarDBX::Database",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "PolarDBXDatabaseName": {
          "Ref": "PolarDBXDatabaseName"
        }
      }
    }
  },
  "Outputs": {
    "CharacterSetName": {
      "Description": "The character set that is supported by the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CharacterSetName"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The ID of the PolarDB-X 2.0 instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      }
    },
    "PolarDBXDatabaseName": {
      "Description": "The name of the PolarDB-X instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PolarDBXDatabaseName"
        ]
      }
    },
    "DatabaseDescription": {
      "Description": "The description of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DatabaseDescription"
        ]
      }
    },
    "Accounts": {
      "Description": "The list of accounts that can be used to access the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Accounts"
        ]
      }
    }
  }
}
                        
  • 本页导读 (1)
  • 语法
  • 属性
  • 返回值
  • 示例
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等