AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::RDS::DBParameterGroup

为 RDS 数据库系列创建自定义参数组。更多有关 RDS 参数组的信息,请参阅 Amazon Relational Database Service User Guide 中的 Working with DB Parameter Groups 部分。

此类型可在模板中声明或在 AWS::RDS::DBInstanceDBParameterGroupName 参数中引用。

注意

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

语法

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

JSON

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

YAML

Type: "AWS::RDS::DBParameterGroup" Properties: Description: String Family: String Parameters: DBParameters Tags: - Resource Tag

属性

Description

对 RDS 参数组的简明描述。例如:"My Parameter Group"

Required: Yes

类型:字符串

更新要求:不支持更新。

Family

此 RDS 参数组的数据库系列。例如:"MySQL5.1"

Required: Yes

类型:字符串

更新要求:不支持更新。

Parameters

要为 RDS 参数组设置的参数。

Required: No

类型:包含字符串键/值对的 JSON 对象,如以下示例所示:

"Parameters" : { "Key1" : "Value1", "Key2" : "Value2", "Key3" : "Value3" }

更新要求无需中断时而中断。对动态参数所做的更改将立即应用。更新期间,如果您具有静态参数(无论这些参数是否发生了更改),则将触发 AWS CloudFormation 重启关联的数据库实例,而不进行故障转移。

Tags

要附加到该 RDS 参数组的标签。

Required: No

类型资源标签列表。

更新要求无需中断

返回值

Ref

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。 示例:

{ "Ref": "MyDBParameterGroup" }

对于逻辑 ID 为“MyDBParameterGroup”的 RDS::DBParameterGroup,Ref 将返回资源名称。

有关使用 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: Type: AWS::RDS::DBParameterGroup Properties: Description: CloudFormation Sample Parameter Group Family: aurora5.6 Parameters: sql_mode: IGNORE_SPACE

本页内容: