modifyGlobalCluster method

Future<ModifyGlobalClusterResult> modifyGlobalCluster({ bool? deletionProtection, String? globalClusterIdentifier, String? newGlobalClusterIdentifier, })

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

May throw GlobalClusterNotFoundFault. May throw InvalidGlobalClusterStateFault.

Parameter deletionProtection : Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

Parameter globalClusterIdentifier : The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

• Must match the identifier of an existing global database cluster.

Parameter newGlobalClusterIdentifier : The new cluster identifier for the global database cluster when modifying a global database 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
• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Implementation

Future<ModifyGlobalClusterResult> modifyGlobalCluster({
  bool? deletionProtection,
  String? globalClusterIdentifier,
  String? newGlobalClusterIdentifier,
}) async {
  final $request = <String, dynamic>{};
  deletionProtection?.also((arg) => $request['DeletionProtection'] = arg);
  globalClusterIdentifier
      ?.also((arg) => $request['GlobalClusterIdentifier'] = arg);
  newGlobalClusterIdentifier
      ?.also((arg) => $request['NewGlobalClusterIdentifier'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ModifyGlobalCluster',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ModifyGlobalClusterMessage'],
    shapes: shapes,
    resultWrapper: 'ModifyGlobalClusterResult',
  );
  return ModifyGlobalClusterResult.fromXml($result);
}