Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6
cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group , modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
create-db-cluster-parameter-group
--db-cluster-parameter-group-name <value>
--db-parameter-group-family <value>
--description <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-cluster-parameter-group-name
(string)
The name of the cluster parameter group.
Constraints:
Must not match the name of an existing
DBClusterParameterGroup
.Note
This value is stored as a lowercase string.
--db-parameter-group-family
(string)
The cluster parameter group family name.
--description
(string)
The description for the cluster parameter group.
--tags
(list)
The tags to be assigned to the cluster parameter group.
(structure)
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key -> (string)
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “
aws:
” or “rds:
“. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).Value -> (string)
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “
aws:
” or “rds:
“. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To create an Amazon DocumentDB cluster parameter group
The following create-db-cluster-parameter-group
example creates the DB cluster parameter group sample-parameter-group
using the docdb3.6
family.
aws docdb create-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--db-parameter-group-family docdb3.6 \
--description "Sample parameter group based on docdb3.6"
Output:
{
"DBClusterParameterGroup": {
"Description": "Sample parameter group based on docdb3.6",
"DBParameterGroupFamily": "docdb3.6",
"DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group",
"DBClusterParameterGroupName": "sample-parameter-group"
}
}
For more information, see Creating an Amazon DocumentDB Cluster Parameter Group in the Amazon DocumentDB Developer Guide.
DBClusterParameterGroup -> (structure)
Detailed information about a cluster parameter group.
DBClusterParameterGroupName -> (string)
Provides the name of the cluster parameter group.
DBParameterGroupFamily -> (string)
Provides the name of the parameter group family that this cluster parameter group is compatible with.
Description -> (string)
Provides the customer-specified description for this cluster parameter group.
DBClusterParameterGroupArn -> (string)
The Amazon Resource Name (ARN) for the cluster parameter group.