全部产品
Search
文档中心

资源编排:ALIYUN::POLARDB::ParameterGroup

更新时间:Mar 01, 2023

ALIYUN::POLARDB::ParameterGroup类型用于创建PolarDB参数模板。

语法

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

属性

属性名称类型必须允许更新描述约束
ParametersList参数详情列表。更多信息,请参见Parameters属性
说明 您可以通过DescribeParameterTemplates接口查看目标数据库引擎版本数据库集群的所有参数详情,包括参数名称、取值范围等。
DbVersionString数据库引擎版本号。取值:
  • 5.6
  • 5.7
  • 8.0
ResourceGroupIdString资源组ID。
ParameterGroupNameString参数模板的名称。要求如下:
  • 由英文、数字、和下划线(_)组成,以字母开头,不能包含中文,不能以下划线(_)结尾。
  • 长度为8~64个字符。
ParameterGroupDescString参数模板的描述。长度为0~199个字符。
DbTypeString数据库引擎类型。当前仅支持MySQL。

Parameters语法

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

Parameters属性

属性名称类型必须允许更新描述约束
ParamValueString参数值。
ParamNameString参数名称。

返回值

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: The list of the parameters.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Parameters
      ParameterGroupId:
        Description: The ID of the parameter group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupId
      DbVersion:
        Description: The version of the database engine.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DbVersion
      ForceRestart:
        Description: Indicates whether to restart the cluster when this parameter template is applied.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ForceRestart
      ParameterGroupName:
        Description: The name of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupName
      ParameterGroupDesc:
        Description: The description of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupDesc
      ParameterGroupType:
        Description: The type of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupType
      CreateTime:
        Description: The time when the parameter template was created.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - CreateTime
      ParameterCounts:
        Description: The number of parameters in the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterCounts
      DbType:
        Description: The type of the database engine.
        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": "The list of the parameters.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Parameters"
            ]
          }
        },
        "ParameterGroupId": {
          "Description": "The ID of the parameter group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupId"
            ]
          }
        },
        "DbVersion": {
          "Description": "The version of the database engine.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DbVersion"
            ]
          }
        },
        "ForceRestart": {
          "Description": "Indicates whether to restart the cluster when this parameter template is applied.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ForceRestart"
            ]
          }
        },
        "ParameterGroupName": {
          "Description": "The name of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupName"
            ]
          }
        },
        "ParameterGroupDesc": {
          "Description": "The description of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupDesc"
            ]
          }
        },
        "ParameterGroupType": {
          "Description": "The type of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupType"
            ]
          }
        },
        "CreateTime": {
          "Description": "The time when the parameter template was created.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "CreateTime"
            ]
          }
        },
        "ParameterCounts": {
          "Description": "The number of parameters in the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterCounts"
            ]
          }
        },
        "DbType": {
          "Description": "The type of the database engine.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DbType"
            ]
          }
        }
      }
    }