DATASOURCE::POLARDB::ParameterGroup - Resource Orchestration Service

DATASOURCE::POLARDB::ParameterGroup is used to query the information about a parameter template in a region.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

ParameterGroupId

String

Yes

The ID of the parameter template.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

Parameters: the details of the parameter template.
ParameterGroupId: the ID of the parameter template.
DbVersion: the version of the database engine.
ForceRestart: indicates whether the cluster needs to be restarted for 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

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": "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:\n* 0: A restart is not required.\n* 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:\n0: the default parameter template.\n1: a custom parameter template.\n2: 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"
        ]
      }
    }
  }
}