ALIYUN::POLARDB::ParameterGroup - Resource Orchestration Service

ALIYUN::POLARDB::ParameterGroup is used to create a parameter template of PolarDB.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
Parameters	List	Yes	No	Details of the parameters in the parameter template.	For more information, see Parameters properties. Note You can call the DescribeParameterTemplates operation to query the details of all parameters in a cluster of a specified database engine version. The details include names and valid values of the parameters.
DbVersion	String	Yes	No	The version of the database engine.	Valid values: 5.6 5.7 8.0
ResourceGroupId	String	No	No	The ID of the resource group.	None.
ParameterGroupName	String	Yes	No	The name of the parameter template.	The name must meet the following requirements: The name can contain letters, digits, and underscores (_). The name must start with a letter and cannot end with an underscore (_). The name must be 8 to 64 characters in length.
ParameterGroupDesc	String	No	No	The description of the parameter template.	The description can be up to 199 characters in length.
DbType	String	Yes	No	The type of the database engine.	Only MySQL is supported.

Parameters syntax

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

Parameters properties

Property	Type	Required	Editable	Description	Constraint
ParamValue	String	Yes	No	The value of the parameter.	None.
ParamName	String	Yes	No	The name of the parameter.	None.

Return values

Fn::GetAtt

Parameters: details of the parameters in the parameter template.
ParameterGroupId: the ID of the parameter template.
DbVersion: the version of the database engine.
ForceRestart: indicates whether the cluster must be restarted to allow the parameter template to take effect.
ParameterGroupName: the name of the parameter template.
ParameterGroupDesc: the description of the parameter template.
ParameterGroupType: the type of the parameter template.
CreateTime: the time when the parameter template was created.
ParameterCounts: the number of parameters in the parameter template.
DbType: the type of the database engine.

Examples

YAML format

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 format

{
  "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"
        ]
      }
    }
  }
}