DATASOURCE::DRDS::DrdsDB リソースプロパティと PolarDB-X DB 属性 - ROS

DATASOURCE::DRDS::DrdsDB は、インスタンス上の単一データベースに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::DRDS::DrdsDB",
  "Properties": {
    "DrdsDatabaseName": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

DrdsDatabaseName

String

はい

データベース名。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時にデータソースリソースをリフレッシュするポリシー。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

DrdsDatabaseName: データベース名。
StorageType: データベースのパーティションモード。
SplitMode: データベースタイプ。
InstRole: インスタンスロール。
Schema: システムによってパーティションデータベースに割り当てられたスキーマ ID。
CreateTime: データベースが作成された時刻。

例

YAML 形式

                              ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DrdsDatabaseName:
    Description:
      en: The name of the Drds database.
    Required: true
    Type: String
  RefreshOptions:
    AllowedValues:
    - Always
    - Never
    Default: Never
    Description:
      en: 'The refresh strategy for the datasource resource when the stack is updated.
        Valid values:

        - Never: Never refresh the datasource resource when the stack is updated.

        - Always: Always refresh the datasource resource when the stack is updated.

        Default is Never.'
    Required: false
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DrdsDatabaseName:
        Ref: DrdsDatabaseName
      RefreshOptions:
        Ref: RefreshOptions
    Type: DATASOURCE::DRDS::DrdsDB
Outputs:
  CreateTime:
    Description: データベース作成タイムスタンプ。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  DrdsDatabaseName:
    Description: Drds データベースの名前。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DrdsDatabaseName
  InstRole:
    Description: 'データベースタイプ: MASTER プライマリインスタンス、SLAVE 読み取り専用インスタンス。'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstRole
  Schema:
    Description: システムによってパーティションデータベースに割り当てられたスキーマ ID。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Schema
  SplitMode:
    Description: "データベースのパーティションモード。有効な値: \n* HORIZONTAL: データベースは水平方向にパーティション分割されています。\n* VERTICAL: データベースは垂直方向にパーティション分割されています。"
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SplitMode
  StorageType:
    Description: 'Drds データベースのストレージタイプ。有効な値:

      * RDS

      * PolarDB'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - StorageType

JSON 形式

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DrdsDatabaseName": {
      "Type": "String",
      "Description": {
        "en": "The name of the Drds database."
      },
      "Required": true
    },
    "RefreshOptions": {
      "Type": "String",
      "Description": {
        "en": "The refresh strategy for the datasource resource when the stack is updated. Valid values:\n- Never: Never refresh the datasource resource when the stack is updated.\n- Always: Always refresh the datasource resource when the stack is updated.\nDefault is Never."
      },
      "AllowedValues": [
        "Always",
        "Never"
      ],
      "Required": false,
      "Default": "Never"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DRDS::DrdsDB",
      "Properties": {
        "DrdsDatabaseName": {
          "Ref": "DrdsDatabaseName"
        },
        "RefreshOptions": {
          "Ref": "RefreshOptions"
        }
      }
    }
  },
  "Outputs": {
    "DrdsDatabaseName": {
      "Description": "Drds データベースの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DrdsDatabaseName"
        ]
      }
    },
    "StorageType": {
      "Description": "Drds データベースのストレージタイプ。有効な値:\n* RDS\n* PolarDB",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageType"
        ]
      }
    },
    "SplitMode": {
      "Description": "データベースのパーティションモード。有効な値: \n* HORIZONTAL: データベースは水平方向にパーティション分割されています。\n* VERTICAL: データベースは垂直方向にパーティション分割されています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SplitMode"
        ]
      }
    },
    "InstRole": {
      "Description": "データベースタイプ: MASTER プライマリインスタンス、SLAVE 読み取り専用インスタンス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstRole"
        ]
      }
    },
    "Schema": {
      "Description": "システムによってパーティションデータベースに割り当てられたスキーマ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Schema"
        ]
      }
    },
    "CreateTime": {
      "Description": "データベース作成タイムスタンプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    }
  }
}