Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Neptune Resource Types Reference » AWS::Neptune::DBClusterParameterGroup

AWS::Neptune::DBClusterParameterGroup

The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group.

Note

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,
    "Parameters" : DBParameters,
    "Family" : String,
    "Tags" : [ Resource Tag, ... ],
    "Name" : String
  }
}

YAML

Type: "AWS::Neptune::DBClusterParameterGroup"
Properties: 
  Description: String
  Parameters: DBParameters
  Family : String
  Tags:
    Resource Tag 
  Name : String

Properties

Description

A friendly description for this DB cluster parameter group.

Required: Yes

Type: String

Update requires: Replacement

Parameters

The parameters to set for this DB cluster parameter group.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance that is associated with the parameter group before the change can take effect.

Required: Yes

Type: A JSON object consisting of string key-value pairs, as shown in the following example: 

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

Update requires: No interruption or some interruption, depending on the parameters that you update.

Family

Must be neptune1.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags that you want to attach to this parameter group.

Required: No

Type: A list of resource tags

Update requires: Updates are not supported.

Name

A friendly name for the cluster.

Required: No

Type: String

Update requires: Replacement

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

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