Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1469325456.8 KB

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.

post/#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationInstance

Headers

X-Amz-Target'AmazonDMSv20160101.ModifyReplicationInstance' required

Request body

ReplicationInstanceArnstring required

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

AllocatedStorageinteger

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

ApplyImmediatelyboolean

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

ReplicationInstanceClassstring
<p>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 <code>"dms.c4.large"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </p>
VpcSecurityGroupIdsString[]

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.

PreferredMaintenanceWindowstring
<p>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.</p> <p>Default: Uses existing setting</p> <p>Format: ddd:hh24:mi-ddd:hh24:mi</p> <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p> <p>Constraints: Must be at least 30 minutes</p>
MultiAZboolean

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>.

EngineVersionstring
<p>The engine version number of the replication instance.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>
AllowMajorVersionUpgradeboolean
<p>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.</p> <p>This parameter must be set to <code>true</code> when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the replication instance's current version.</p>
AutoMinorVersionUpgradeboolean
<p>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. </p> <p>An outage does result if these factors apply: </p> <ul> <li> <p>This parameter is set to <code>true</code> during the maintenance window.</p> </li> <li> <p>A newer minor version is available. </p> </li> <li> <p>DMS has enabled automatic patching for the given engine version. </p> </li> </ul> <p>When <code>AutoMinorVersionUpgrade</code> is enabled, DMS uses the current default engine version when you modify a replication instance. For example, if you set <code>EngineVersion</code> to a lower version number than the current default version, DMS uses the default version.</p> <p>If <code>AutoMinorVersionUpgrade</code> <i>isn’t</i> enabled when you modify a replication instance, DMS uses the engine version specified by the <code>EngineVersion</code> parameter.</p>
ReplicationInstanceIdentifierstring

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

NetworkTypestring

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

Response

Success

Example response

{
  "ReplicationInstance": {
    "AllocatedStorage": 5,
    "AutoMinorVersionUpgrade": true,
    "EngineVersion": "1.5.0",
    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
    "PendingModifiedValues": {},
    "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
    "PubliclyAccessible": true,
    "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
    "ReplicationInstanceClass": "dms.t2.micro",
    "ReplicationInstanceIdentifier": "test-rep-1",
    "ReplicationInstanceStatus": "available",
    "ReplicationSubnetGroup": {
      "ReplicationSubnetGroupDescription": "default",
      "ReplicationSubnetGroupIdentifier": "default",
      "SubnetGroupStatus": "Complete",
      "Subnets": [
        {
          "SubnetAvailabilityZone": {
            "Name": "us-east-1d"
          },
          "SubnetIdentifier": "subnet-f6dd91af",
          "SubnetStatus": "Active"
        },
        {
          "SubnetAvailabilityZone": {
            "Name": "us-east-1b"
          },
          "SubnetIdentifier": "subnet-3605751d",
          "SubnetStatus": "Active"
        },
        {
          "SubnetAvailabilityZone": {
            "Name": "us-east-1c"
          },
          "SubnetIdentifier": "subnet-c2daefb5",
          "SubnetStatus": "Active"
        },
        {
          "SubnetAvailabilityZone": {
            "Name": "us-east-1e"
          },
          "SubnetIdentifier": "subnet-85e90cb8",
          "SubnetStatus": "Active"
        }
      ],
      "VpcId": "vpc-6741a603"
    }
  }
}