DATASOURCE::POLARDB::ParameterGroup - 资源编排

DATASOURCE::POLARDB::ParameterGroup类型用于查看目标地域的单个参数模板详情。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

ParameterGroupId

String

是

参数模板ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

Parameters：参数模板详情。
ParameterGroupId：参数模板ID。
DbVersion：数据库引擎版本号。
ForceRestart：应用该参数模板是否需要重启集群。
ParameterGroupName：参数模板名称。
ParameterGroupDesc：参数模板描述。
ParameterGroupType：参数模板类型。
CreateTime：参数模板创建时间。
ParameterCounts：参数模板内的参数数量。
DbType：数据库引擎类型。

示例

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