modifyDBCluster method

Future<ModifyDBClusterResult> modifyDBCluster({ required String dBClusterIdentifier, bool? applyImmediately, int? backupRetentionPeriod, CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration, String? dBClusterParameterGroupName, bool? deletionProtection, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? masterUserPassword, String? newDBClusterIdentifier, String? optionGroupName, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String>? vpcSecurityGroupIds, })

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

May throw DBClusterNotFoundFault. May throw InvalidDBClusterStateFault. May throw StorageQuotaExceededFault. May throw DBSubnetGroupNotFoundFault. May throw InvalidVPCNetworkStateFault. May throw InvalidDBSubnetGroupStateFault. May throw InvalidSubnet. May throw DBClusterParameterGroupNotFoundFault. May throw InvalidDBSecurityGroupStateFault. May throw InvalidDBInstanceStateFault. May throw DBClusterAlreadyExistsFault.

Parameter dBClusterIdentifier : The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Parameter applyImmediately : A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Parameter backupRetentionPeriod : The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

Parameter cloudwatchLogsExportConfiguration : The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

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

Parameter deletionProtection : A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Parameter enableIAMDatabaseAuthentication : True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameter engineVersion : The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

Parameter masterUserPassword : The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Parameter newDBClusterIdentifier : The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens
• The first character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Parameter optionGroupName : (Not supported by Neptune)

Parameter port : The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Parameter preferredBackupWindow : The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

Parameter preferredMaintenanceWindow : The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Parameter vpcSecurityGroupIds : A list of VPC security groups that the DB cluster will belong to.

Implementation

Future<ModifyDBClusterResult> modifyDBCluster({
  required String dBClusterIdentifier,
  bool? applyImmediately,
  int? backupRetentionPeriod,
  CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration,
  String? dBClusterParameterGroupName,
  bool? deletionProtection,
  bool? enableIAMDatabaseAuthentication,
  String? engineVersion,
  String? masterUserPassword,
  String? newDBClusterIdentifier,
  String? optionGroupName,
  int? port,
  String? preferredBackupWindow,
  String? preferredMaintenanceWindow,
  List<String>? vpcSecurityGroupIds,
}) async {
  ArgumentError.checkNotNull(dBClusterIdentifier, 'dBClusterIdentifier');
  final $request = <String, dynamic>{};
  $request['DBClusterIdentifier'] = dBClusterIdentifier;
  applyImmediately?.also((arg) => $request['ApplyImmediately'] = arg);
  backupRetentionPeriod
      ?.also((arg) => $request['BackupRetentionPeriod'] = arg);
  cloudwatchLogsExportConfiguration
      ?.also((arg) => $request['CloudwatchLogsExportConfiguration'] = arg);
  dBClusterParameterGroupName
      ?.also((arg) => $request['DBClusterParameterGroupName'] = arg);
  deletionProtection?.also((arg) => $request['DeletionProtection'] = arg);
  enableIAMDatabaseAuthentication
      ?.also((arg) => $request['EnableIAMDatabaseAuthentication'] = arg);
  engineVersion?.also((arg) => $request['EngineVersion'] = arg);
  masterUserPassword?.also((arg) => $request['MasterUserPassword'] = arg);
  newDBClusterIdentifier
      ?.also((arg) => $request['NewDBClusterIdentifier'] = arg);
  optionGroupName?.also((arg) => $request['OptionGroupName'] = arg);
  port?.also((arg) => $request['Port'] = arg);
  preferredBackupWindow
      ?.also((arg) => $request['PreferredBackupWindow'] = arg);
  preferredMaintenanceWindow
      ?.also((arg) => $request['PreferredMaintenanceWindow'] = arg);
  vpcSecurityGroupIds?.also((arg) => $request['VpcSecurityGroupIds'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ModifyDBCluster',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ModifyDBClusterMessage'],
    shapes: shapes,
    resultWrapper: 'ModifyDBClusterResult',
  );
  return ModifyDBClusterResult.fromXml($result);
}