Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. dms
  5. ReplicationTask
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.dms.ReplicationTask

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a DMS (Data Migration Service) replication task resource. DMS replication tasks can be created, updated, deleted, and imported.

    NOTE: Changing most arguments will stop the task if it is running. You can set start_replication_task to resume the task afterwards.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new replication task
const test = new aws.dms.ReplicationTask("test", {
    cdcStartTime: "1993-05-21T05:50:00Z",
    migrationType: "full-load",
    replicationInstanceArn: test_dms_replication_instance_tf.replicationInstanceArn,
    replicationTaskId: "test-dms-replication-task-tf",
    replicationTaskSettings: "...",
    sourceEndpointArn: test_dms_source_endpoint_tf.endpointArn,
    tableMappings: "{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}",
    tags: {
        Name: "test",
    },
    targetEndpointArn: test_dms_target_endpoint_tf.endpointArn,
});

    import pulumi
import pulumi_aws as aws

# Create a new replication task
test = aws.dms.ReplicationTask("test",
    cdc_start_time="1993-05-21T05:50:00Z",
    migration_type="full-load",
    replication_instance_arn=test_dms_replication_instance_tf["replicationInstanceArn"],
    replication_task_id="test-dms-replication-task-tf",
    replication_task_settings="...",
    source_endpoint_arn=test_dms_source_endpoint_tf["endpointArn"],
    table_mappings="{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}",
    tags={
        "Name": "test",
    },
    target_endpoint_arn=test_dms_target_endpoint_tf["endpointArn"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new replication task
		_, err := dms.NewReplicationTask(ctx, "test", &dms.ReplicationTaskArgs{
			CdcStartTime:            pulumi.String("1993-05-21T05:50:00Z"),
			MigrationType:           pulumi.String("full-load"),
			ReplicationInstanceArn:  pulumi.Any(test_dms_replication_instance_tf.ReplicationInstanceArn),
			ReplicationTaskId:       pulumi.String("test-dms-replication-task-tf"),
			ReplicationTaskSettings: pulumi.String("..."),
			SourceEndpointArn:       pulumi.Any(test_dms_source_endpoint_tf.EndpointArn),
			TableMappings:           pulumi.String("{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("test"),
			},
			TargetEndpointArn: pulumi.Any(test_dms_target_endpoint_tf.EndpointArn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a new replication task
    var test = new Aws.Dms.ReplicationTask("test", new()
    {
        CdcStartTime = "1993-05-21T05:50:00Z",
        MigrationType = "full-load",
        ReplicationInstanceArn = test_dms_replication_instance_tf.ReplicationInstanceArn,
        ReplicationTaskId = "test-dms-replication-task-tf",
        ReplicationTaskSettings = "...",
        SourceEndpointArn = test_dms_source_endpoint_tf.EndpointArn,
        TableMappings = "{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}",
        Tags = 
        {
            { "Name", "test" },
        },
        TargetEndpointArn = test_dms_target_endpoint_tf.EndpointArn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.ReplicationTask;
import com.pulumi.aws.dms.ReplicationTaskArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a new replication task
        var test = new ReplicationTask("test", ReplicationTaskArgs.builder()
            .cdcStartTime("1993-05-21T05:50:00Z")
            .migrationType("full-load")
            .replicationInstanceArn(test_dms_replication_instance_tf.replicationInstanceArn())
            .replicationTaskId("test-dms-replication-task-tf")
            .replicationTaskSettings("...")
            .sourceEndpointArn(test_dms_source_endpoint_tf.endpointArn())
            .tableMappings("{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}")
            .tags(Map.of("Name", "test"))
            .targetEndpointArn(test_dms_target_endpoint_tf.endpointArn())
            .build());

    }
}

    resources:
  # Create a new replication task
  test:
    type: aws:dms:ReplicationTask
    properties:
      cdcStartTime: 1993-05-21T05:50:00Z
      migrationType: full-load
      replicationInstanceArn: ${["test-dms-replication-instance-tf"].replicationInstanceArn}
      replicationTaskId: test-dms-replication-task-tf
      replicationTaskSettings: '...'
      sourceEndpointArn: ${["test-dms-source-endpoint-tf"].endpointArn}
      tableMappings: '{"rules":[{"rule-type":"selection","rule-id":"1","rule-name":"1","object-locator":{"schema-name":"%","table-name":"%"},"rule-action":"include"}]}'
      tags:
        Name: test
      targetEndpointArn: ${["test-dms-target-endpoint-tf"].endpointArn}

    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,
                    migration_type: Optional[str] = None,
                    replication_instance_arn: Optional[str] = None,
                    replication_task_id: Optional[str] = None,
                    source_endpoint_arn: Optional[str] = None,
                    table_mappings: Optional[str] = None,
                    target_endpoint_arn: Optional[str] = None,
                    cdc_start_position: Optional[str] = None,
                    cdc_start_time: Optional[str] = None,
                    replication_task_settings: Optional[str] = None,
                    resource_identifier: Optional[str] = None,
                    start_replication_task: Optional[bool] = None,
                    tags: Optional[Mapping[str, 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:dms:ReplicationTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var replicationTaskResource = new Aws.Dms.ReplicationTask("replicationTaskResource", new()
{
    MigrationType = "string",
    ReplicationInstanceArn = "string",
    ReplicationTaskId = "string",
    SourceEndpointArn = "string",
    TableMappings = "string",
    TargetEndpointArn = "string",
    CdcStartPosition = "string",
    CdcStartTime = "string",
    ReplicationTaskSettings = "string",
    ResourceIdentifier = "string",
    StartReplicationTask = false,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := dms.NewReplicationTask(ctx, "replicationTaskResource", &dms.ReplicationTaskArgs{
	MigrationType:           pulumi.String("string"),
	ReplicationInstanceArn:  pulumi.String("string"),
	ReplicationTaskId:       pulumi.String("string"),
	SourceEndpointArn:       pulumi.String("string"),
	TableMappings:           pulumi.String("string"),
	TargetEndpointArn:       pulumi.String("string"),
	CdcStartPosition:        pulumi.String("string"),
	CdcStartTime:            pulumi.String("string"),
	ReplicationTaskSettings: pulumi.String("string"),
	ResourceIdentifier:      pulumi.String("string"),
	StartReplicationTask:    pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var replicationTaskResource = new ReplicationTask("replicationTaskResource", ReplicationTaskArgs.builder()
    .migrationType("string")
    .replicationInstanceArn("string")
    .replicationTaskId("string")
    .sourceEndpointArn("string")
    .tableMappings("string")
    .targetEndpointArn("string")
    .cdcStartPosition("string")
    .cdcStartTime("string")
    .replicationTaskSettings("string")
    .resourceIdentifier("string")
    .startReplicationTask(false)
    .tags(Map.of("string", "string"))
    .build());

    replication_task_resource = aws.dms.ReplicationTask("replicationTaskResource",
    migration_type="string",
    replication_instance_arn="string",
    replication_task_id="string",
    source_endpoint_arn="string",
    table_mappings="string",
    target_endpoint_arn="string",
    cdc_start_position="string",
    cdc_start_time="string",
    replication_task_settings="string",
    resource_identifier="string",
    start_replication_task=False,
    tags={
        "string": "string",
    })

    const replicationTaskResource = new aws.dms.ReplicationTask("replicationTaskResource", {
    migrationType: "string",
    replicationInstanceArn: "string",
    replicationTaskId: "string",
    sourceEndpointArn: "string",
    tableMappings: "string",
    targetEndpointArn: "string",
    cdcStartPosition: "string",
    cdcStartTime: "string",
    replicationTaskSettings: "string",
    resourceIdentifier: "string",
    startReplicationTask: false,
    tags: {
        string: "string",
    },
});

    type: aws:dms:ReplicationTask
properties:
    cdcStartPosition: string
    cdcStartTime: string
    migrationType: string
    replicationInstanceArn: string
    replicationTaskId: string
    replicationTaskSettings: string
    resourceIdentifier: string
    sourceEndpointArn: string
    startReplicationTask: false
    tableMappings: string
    tags:
        string: string
    targetEndpointArn: string

    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 string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ReplicationInstanceArn string
    ARN of the replication instance.
    ReplicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    SourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    TableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    TargetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    CdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    CdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    ReplicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    MigrationType string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ReplicationInstanceArn string
    ARN of the replication instance.
    ReplicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    SourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    TableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    TargetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    CdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    CdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    ReplicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    migrationType String
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn String
    ARN of the replication instance.
    replicationTaskId String
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    sourceEndpointArn String
    ARN that uniquely identifies the source endpoint.
    tableMappings String
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn String
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition String
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime String
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    replicationTaskSettings String
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    migrationType string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn string
    ARN of the replication instance.
    replicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    sourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    tableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    replicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    startReplicationTask boolean
    Whether to run or stop the replication task.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    migration_type str
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replication_instance_arn str
    ARN of the replication instance.
    replication_task_id str
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    source_endpoint_arn str
    ARN that uniquely identifies the source endpoint.
    table_mappings str
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    target_endpoint_arn str
    ARN that uniquely identifies the target endpoint.
    cdc_start_position str
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdc_start_time str
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    replication_task_settings str
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    start_replication_task bool
    Whether to run or stop the replication task.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    migrationType String
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn String
    ARN of the replication instance.
    replicationTaskId String
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    sourceEndpointArn String
    ARN that uniquely identifies the source endpoint.
    tableMappings String
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    targetEndpointArn String
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition String
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime String
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    replicationTaskSettings String
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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
    ARN for the replication task.
    Status string
    Replication Task status.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Id string
    The provider-assigned unique ID for this managed resource.
    ReplicationTaskArn string
    ARN for the replication task.
    Status string
    Replication Task status.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn String
    ARN for the replication task.
    status String
    Replication Task status.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id string
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn string
    ARN for the replication task.
    status string
    Replication Task status.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id str
    The provider-assigned unique ID for this managed resource.
    replication_task_arn str
    ARN for the replication task.
    status str
    Replication Task status.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    replicationTaskArn String
    ARN for the replication task.
    status String
    Replication Task status.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ReplicationTask Resource

    Get an existing ReplicationTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ReplicationTaskState, opts?: CustomResourceOptions): ReplicationTask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdc_start_position: Optional[str] = None,
        cdc_start_time: Optional[str] = None,
        migration_type: Optional[str] = None,
        replication_instance_arn: Optional[str] = None,
        replication_task_arn: Optional[str] = None,
        replication_task_id: Optional[str] = None,
        replication_task_settings: Optional[str] = None,
        resource_identifier: Optional[str] = None,
        source_endpoint_arn: Optional[str] = None,
        start_replication_task: Optional[bool] = None,
        status: Optional[str] = None,
        table_mappings: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_endpoint_arn: Optional[str] = None) -> ReplicationTask
    func GetReplicationTask(ctx *Context, name string, id IDInput, state *ReplicationTaskState, opts ...ResourceOption) (*ReplicationTask, error)
    public static ReplicationTask Get(string name, Input<string> id, ReplicationTaskState? state, CustomResourceOptions? opts = null)
    public static ReplicationTask get(String name, Output<String> id, ReplicationTaskState state, CustomResourceOptions options)
    resources:  _:    type: aws:dms:ReplicationTask    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    CdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    MigrationType string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ReplicationInstanceArn string
    ARN of the replication instance.
    ReplicationTaskArn string
    ARN for the replication task.
    ReplicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    ReplicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    SourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Status string
    Replication Task status.
    TableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    CdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    CdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    MigrationType string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    ReplicationInstanceArn string
    ARN of the replication instance.
    ReplicationTaskArn string
    ARN for the replication task.
    ReplicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    ReplicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    SourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Status string
    Replication Task status.
    TableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition String
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime String
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    migrationType String
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn String
    ARN of the replication instance.
    replicationTaskArn String
    ARN for the replication task.
    replicationTaskId String
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    replicationTaskSettings String
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    sourceEndpointArn String
    ARN that uniquely identifies the source endpoint.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    status String
    Replication Task status.
    tableMappings String
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn String
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition string
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime string
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    migrationType string
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn string
    ARN of the replication instance.
    replicationTaskArn string
    ARN for the replication task.
    replicationTaskId string
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    replicationTaskSettings string
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    sourceEndpointArn string
    ARN that uniquely identifies the source endpoint.
    startReplicationTask boolean
    Whether to run or stop the replication task.
    status string
    Replication Task status.
    tableMappings string
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn string
    ARN that uniquely identifies the target endpoint.
    cdc_start_position str
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdc_start_time str
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    migration_type str
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replication_instance_arn str
    ARN of the replication instance.
    replication_task_arn str
    ARN for the replication task.
    replication_task_id str
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    replication_task_settings str
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    source_endpoint_arn str
    ARN that uniquely identifies the source endpoint.
    start_replication_task bool
    Whether to run or stop the replication task.
    status str
    Replication Task status.
    table_mappings str
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_endpoint_arn str
    ARN that uniquely identifies the target endpoint.
    cdcStartPosition String
    Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see Determining a CDC native start point.
    cdcStartTime String
    RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
    migrationType String
    Migration type. Can be one of full-load | cdc | full-load-and-cdc.
    replicationInstanceArn String
    ARN of the replication instance.
    replicationTaskArn String
    ARN for the replication task.
    replicationTaskId String
    Replication task identifier which must contain from 1 to 255 alphanumeric characters or hyphens, first character must be a letter, cannot end with a hyphen, and cannot contain two consecutive hyphens.
    replicationTaskSettings String
    Escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks. Note that Logging.CloudWatchLogGroup and Logging.CloudWatchLogStream are read only and should not be defined, even as null, in the configuration since AWS provides a value for these settings.
    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.
    sourceEndpointArn String
    ARN that uniquely identifies the source endpoint.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    status String
    Replication Task status.
    tableMappings String
    Escaped JSON string that contains the table mappings. For information on table mapping see Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetEndpointArn String
    ARN that uniquely identifies the target endpoint.

    Import

    Using pulumi import, import replication tasks using the replication_task_id. For example:

    $ pulumi import aws:dms/replicationTask:ReplicationTask test test-dms-replication-task-tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws