ALIYUN::POLARDB::ParameterGroup リソースタイプの概要 - ROS

ALIYUN::POLARDB::ParameterGroup は、PolarDB のパラメータテンプレートを作成するために使用されます。

構文

{
  "Type": "ALIYUN::POLARDB::ParameterGroup",
  "Properties": {
    "Parameters": List,
    "DbVersion": String,
    "ResourceGroupId": String,
    "ParameterGroupName": String,
    "ParameterGroupDesc": String,
    "DbType": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Parameters	List	はい	いいえ	パラメータテンプレートのパラメータの詳細。	詳細については、パラメータのプロパティをご参照ください。説明 DescribeParameterTemplates オペレーションを呼び出して、指定されたデータベースエンジンバージョンのクラスタ内のすべてのパラメータの詳細をクエリできます。詳細には、パラメータの名前と有効な値が含まれます。
DbVersion	String	はい	いいえ	データベースエンジンのバージョン。	有効な値: 5.6 5.7 8.0
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
ParameterGroupName	String	はい	いいえ	パラメータテンプレートの名前。	名前は次の要件を満たしている必要があります。名前には、文字、数字、アンダースコア(_) を使用できます。名前は文字で始まり、アンダースコア(_) で終わることはできません。名前は 8 ～ 64 文字である必要があります。
ParameterGroupDesc	String	いいえ	いいえ	パラメータテンプレートの説明。	説明は最大 199 文字まで入力できます。
DbType	String	はい	いいえ	データベースエンジンのタイプ。	MySQL のみがサポートされています。

パラメータの構文

"Parameters": [
  {
    "ParamValue": String,
    "ParamName": String
  }
]

パラメータのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ParamValue	String	はい	いいえ	パラメータの値。	なし。
ParamName	String	はい	いいえ	パラメータの名前。	なし。

戻り値

Fn::GetAtt

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

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::POLARDB::ParameterGroup
    Properties:
      Parameters:
        - ParamValue: '86400'
          ParamName: wait_timeout
      DbVersion: '8.0'
      ParameterGroupName: test_group
      ParameterGroupDesc: test_group
      DbType: MySQL
Outputs:
  Parameters:
    Description: パラメータのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Parameters
  ParameterGroupId:
    Description: パラメータグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterGroupId
  DbVersion:
    Description: データベースエンジンのバージョン。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbVersion
  ForceRestart:
    Description: このパラメータテンプレートが適用されたときにクラスタを再起動するかどうかを示します。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ForceRestart
  ParameterGroupName:
    Description: パラメータテンプレートの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterGroupName
  ParameterGroupDesc:
    Description: パラメータテンプレートの説明。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterGroupDesc
  ParameterGroupType:
    Description: パラメータテンプレートのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterGroupType
  CreateTime:
    Description: パラメータテンプレートが作成された時刻。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  ParameterCounts:
    Description: パラメータテンプレート内のパラメータの数。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterCounts
  DbType:
    Description: データベースエンジンのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbType

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::POLARDB::ParameterGroup",
      "Properties": {
        "Parameters": [
          {
            "ParamValue": "86400",
            "ParamName": "wait_timeout"
          }
        ],
        "DbVersion": "8.0",
        "ParameterGroupName": "test_group",
        "ParameterGroupDesc": "test_group",
        "DbType": "MySQL"
      }
    }
  },
  "Outputs": {
    "Parameters": {
      "Description": "パラメータ のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Parameters"
        ]
      }
    },
    "ParameterGroupId": {
      "Description": "パラメータグループ の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterGroupId"
        ]
      }
    },
    "DbVersion": {
      "Description": "データベースエンジン のバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbVersion"
        ]
      }
    },
    "ForceRestart": {
      "Description": "このパラメータテンプレートが適用されたときにクラスタを再起動するかどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ForceRestart"
        ]
      }
    },
    "ParameterGroupName": {
      "Description": "パラメータテンプレート の名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterGroupName"
        ]
      }
    },
    "ParameterGroupDesc": {
      "Description": "パラメータテンプレート の説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterGroupDesc"
        ]
      }
    },
    "ParameterGroupType": {
      "Description": "パラメータテンプレート のタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterGroupType"
        ]
      }
    },
    "CreateTime": {
      "Description": "パラメータテンプレートが作成された時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "ParameterCounts": {
      "Description": "パラメータテンプレート内のパラメータ の数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterCounts"
        ]
      }
    },
    "DbType": {
      "Description": "データベースエンジン のタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbType"
        ]
      }
    }
  }
}