AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateReplicationInstance operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DatabaseMigrationService.AmazonDatabaseMigrationServiceRequest
      Amazon.DatabaseMigrationService.Model.CreateReplicationInstanceRequest

Namespace: Amazon.DatabaseMigrationService.Model
Assembly: AWSSDK.DatabaseMigrationService.dll
Version: 3.x.y.z

Syntax

C#
public class CreateReplicationInstanceRequest : AmazonDatabaseMigrationServiceRequest
         IAmazonWebServiceRequest

The CreateReplicationInstanceRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

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

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

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

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

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.

Public Property DnsNameServers System.String

Gets and sets the property DnsNameServers.

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"

Public Property EngineVersion System.String

Gets and sets the property 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.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

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.

Public Property MultiAZ System.Boolean

Gets and sets the property 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.

Public Property NetworkType System.String

Gets and sets the property 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.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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.

Public Property PubliclyAccessible System.Boolean

Gets and sets the property 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.

Public Property ReplicationInstanceClass System.String

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

Public Property ReplicationInstanceIdentifier System.String

Gets and sets the property ReplicationInstanceIdentifier.

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

Public Property ReplicationSubnetGroupIdentifier System.String

Gets and sets the property ReplicationSubnetGroupIdentifier.

A subnet group to associate with the replication instance.

Public Property ResourceIdentifier System.String

Gets and sets the property ResourceIdentifier.

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.

Public Property Tags System.Collections.Generic.List<Amazon.DatabaseMigrationService.Model.Tag>

Gets and sets the property Tags.

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

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Examples

Creates the replication instance using the specified parameters.

Create replication instance


var client = new AmazonDatabaseMigrationServiceClient();
var response = client.CreateReplicationInstance(new CreateReplicationInstanceRequest 
{
    AllocatedStorage = 123,
    AutoMinorVersionUpgrade = true,
    AvailabilityZone = "",
    EngineVersion = "",
    KmsKeyId = "",
    MultiAZ = true,
    PreferredMaintenanceWindow = "",
    PubliclyAccessible = true,
    ReplicationInstanceClass = "",
    ReplicationInstanceIdentifier = "",
    ReplicationSubnetGroupIdentifier = "",
    Tags = new List<Tag> {
        new Tag {
            Key = "string",
            Value = "string"
        }
    },
    VpcSecurityGroupIds = new List<string> {
                    
    }
});

ReplicationInstance replicationInstance = response.ReplicationInstance;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5