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

AWS::DocDB::DBClusterParameterGroup

AWS::DocDB::DBClusterParameterGroup Amazon DocumentDB(与 MongoDB 兼容)资源描述 DBClusterParameterGroup。有关更多信息,请参阅 Amazon DocumentDB 开发人员指南 中的 DBClusterParameterGroup

集群参数组中的参数应用到集群中的所有实例。

最初创建集群参数组时,使用的是集群中实例所用数据库引擎的默认参数。要为任何参数提供自定义值,您必须在创建该组后对其进行修改。创建数据库集群参数组后,您需要将该组与集群关联。要使新数据库集群参数组和关联设置生效,您必须重新启动集群中的数据库实例,而不进行故障转移。

重要

创建集群参数组之后,您应至少等待 5 分钟,再创建使用该集群参数组作为默认参数组的第一个集群。这样,在将集群参数组用作新集群的默认设置之前,Amazon DocumentDB 可以完成整个创建操作。此步骤对于在为集群创建默认数据库时十分关键的参数(例如,由 character_set_database 参数定义的默认数据库字符集)非常重要。

语法

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

JSON

{ "Type" : "AWS::DocDB::DBClusterParameterGroup", "Properties" : { "Description" : String, "Family" : String, "Name" : String, "Parameters" : Json, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::DocDB::DBClusterParameterGroup Properties: Description: String Family: String Name: String Parameters: Json Tags: - Tag

属性

Description

集群参数组的描述。

必需:是

类型:字符串

Update requires: Replacement

Family

集群参数组系列名称。

必需:是

类型:字符串

Update requires: Replacement

Name

数据库集群参数组的名称。

约束:

  • 不能与现有 DBClusterParameterGroup 的名称匹配。

注意

该值以一个小写字符串存储。

必需:否

类型:字符串

Update requires: Replacement

Parameters

提供集群参数组的参数列表。

必需:是

类型:Json

Update requires: No interruption

Tags

要分配给集群参数组的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 DBClusterParameterGroup 的名称,例如 sample-db-cluster-param-group

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

示例

JSON

{ "Type" : "AWS::DocDB::DBClusterParameterGroup", "Properties" : { "Description" : "description", "Family" : "docdb3.6", "Name" : "sampleParameterGroup", "Parameters" : [ "audit_logs": "disabled", "tls": "enabled", "ttl_monitor": "enabled" ], "Tags" : [{ "Key": "String","Value": "String" }] } }

YAML

Type: "AWS::DocDB::DBClusterParameterGroup" Properties: Description: "description" Family: "docdb3.6" Name: "sampleParameterGroup" Parameters: audit_logs: "disabled" tls: "enabled" ttl_monitor: "enabled" Tags: - Key: "String" Value: "String"

另请参阅