AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::DocDB::DBClusterParameterGroup

The AWS::DocDB::DBClusterParameterGroup Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see DBClusterParameterGroup in the Amazon DocumentDB Developer Guide.

Syntax

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

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

Properties

Description

Provides the customer-specified description for this DB cluster parameter group.

Required: Yes

Type: String

Update requires: Replacement

Family

The DB cluster parameter group from which user created DB cluster parameter groups are created. For example, default.docdb3.6.

Required: Yes

Type: String

Update requires: Replacement

Name

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

Required: No

Type: String

Update requires: Replacement

Parameters

Provides the name of the DB cluster parameter group.

Required: Yes

Type: Json

Update requires: No interruption

Tags

A list of up to 50 tags. A tag is metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

Required: No

Type: List of Resource Tag property types

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::DocDB::DBClusterParameterGroup resource to the intrinsic Ref function, the function returns the DBClusterParameterGroup's name, such as sample-db-cluster-param-group.

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

Example

JSON

{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myDBInstance" : { "Type" : "AWS::DocDB::DBClusterParameterGroup", "Properties" : { "Description" : "description", "Family" : "docdb3.6", "Name" : "modified-docdb3.6", "Parameters" : [ {"Name" : "String", "Value" : "String"} ], "Tags" : [ {"Key" : "String", "Value" : "String"} ] } } } }

YAML

AWSTemplateFormatVersion: "2010-09-09" Resources: myDBInstance: Type: "AWS::DocDB::DBClusterParameterGroup" Properties: Description : "description" Family : "docdb3.6" Name : "modified-docdb3.6" Parameters : - Name : "String" Value : "String" Tags: - Key: "String" Value: "String"

See Also

For more information, see the following topics in the Amazon DocumentDB Developers Guide.