Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can click “Customize cookies” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To continue without accepting these cookies, click “Continue without accepting.” To make more detailed choices or learn more, click “Customize cookies.”

Skip to content

/AWS1/CL_DMG=>CREATEREPLICATIONINSTANCE()

About CreateReplicationInstance

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.

If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see Release Notes.

Method Signature

IMPORTING

Required arguments:

IV_REPLINSTANCEIDENTIFIER TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

IV_REPLICATIONINSTANCECLASS TYPE /AWS1/DMGREPLINSTANCECLASS /AWS1/DMGREPLINSTANCECLASS

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 Choosing the right DMS replication instance; and, Selecting the best size for a replication instance.

Optional arguments:

IV_ALLOCATEDSTORAGE TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

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

IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_DMGVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST

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.

IV_AVAILABILITYZONE TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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: us-east-1d.

IV_REPLSUBNETGROUPIDENTIFIER TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

A subnet group to associate with the replication instance.

IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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

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

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.

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

Constraints: Minimum 30-minute window.

IV_MULTIAZ TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

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.

IV_ENGINEVERSION TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to true.

Default: true

IT_TAGS TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST TT_TAGLIST

One or more tags to be assigned to the replication instance.

IV_KMSKEYID TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

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.

IV_PUBLICLYACCESSIBLE TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

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

IV_DNSNAMESERVERS TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

IV_RESOURCEIDENTIFIER TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint 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 Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

IV_NETWORKTYPE TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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.

IO_KERBEROSAUTHNTCTNSETTINGS TYPE REF TO /AWS1/CL_DMGKERBEROSAUTHNSTGS /AWS1/CL_DMGKERBEROSAUTHNSTGS

Specifies the settings required for kerberos authentication when creating the replication instance.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_DMGCREATEREPLINSTRSP /AWS1/CL_DMGCREATEREPLINSTRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC