modifyReplicationInstance method

Future<ModifyReplicationInstanceResponse> modifyReplicationInstance({ required String replicationInstanceArn, int? allocatedStorage, bool? allowMajorVersionUpgrade, bool? applyImmediately, bool? autoMinorVersionUpgrade, String? engineVersion, bool? multiAZ, String? preferredMaintenanceWindow, String? replicationInstanceClass, String? replicationInstanceIdentifier, List<String>? vpcSecurityGroupIds, })

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

May throw AccessDeniedFault. May throw InvalidResourceStateFault. May throw ResourceAlreadyExistsFault. May throw ResourceNotFoundFault. May throw InsufficientResourceCapacityFault. May throw StorageQuotaExceededFault. May throw UpgradeDependencyFailureFault.

Parameter replicationInstanceArn : The Amazon Resource Name (ARN) of the replication instance.

Parameter allocatedStorage : The amount of storage (in gigabytes) to be allocated for the replication instance.

Parameter allowMajorVersionUpgrade : Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

Parameter applyImmediately : Indicates whether the changes should be applied immediately or during the next maintenance window.

Parameter autoMinorVersionUpgrade : A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.

An outage does result if these factors apply:

• This parameter is set to true during the maintenance window.
• A newer minor version is available.
• AWS DMS has enabled automatic patching for the given engine version.

Parameter engineVersion : The engine version number of the replication instance.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

Parameter multiAZ : Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

Parameter preferredMaintenanceWindow : The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Parameter replicationInstanceClass : The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

Parameter replicationInstanceIdentifier : The replication instance identifier. This parameter is stored as a lowercase string.

Parameter vpcSecurityGroupIds : Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

Implementation

Future<ModifyReplicationInstanceResponse> modifyReplicationInstance({
  required String replicationInstanceArn,
  int? allocatedStorage,
  bool? allowMajorVersionUpgrade,
  bool? applyImmediately,
  bool? autoMinorVersionUpgrade,
  String? engineVersion,
  bool? multiAZ,
  String? preferredMaintenanceWindow,
  String? replicationInstanceClass,
  String? replicationInstanceIdentifier,
  List<String>? vpcSecurityGroupIds,
}) async {
  ArgumentError.checkNotNull(
      replicationInstanceArn, 'replicationInstanceArn');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.ModifyReplicationInstance'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ReplicationInstanceArn': replicationInstanceArn,
      if (allocatedStorage != null) 'AllocatedStorage': allocatedStorage,
      if (allowMajorVersionUpgrade != null)
        'AllowMajorVersionUpgrade': allowMajorVersionUpgrade,
      if (applyImmediately != null) 'ApplyImmediately': applyImmediately,
      if (autoMinorVersionUpgrade != null)
        'AutoMinorVersionUpgrade': autoMinorVersionUpgrade,
      if (engineVersion != null) 'EngineVersion': engineVersion,
      if (multiAZ != null) 'MultiAZ': multiAZ,
      if (preferredMaintenanceWindow != null)
        'PreferredMaintenanceWindow': preferredMaintenanceWindow,
      if (replicationInstanceClass != null)
        'ReplicationInstanceClass': replicationInstanceClass,
      if (replicationInstanceIdentifier != null)
        'ReplicationInstanceIdentifier': replicationInstanceIdentifier,
      if (vpcSecurityGroupIds != null)
        'VpcSecurityGroupIds': vpcSecurityGroupIds,
    },
  );

  return ModifyReplicationInstanceResponse.fromJson(jsonResponse.body);
}