Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1469325456.8 KB

Creates the replication instance using the specified parameters.

DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.

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

Headers

X-Amz-Target'AmazonDMSv20160101.CreateReplicationInstance' required

Request body

ReplicationInstanceIdentifierstring required
<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>
AllocatedStorageinteger

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

ReplicationInstanceClassstring required
<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.

AvailabilityZonestring

The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: <code>us-east-1d</code>

ReplicationSubnetGroupIdentifierstring

A subnet group to associate with the replication instance.

PreferredMaintenanceWindowstring
<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</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>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p>
AutoMinorVersionUpgradeboolean
<p>A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to <code>true</code>.</p> <p>Default: <code>true</code> </p> <p>When <code>AutoMinorVersionUpgrade</code> is enabled, DMS uses the current default engine version when you create 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 create a replication instance, DMS uses the engine version specified by the <code>EngineVersion</code> parameter. </p>
KmsKeyIdstring
<p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>
PubliclyAccessibleboolean

Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>.

DnsNameServersstring

A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: <code>"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"</code>

ResourceIdentifierstring

A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.

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": "creating",
    "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"
    }
  }
}