AWS::Neptune::DBClusterParameterGroup
The AWS::Neptune::DBClusterParameterGroup
resource creates a new Amazon Neptune DB cluster parameter group.
Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Neptune::DBClusterParameterGroup", "Properties" : { "Description" :
String
, "Family" :String
, "Name" :String
, "Parameters" :Json
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::Neptune::DBClusterParameterGroup Properties: Description:
String
Family:String
Name:String
Parameters:Json
Tags:- Tag
Properties
Description
-
Provides the customer-specified description for this DB cluster parameter group.
Required: Yes
Type: String
Update requires: Replacement
Family
-
Must be
neptune1
for engine versions prior to 1.2.0.0, orneptune1.2
for engine version1.2.0.0
and higher.Required: Yes
Type: String
Update requires: Replacement
Name
-
Provides the name of the DB cluster parameter group.
Required: No
Type: String
Update requires: Replacement
Parameters
-
The parameters to set for this DB cluster parameter group.
The parameters are expressed as a JSON object consisting of key-value pairs.
If you update the parameters, some interruption may occur depending on which parameters you update.
Required: Yes
Type: Json
Update requires: No interruption
Tags
-
The tags that you want to attach to this parameter group.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name.
For more information about using the Ref
function, see Ref.