AWS::RDS::DBParameterGroup - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::RDS::DBParameterGroup

AWS::RDS::DBParameterGroup 资源为 RDS 数据库系列创建自定义参数组。

此类型可在模板中声明,并在 AWS::RDS::DBInstance 资源的 DBParameterGroupName 属性中引用。

注意

对数据库实例应用参数组可能需要重启数据库实例,从而造成重启期间数据库运行中断。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::RDS::DBParameterGroup", "Properties" : { "Description" : String, "Family" : String, "Parameters" : {Key : Value, ...}, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::RDS::DBParameterGroup Properties: Description: String Family: String Parameters: Key : Value Tags: - Tag

属性

Description

为此数据库参数组提供客户指定的描述。

必需:是

类型:字符串

Update requires: No interruption

Family

数据库参数组系列名称。数据库参数组能且仅能与一个数据库参数组系列关联,只能应用到运行数据库引擎且引擎版本与该数据库参数组系列兼容的数据库实例上。

注意

更新数据库参数组时,无法更改数据库参数组系列。

要列出所有可用的参数组系列,请使用以下命令:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

输出包含重复项。

有关更多信息,请参阅 CreateDBParameterGroup

必需:是

类型:字符串

Update requires: No interruption

Parameters

用于参数更新的参数名称和值的数组。必须至少提供一个参数名称和值。后续参数是可选的。您可以在一个请求中修改最多 20 个参数。

有关 Amazon RDS 数据库引擎的数据库参数和数据库参数组的更多信息,请参阅 Amazon RDS 用户指南 中的使用数据库参数组

有关 Amazon Aurora 数据库引擎的数据库集群和数据库实例参数以及参数组的更多信息,请参阅 Amazon Aurora 用户指南 中的使用数据库参数组和数据库集群参数组

注意

AWS CloudFormation 不支持为每个单独的参数指定应用方法。使用每个参数的默认应用方法。

必需:否

类型:字符串的映射

Update requires: No interruption

Tags

要分配给数据库参数组的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 数据库参数组的名称。

For more information about using the Ref function, see Ref.

示例

以下示例为 Aurora 数据库集群创建一个应用 IGNORE_SPACE SQL 模式的参数组。

JSON

{ "RDSDBParameterGroup": { "Type": "AWS::RDS::DBParameterGroup", "Properties": { "Description": "CloudFormation Sample Parameter Group", "Family": "aurora5.6", "Parameters": { "sql_mode": "IGNORE_SPACE" } } } }

YAML

--- RDSDBParameterGroup: Properties: Description: "CloudFormation Sample Parameter Group" Family: aurora5.6 Parameters: sql_mode: IGNORE_SPACE Type: "AWS::RDS::DBParameterGroup"