Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dms
  6. ReplicationTask

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.dms.ReplicationTask

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DMS::ReplicationTask

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myReplicationTask = new AwsNative.Dms.ReplicationTask("myReplicationTask", new()
    {
        SourceEndpointArn = "11",
        TargetEndpointArn = "12ff",
        ReplicationInstanceArn = "ert1",
        MigrationType = AwsNative.Dms.ReplicationTaskMigrationType.FullLoad,
        TableMappings = "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/dms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.NewReplicationTask(ctx, "myReplicationTask", &dms.ReplicationTaskArgs{
			SourceEndpointArn:      pulumi.String("11"),
			TargetEndpointArn:      pulumi.String("12ff"),
			ReplicationInstanceArn: pulumi.String("ert1"),
			MigrationType:          dms.ReplicationTaskMigrationTypeFullLoad,
			TableMappings:          pulumi.String("{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myReplicationTask = new aws_native.dms.ReplicationTask("myReplicationTask", {
    sourceEndpointArn: "11",
    targetEndpointArn: "12ff",
    replicationInstanceArn: "ert1",
    migrationType: aws_native.dms.ReplicationTaskMigrationType.FullLoad,
    tableMappings: "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }",
});

    import pulumi
import pulumi_aws_native as aws_native

my_replication_task = aws_native.dms.ReplicationTask("myReplicationTask",
    source_endpoint_arn="11",
    target_endpoint_arn="12ff",
    replication_instance_arn="ert1",
    migration_type=aws_native.dms.ReplicationTaskMigrationType.FULL_LOAD,
    table_mappings="{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }")

    Example coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myReplicationTask = new AwsNative.Dms.ReplicationTask("myReplicationTask", new()
    {
        MigrationType = AwsNative.Dms.ReplicationTaskMigrationType.FullLoad,
        ReplicationInstanceArn = "ReplicationInstance",
        SourceEndpointArn = "SourceEndpoint",
        TableMappings = "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }",
        TargetEndpointArn = "TargetEndpoint",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/dms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.NewReplicationTask(ctx, "myReplicationTask", &dms.ReplicationTaskArgs{
			MigrationType:          dms.ReplicationTaskMigrationTypeFullLoad,
			ReplicationInstanceArn: pulumi.String("ReplicationInstance"),
			SourceEndpointArn:      pulumi.String("SourceEndpoint"),
			TableMappings:          pulumi.String("{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }"),
			TargetEndpointArn:      pulumi.String("TargetEndpoint"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myReplicationTask = new aws_native.dms.ReplicationTask("myReplicationTask", {
    migrationType: aws_native.dms.ReplicationTaskMigrationType.FullLoad,
    replicationInstanceArn: "ReplicationInstance",
    sourceEndpointArn: "SourceEndpoint",
    tableMappings: "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }",
    targetEndpointArn: "TargetEndpoint",
});

    import pulumi
import pulumi_aws_native as aws_native

my_replication_task = aws_native.dms.ReplicationTask("myReplicationTask",
    migration_type=aws_native.dms.ReplicationTaskMigrationType.FULL_LOAD,
    replication_instance_arn="ReplicationInstance",
    source_endpoint_arn="SourceEndpoint",
    table_mappings="{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"%\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }",
    target_endpoint_arn="TargetEndpoint")

    Example coming soon!

    Create ReplicationTask Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReplicationTask(name: string, args: ReplicationTaskArgs, opts?: CustomResourceOptions);
    @overload
def ReplicationTask(resource_name: str,
                    args: ReplicationTaskArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ReplicationTask(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    table_mappings: Optional[str] = None,
                    migration_type: Optional[ReplicationTaskMigrationType] = None,
                    replication_instance_arn: Optional[str] = None,
                    source_endpoint_arn: Optional[str] = None,
                    target_endpoint_arn: Optional[str] = None,
                    cdc_start_time: Optional[float] = None,
                    cdc_stop_position: Optional[str] = None,
                    replication_task_identifier: Optional[str] = None,
                    replication_task_settings: Optional[str] = None,
                    resource_identifier: Optional[str] = None,
                    cdc_start_position: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                    task_data: Optional[str] = None)
    func NewReplicationTask(ctx *Context, name string, args ReplicationTaskArgs, opts ...ResourceOption) (*ReplicationTask, error)
    public ReplicationTask(string name, ReplicationTaskArgs args, CustomResourceOptions? opts = null)
    public ReplicationTask(String name, ReplicationTaskArgs args)
public ReplicationTask(String name, ReplicationTaskArgs args, CustomResourceOptions options)

    type: aws-native:dms:ReplicationTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_dms_replication_task" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ReplicationTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReplicationTaskArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReplicationTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationTaskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ReplicationTask Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReplicationTask resource accepts the following input properties:

    MigrationType Pulumi.AwsNative.Dms.ReplicationTaskMigrationType
    The migration type.
    ReplicationInstanceArn string
    The Amazon Resource Name (ARN) of a replication instance.
    SourceEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    TableMappings string
    The table mappings for the task, in JSON format.
    TargetEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    CdcStartPosition string
    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.
    CdcStartTime double
    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.
    CdcStopPosition string
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    ReplicationTaskIdentifier string
    An identifier for the replication task.
    ReplicationTaskSettings string
    Overall settings for the task, in JSON format
    ResourceIdentifier string
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags to be assigned to the replication task.
    TaskData string
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    MigrationType ReplicationTaskMigrationType
    The migration type.
    ReplicationInstanceArn string
    The Amazon Resource Name (ARN) of a replication instance.
    SourceEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    TableMappings string
    The table mappings for the task, in JSON format.
    TargetEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    CdcStartPosition string
    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.
    CdcStartTime float64
    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.
    CdcStopPosition string
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    ReplicationTaskIdentifier string
    An identifier for the replication task.
    ReplicationTaskSettings string
    Overall settings for the task, in JSON format
    ResourceIdentifier string
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    Tags TagArgs
    One or more tags to be assigned to the replication task.
    TaskData string
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    migration_type "full-load" | "cdc" | "full-load-and-cdc"
    The migration type.
    replication_instance_arn string
    The Amazon Resource Name (ARN) of a replication instance.
    source_endpoint_arn string
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    table_mappings string
    The table mappings for the task, in JSON format.
    target_endpoint_arn string
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    cdc_start_position string
    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.
    cdc_start_time number
    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.
    cdc_stop_position string
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    replication_task_identifier string
    An identifier for the replication task.
    replication_task_settings string
    Overall settings for the task, in JSON format
    resource_identifier string
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    tags list(object)
    One or more tags to be assigned to the replication task.
    task_data string
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    migrationType ReplicationTaskMigrationType
    The migration type.
    replicationInstanceArn String
    The Amazon Resource Name (ARN) of a replication instance.
    sourceEndpointArn String
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    tableMappings String
    The table mappings for the task, in JSON format.
    targetEndpointArn String
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    cdcStartPosition String
    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.
    cdcStartTime Double
    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.
    cdcStopPosition String
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    replicationTaskIdentifier String
    An identifier for the replication task.
    replicationTaskSettings String
    Overall settings for the task, in JSON format
    resourceIdentifier String
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    tags List<Tag>
    One or more tags to be assigned to the replication task.
    taskData String
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    migrationType ReplicationTaskMigrationType
    The migration type.
    replicationInstanceArn string
    The Amazon Resource Name (ARN) of a replication instance.
    sourceEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    tableMappings string
    The table mappings for the task, in JSON format.
    targetEndpointArn string
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    cdcStartPosition string
    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.
    cdcStartTime number
    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.
    cdcStopPosition string
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    replicationTaskIdentifier string
    An identifier for the replication task.
    replicationTaskSettings string
    Overall settings for the task, in JSON format
    resourceIdentifier string
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    tags Tag[]
    One or more tags to be assigned to the replication task.
    taskData string
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    migration_type ReplicationTaskMigrationType
    The migration type.
    replication_instance_arn str
    The Amazon Resource Name (ARN) of a replication instance.
    source_endpoint_arn str
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    table_mappings str
    The table mappings for the task, in JSON format.
    target_endpoint_arn str
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    cdc_start_position str
    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.
    cdc_start_time float
    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.
    cdc_stop_position str
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    replication_task_identifier str
    An identifier for the replication task.
    replication_task_settings str
    Overall settings for the task, in JSON format
    resource_identifier str
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    tags Sequence[TagArgs]
    One or more tags to be assigned to the replication task.
    task_data str
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.
    migrationType "full-load" | "cdc" | "full-load-and-cdc"
    The migration type.
    replicationInstanceArn String
    The Amazon Resource Name (ARN) of a replication instance.
    sourceEndpointArn String
    An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
    tableMappings String
    The table mappings for the task, in JSON format.
    targetEndpointArn String
    An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
    cdcStartPosition String
    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.
    cdcStartTime Number
    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.
    cdcStopPosition String
    Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
    replicationTaskIdentifier String
    An identifier for the replication task.
    replicationTaskSettings String
    Overall settings for the task, in JSON format
    resourceIdentifier String
    A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
    tags List<Property Map>
    One or more tags to be assigned to the replication task.
    taskData String
    Supplemental information that the task requires to migrate the data for certain source and target endpoints.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReplicationTask resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ReplicationTaskArn string
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    ReplicationTaskArn string
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    replication_task_arn string
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn String
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn string
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    replication_task_arn str
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn String
    The ARN of the ReplicationTask. Also serves the purpise of Primary Identifier.

    Supporting Types

    ReplicationTaskMigrationType, ReplicationTaskMigrationTypeArgs

    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    ReplicationTaskMigrationTypeFullLoad
    full-load
    ReplicationTaskMigrationTypeCdc
    cdc
    ReplicationTaskMigrationTypeFullLoadAndCdc
    full-load-and-cdc
    "full-load"
    full-load
    "cdc"
    cdc
    "full-load-and-cdc"
    full-load-and-cdc
    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    FullLoad
    full-load
    Cdc
    cdc
    FullLoadAndCdc
    full-load-and-cdc
    FULL_LOAD
    full-load
    CDC
    cdc
    FULL_LOAD_AND_CDC
    full-load-and-cdc
    "full-load"
    full-load
    "cdc"
    cdc
    "full-load-and-cdc"
    full-load-and-cdc

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.80.0
    published on Monday, Sep 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial