DATASOURCE::POLARDB::ParameterGroup リソースリファレンス - Resource Orchestration Service (ROS)

DATASOURCE::POLARDB::ParameterGroup は、リージョン内のパラメータテンプレートに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::POLARDB::ParameterGroup",
  "Properties": {
    "ParameterGroupId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ParameterGroupId

String

はい

パラメータテンプレートの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックが更新されたときのデータソースリソースのリフレッシュポリシー。

有効な値:

Never (デフォルト): スタックが更新されたときにデータソースリソースをリフレッシュしません。
Always: スタックが更新されたときにデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Parameters: パラメータテンプレートの詳細。
ParameterGroupId: パラメータテンプレートの ID。
DbVersion: データベースエンジンのバージョン。
ForceRestart: パラメータテンプレートを有効にするためにクラスタを再起動する必要があるかどうかを示します。
ParameterGroupName: パラメータテンプレートの名前。
ParameterGroupDesc: パラメータテンプレートの説明。
ParameterGroupType: パラメータテンプレートのタイプ。
CreateTime: パラメータテンプレートが作成された時刻。
ParameterCounts: パラメータテンプレート内のパラメータの数。
DbType: データベースエンジンのタイプ。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ParameterGroupId:
    Type: String
    Description:
      en: The ID of the parameter template.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::POLARDB::ParameterGroup
    Properties:
      ParameterGroupId:
        Ref: ParameterGroupId
Outputs:
  Parameters:
    Description: Details about the parameter templates.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Parameters
  ParameterGroupId:
    Description: The ID of the parameter template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroupId
  DbVersion:
    Description: The version of the database engine.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbVersion
  ForceRestart:
    Description: |-
      Indicates whether to restart the cluster when this parameter template is applied. Valid values:
      * 0: A restart is not required.
      * 1: A restart is required.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ForceRestart
  ParameterGroupName:
    Description: The name of the parameter template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroupName
  ParameterGroupDesc:
    Description: The description of the parameter template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroupDesc
  ParameterGroupType:
    Description: |-
      The type of the parameter template. Valid values:
      0: the default parameter template.
      1: a custom parameter template.
      2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroupType
  CreateTime:
    Description: The time when the parameter template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  ParameterCounts:
    Description: The number of parameters in the parameter template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterCounts
  DbType:
    Description: The type of the database engine.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ParameterGroupId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the parameter template."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::POLARDB::ParameterGroup",
      "Properties": {
        "ParameterGroupId": {
          "Ref": "ParameterGroupId"
        }
      }
    }
  },
  "Outputs": {
    "Parameters": {
      "Description": "パラメータテンプレートに関する詳細。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Parameters"
        ]
      }
    },
    "ParameterGroupId": {
      "Description": "パラメータテンプレートの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroupId"
        ]
      }
    },
    "DbVersion": {
      "Description": "データベースエンジンのバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbVersion"
        ]
      }
    },
    "ForceRestart": {
      "Description": "このパラメータテンプレートが適用されたときにクラスタを再起動するかどうかを示します。有効な値:\n* 0: 再起動は不要です。\n* 1: 再起動が必要です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ForceRestart"
        ]
      }
    },
    "ParameterGroupName": {
      "Description": "パラメータテンプレートの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroupName"
        ]
      }
    },
    "ParameterGroupDesc": {
      "Description": "パラメータテンプレートの説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroupDesc"
        ]
      }
    },
    "ParameterGroupType": {
      "Description": "パラメータテンプレートのタイプ。有効な値:\n0: デフォルトのパラメータテンプレート。\n1: カスタムパラメータテンプレート。\n2: 自動バックアップパラメータテンプレート。このタイプのテンプレートを適用すると、システムは元の パラメータ設定を自動的にバックアップし、バックアップをテンプレートとして保存します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroupType"
        ]
      }
    },
    "CreateTime": {
      "Description": "パラメータテンプレートが作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "ParameterCounts": {
      "Description": "パラメータテンプレート内のパラメータの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterCounts"
        ]
      }
    },
    "DbType": {
      "Description": "データベースエンジンのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbType"
        ]
      }
    }
  }
}