DATASOURCE::POLARDB::ParameterGroups - Resource Orchestration Service

DATASOURCE::POLARDB::ParameterGroups is used to query parameter templates in a specific region.

Syntax

{
  "Type": "DATASOURCE::POLARDB::ParameterGroups",
  "Properties": {
    "DbVersion": String,
    "DbType": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DbVersion

String

Yes

The type of the database engine.

Only MySQL is supported.

DbType

String

Yes

The version of the database engine.

Valid values:

Return values

Fn::GetAtt

ParameterGroups: details of the parameter templates.
ParameterGroupIds: the IDs of the parameter templates.

Property	Type	Description	Constraint
ParameterGroupIds	List	The IDs of the parameter templates.	None.
ParameterGroups	List	Details of the parameter templates.	None.
DbType	String	The type of the database engine.	None.
ParameterGroupId	String	The ID of the property template.	None.
ParameterCounts	Number	The number of parameters in the parameter template.	None.
DbVersion	String	The version of the database engine.	None.
ParameterGroupDesc	String	The description of the parameter template.	None.
ParameterGroupType	String	The type of the parameter template.	Valid values: 0: default parameter template. 1: custom parameter template. 2: automatic backup parameter template. After you use this type of template, the system automatically backs up the original property settings and saves the backup as a template.
ForceRestart	String	Indicates whether a restart for the cluster is required for the parameter template to take effect.	Valid values: 0: A restart for the cluster is not required. 1: A restart for the cluster is required.
ParameterGroupName	String	The name of the parameter template.	None.
CreateTime	String	The time when the parameter template was created.	The time follows the ISO 8601 standard in the `YYYY-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC .

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::POLARDB::ParameterGroups
    Properties:
      DbVersion: '5.7'
      DbType: MySQL
Outputs:
  ParameterGroups:
    Description: The list of parameter groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroups
  ParameterGroupIds:
    Description: The list of parameter group IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterGroupIds

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::POLARDB::ParameterGroups",
      "Properties": {
        "DbVersion": "5.7",
        "DbType": "MySQL"
      }
    }
  },
  "Outputs": {
    "ParameterGroups": {
      "Description": "The list of parameter groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroups"
        ]
      }
    },
    "ParameterGroupIds": {
      "Description": "The list of parameter group IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterGroupIds"
        ]
      }
    }
  }
}