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

AWS::Neptune::DBParameterGroup

AWS::Neptune::DBParameterGroup 创建一个新的数据库参数组。可以在模板中声明该类型,以及在 AWS::Neptune::DBInstanceDBParameterGroupName 参数中引用该类型。

注意

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

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

重要

创建数据库参数组之后,您应至少等待 5 分钟,再创建使用该数据库参数组作为默认参数组的第一个数据库实例。这样,在将参数组用作新数据库实例的默认设置之前,Amazon Neptune 可以完成全部创建操作。这对于在为数据库实例创建默认数据库时十分关键的参数 (例如,由 character_set_database 参数定义的默认数据库字符集) 非常重要。您可以使用 Amazon Neptune 控制台的 Parameter Groups (参数组) 选项或使用 DescribeDBParameters 命令来验证是否已创建或修改数据库参数组。

语法

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

JSON

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

YAML

Type: AWS::Neptune::DBParameterGroup Properties: Description: String Family: String Name: String Parameters: Json Tags: - Tag

属性

Description

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

必需:是

类型:字符串

Update requires: Replacement

Family

必须是 neptune1

必需:是

类型:字符串

Update requires: Replacement

Name

提供数据库参数组的名称。

必需:否

类型:字符串

Update requires: Replacement

Parameters

要为此数据库参数组设置的参数。

参数表示为由键/值对组成的 JSON 对象。

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

必需:是

类型:Json

Update requires: No interruption

Tags

要附加到此参数组的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

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

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