CreateDBClusterParameterGroup
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
Important
After you create a DB cluster parameter group, you should wait at least
5 minutes before creating your first DB cluster that uses that DB cluster
parameter group as the default parameter group. This allows Amazon Neptune
to fully complete the create action before the DB cluster parameter group
is used as the default for a new DB cluster. This is especially important for
parameters that are critical when creating the default database for a DB
cluster, such as the character set for the default database defined by the
character_set_database parameter. You can use the Parameter
Groups option of the Amazon Neptune
console
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group.
Constraints:
-
Must match the name of an existing DBClusterParameterGroup.
Note
This value is stored as a lowercase string.
Type: String
Required: Yes
-
- DBParameterGroupFamily
-
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Type: String
Required: Yes
- Description
-
The description for the DB cluster parameter group.
Type: String
Required: Yes
- Tags.Tag.N
-
The tags to be assigned to the new DB cluster parameter group.
Type: Array of Tag objects
Required: No
Response Elements
The following element is returned by the service.
- DBClusterParameterGroup
-
Contains the details of an Amazon Neptune DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
Type: DBClusterParameterGroup object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBParameterGroupAlreadyExists
-
A DB parameter group with the same name exists.
HTTP Status Code: 400
- DBParameterGroupQuotaExceeded
-
Request would result in user exceeding the allowed number of DB parameter groups.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
