1. Packages
  2. AWS
  3. API Docs
  4. dms
  5. getReplicationTask
AWS v7.10.0 published on Friday, Oct 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.dms.getReplicationTask

Get Started
aws logo
AWS v7.10.0 published on Friday, Oct 24, 2025 by Pulumi
pulumi/pulumi-aws

    Data source for managing an AWS DMS (Database Migration) Replication Task.

    Example Usage

    Basic Usage

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

const test = aws.dms.getReplicationTask({
    replicationTaskId: testAwsDmsReplicationTask.replicationTaskId,
});

    import pulumi
import pulumi_aws as aws

test = aws.dms.get_replication_task(replication_task_id=test_aws_dms_replication_task["replicationTaskId"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.LookupReplicationTask(ctx, &dms.LookupReplicationTaskArgs{
			ReplicationTaskId: testAwsDmsReplicationTask.ReplicationTaskId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Aws.Dms.GetReplicationTask.Invoke(new()
    {
        ReplicationTaskId = testAwsDmsReplicationTask.ReplicationTaskId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.DmsFunctions;
import com.pulumi.aws.dms.inputs.GetReplicationTaskArgs;
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) {
        final var test = DmsFunctions.getReplicationTask(GetReplicationTaskArgs.builder()
            .replicationTaskId(testAwsDmsReplicationTask.replicationTaskId())
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: aws:dms:getReplicationTask
      arguments:
        replicationTaskId: ${testAwsDmsReplicationTask.replicationTaskId}

    Using getReplicationTask

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReplicationTask(args: GetReplicationTaskArgs, opts?: InvokeOptions): Promise<GetReplicationTaskResult>
function getReplicationTaskOutput(args: GetReplicationTaskOutputArgs, opts?: InvokeOptions): Output<GetReplicationTaskResult>
    def get_replication_task(region: Optional[str] = None,
                         replication_task_id: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetReplicationTaskResult
def get_replication_task_output(region: Optional[pulumi.Input[str]] = None,
                         replication_task_id: Optional[pulumi.Input[str]] = None,
                         tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetReplicationTaskResult]
    func LookupReplicationTask(ctx *Context, args *LookupReplicationTaskArgs, opts ...InvokeOption) (*LookupReplicationTaskResult, error)
func LookupReplicationTaskOutput(ctx *Context, args *LookupReplicationTaskOutputArgs, opts ...InvokeOption) LookupReplicationTaskResultOutput

    > Note: This function is named LookupReplicationTask in the Go SDK.

    public static class GetReplicationTask 
{
    public static Task<GetReplicationTaskResult> InvokeAsync(GetReplicationTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationTaskResult> Invoke(GetReplicationTaskInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReplicationTaskResult> getReplicationTask(GetReplicationTaskArgs args, InvokeOptions options)
public static Output<GetReplicationTaskResult> getReplicationTask(GetReplicationTaskArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:dms/getReplicationTask:getReplicationTask
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ReplicationTaskId string
    The replication task identifier.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    ReplicationTaskId string
    The replication task identifier.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    replicationTaskId String
    The replication task identifier.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    replicationTaskId string
    The replication task identifier.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    replication_task_id str
    The replication task identifier.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    replicationTaskId String
    The replication task identifier.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>

    getReplicationTask Result

    The following output properties are available:

    CdcStartPosition string
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    CdcStartTime string
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    Region string
    ReplicationInstanceArn string
    The Amazon Resource Name (ARN) of the replication instance.
    ReplicationTaskArn string
    The Amazon Resource Name (ARN) for the replication task.
    ReplicationTaskId string
    ReplicationTaskSettings string
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Status string
    Replication Task status.
    TableMappings string
    An 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>
    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    CdcStartPosition string
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    CdcStartTime string
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    Region string
    ReplicationInstanceArn string
    The Amazon Resource Name (ARN) of the replication instance.
    ReplicationTaskArn string
    The Amazon Resource Name (ARN) for the replication task.
    ReplicationTaskId string
    ReplicationTaskSettings string
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    SourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    StartReplicationTask bool
    Whether to run or stop the replication task.
    Status string
    Replication Task status.
    TableMappings string
    An 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
    TargetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    cdcStartPosition String
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    cdcStartTime String
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    id String
    The provider-assigned unique ID for this managed resource.
    migrationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    region String
    replicationInstanceArn String
    The Amazon Resource Name (ARN) of the replication instance.
    replicationTaskArn String
    The Amazon Resource Name (ARN) for the replication task.
    replicationTaskId String
    replicationTaskSettings String
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    status String
    Replication Task status.
    tableMappings String
    An 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>
    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    cdcStartPosition string
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    cdcStartTime string
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    id string
    The provider-assigned unique ID for this managed resource.
    migrationType string
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    region string
    replicationInstanceArn string
    The Amazon Resource Name (ARN) of the replication instance.
    replicationTaskArn string
    The Amazon Resource Name (ARN) for the replication task.
    replicationTaskId string
    replicationTaskSettings string
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    sourceEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplicationTask boolean
    Whether to run or stop the replication task.
    status string
    Replication Task status.
    tableMappings string
    An 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}
    targetEndpointArn string
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    cdc_start_position str
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    cdc_start_time str
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    id str
    The provider-assigned unique ID for this managed resource.
    migration_type str
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    region str
    replication_instance_arn str
    The Amazon Resource Name (ARN) of the replication instance.
    replication_task_arn str
    The Amazon Resource Name (ARN) for the replication task.
    replication_task_id str
    replication_task_settings str
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    source_endpoint_arn str
    The Amazon Resource Name (ARN) string 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
    An 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]
    target_endpoint_arn str
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
    cdcStartPosition String
    (Conflicts with cdc_start_time) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see Determining a CDC native start point.
    cdcStartTime String
    (Conflicts with cdc_start_position) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
    id String
    The provider-assigned unique ID for this managed resource.
    migrationType String
    The migration type. Can be one of full-load | cdc | full-load-and-cdc.
    region String
    replicationInstanceArn String
    The Amazon Resource Name (ARN) of the replication instance.
    replicationTaskArn String
    The Amazon Resource Name (ARN) for the replication task.
    replicationTaskId String
    replicationTaskSettings String
    An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.
    sourceEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
    startReplicationTask Boolean
    Whether to run or stop the replication task.
    status String
    Replication Task status.
    tableMappings String
    An 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>
    targetEndpointArn String
    The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

    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 v7.10.0 published on Friday, Oct 24, 2025 by Pulumi
    pulumi/pulumi-aws
      Meet Neo: Your AI Platform Teammate