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 ModifyReplicationTask operation. Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Inheritance Hierarchy

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

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

Syntax

C# 
public class ModifyReplicationTaskRequest : AmazonDatabaseMigrationServiceRequest
         IAmazonWebServiceRequest

The ModifyReplicationTaskRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyReplicationTaskRequest()

Properties

NameTypeDescription
Public Property CdcStartPosition System.String

Gets and sets the property CdcStartPosition.

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

Public Property CdcStartTime System.DateTime

Gets and sets the property CdcStartTime.

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

Public Property CdcStopPosition System.String

Gets and sets the property CdcStopPosition.

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

Public Property MigrationType Amazon.DatabaseMigrationService.MigrationTypeValue

Gets and sets the property MigrationType.

The migration type. Valid values: full-load | cdc | full-load-and-cdc
Public Property ReplicationTaskArn System.String

Gets and sets the property ReplicationTaskArn.

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

Public Property ReplicationTaskIdentifier System.String

Gets and sets the property ReplicationTaskIdentifier.

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

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

Public Property ReplicationTaskSettings System.String

Gets and sets the property ReplicationTaskSettings.

JSON file that contains settings for the task, such as task metadata settings.

Public Property TableMappings System.String

Gets and sets the property TableMappings.

When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.

Public Property TaskData System.String

Gets and sets the property TaskData.

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

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