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::DBParameterGroup

AWS::Neptune::DBParameterGroup

Creates a custom parameter group for DB instances.

This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance.

Note

Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


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

YAML

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

Properties

Description

A friendly description of the DB parameter group. For example, "My Parameter Group".

Required: Yes

Type: String

Update requires: Updates are not supported.

Parameters

The parameters to set for this DB parameter group.

Required: No

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. Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.

Family

Must be neptune1.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags that you want to attach to the DB parameter group.

Required: No

Type: A list of resource tags.

Update requires: No interruption

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 example: 

{ "Ref": "MyDBParameterGroup" }

For the RDS::DBParameterGroup with the logical ID "MyDBParameterGroup," Ref returns the resource name.

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