ReplicationInstance - AWS Database Migration Service
ContentsSee Also

ReplicationInstance

Provides information that defines a replication instance.

Contents

AllocatedStorage

The amount of storage (in gigabytes) that is allocated for the replication instance.

Type: Integer

Required: No

AutoMinorVersionUpgrade

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

Type: Boolean

Required: No

AvailabilityZone

The Availability Zone for the instance.

Type: String

Required: No

DnsNameServers

The DNS name servers supported for the replication instance to access your on-premise source or target database.

Type: String

Required: No

EngineVersion

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.

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

Type: String

Required: No

FreeUntil

The expiration date of the free replication instance that is part of the Free DMS program.

Type: Timestamp

Required: No

InstanceCreateTime

The time the replication instance was created.

Type: Timestamp

Required: No

KerberosAuthenticationSettings

Specifies the settings required for kerberos authentication when replicating an instance.

Type: KerberosAuthenticationSettings object

Required: No

KmsKeyId

An AWS 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 AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Type: String

Required: No

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.

Type: Boolean

Required: No

NetworkType

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.

Type: String

Required: No

PendingModifiedValues

The pending modification values.

Type: ReplicationPendingModifiedValues object

Required: No

PreferredMaintenanceWindow

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

Type: String

Required: No

PubliclyAccessible

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.

Type: Boolean

Required: No

ReplicationInstanceArn

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

Type: String

Required: No

ReplicationInstanceClass

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

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.

Type: String

Length Constraints: Maximum length of 30.

Required: No

ReplicationInstanceIdentifier

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

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

Type: String

Required: No

ReplicationInstanceIpv6Addresses

One or more IPv6 addresses for the replication instance.

Type: Array of strings

Required: No

ReplicationInstancePrivateIpAddress

This member has been deprecated.

The private IP address of the replication instance.

Type: String

Required: No

ReplicationInstancePrivateIpAddresses

One or more private IP addresses for the replication instance.

Type: Array of strings

Required: No

ReplicationInstancePublicIpAddress

This member has been deprecated.

The public IP address of the replication instance.

Type: String

Required: No

ReplicationInstancePublicIpAddresses

One or more public IP addresses for the replication instance.

Type: Array of strings

Required: No

ReplicationInstanceStatus

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance"

Type: String

Required: No

ReplicationSubnetGroup

The subnet group for the replication instance.

Type: ReplicationSubnetGroup object

Required: No

SecondaryAvailabilityZone

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

Type: String

Required: No

VpcSecurityGroups

The VPC security group for the instance.

Type: Array of VpcSecurityGroupMembership objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: