createDBClusterParameterGroup method

Future<CreateDBClusterParameterGroupResult> createDBClusterParameterGroup({
  1. required String dBClusterParameterGroupName,
  2. required String dBParameterGroupFamily,
  3. required String description,
  4. List<Tag>? tags,
})

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. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

May throw DBParameterGroupQuotaExceededFault. May throw DBParameterGroupAlreadyExistsFault.

Parameter dBClusterParameterGroupName : The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DB cluster parameter group.

Parameter 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.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

Parameter description : The description for the DB cluster parameter group.

Parameter tags : Tags to assign to the DB cluster parameter group.

Implementation

Future<CreateDBClusterParameterGroupResult> createDBClusterParameterGroup({
  required String dBClusterParameterGroupName,
  required String dBParameterGroupFamily,
  required String description,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(
      dBClusterParameterGroupName, 'dBClusterParameterGroupName');
  ArgumentError.checkNotNull(
      dBParameterGroupFamily, 'dBParameterGroupFamily');
  ArgumentError.checkNotNull(description, 'description');
  final $request = <String, dynamic>{};
  $request['DBClusterParameterGroupName'] = dBClusterParameterGroupName;
  $request['DBParameterGroupFamily'] = dBParameterGroupFamily;
  $request['Description'] = description;
  tags?.also((arg) => $request['Tags'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateDBClusterParameterGroup',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateDBClusterParameterGroupMessage'],
    shapes: shapes,
    resultWrapper: 'CreateDBClusterParameterGroupResult',
  );
  return CreateDBClusterParameterGroupResult.fromXml($result);
}