AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
aws.dms.getReplicationTask
Explore with Pulumi AI
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/v6/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(replication_task_id: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetReplicationTaskResult
def get_replication_task_output(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 dictionaryThe following arguments are supported:
- ReplicationTask stringId 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- Dictionary<string, string>
- ReplicationTask stringId 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- map[string]string
- replicationTask StringId 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- Map<String,String>
- replicationTask stringId 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- {[key: string]: string}
- replication_task_ strid 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- Mapping[str, str]
- replicationTask StringId 
- The replication task identifier.- Must contain from 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen.
- Cannot contain two consecutive hyphens.
 
- Map<String>
getReplicationTask Result
The following output properties are available:
- CdcStart stringPosition 
- (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.
- CdcStart stringTime 
- (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.
- ReplicationInstance stringArn 
- The Amazon Resource Name (ARN) of the replication instance.
- ReplicationTask stringArn 
- The Amazon Resource Name (ARN) for the replication task.
- ReplicationTask stringId 
- ReplicationTask stringSettings 
- 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.
- SourceEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- StartReplication boolTask 
- 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
- Dictionary<string, string>
- TargetEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
- CdcStart stringPosition 
- (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.
- CdcStart stringTime 
- (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.
- ReplicationInstance stringArn 
- The Amazon Resource Name (ARN) of the replication instance.
- ReplicationTask stringArn 
- The Amazon Resource Name (ARN) for the replication task.
- ReplicationTask stringId 
- ReplicationTask stringSettings 
- 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.
- SourceEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- StartReplication boolTask 
- 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
- map[string]string
- TargetEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
- cdcStart StringPosition 
- (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.
- cdcStart StringTime 
- (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.
- replicationInstance StringArn 
- The Amazon Resource Name (ARN) of the replication instance.
- replicationTask StringArn 
- The Amazon Resource Name (ARN) for the replication task.
- replicationTask StringId 
- replicationTask StringSettings 
- 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.
- sourceEndpoint StringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- startReplication BooleanTask 
- 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
- Map<String,String>
- targetEndpoint StringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
- cdcStart stringPosition 
- (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.
- cdcStart stringTime 
- (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.
- replicationInstance stringArn 
- The Amazon Resource Name (ARN) of the replication instance.
- replicationTask stringArn 
- The Amazon Resource Name (ARN) for the replication task.
- replicationTask stringId 
- replicationTask stringSettings 
- 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.
- sourceEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- startReplication booleanTask 
- 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
- {[key: string]: string}
- targetEndpoint stringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
- cdc_start_ strposition 
- (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_ strtime 
- (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.
- replication_instance_ strarn 
- The Amazon Resource Name (ARN) of the replication instance.
- replication_task_ strarn 
- The Amazon Resource Name (ARN) for the replication task.
- replication_task_ strid 
- replication_task_ strsettings 
- 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_ strarn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- start_replication_ booltask 
- 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
- Mapping[str, str]
- target_endpoint_ strarn 
- The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
- cdcStart StringPosition 
- (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.
- cdcStart StringTime 
- (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.
- replicationInstance StringArn 
- The Amazon Resource Name (ARN) of the replication instance.
- replicationTask StringArn 
- The Amazon Resource Name (ARN) for the replication task.
- replicationTask StringId 
- replicationTask StringSettings 
- 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.
- sourceEndpoint StringArn 
- The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
- startReplication BooleanTask 
- 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
- Map<String>
- targetEndpoint StringArn 
- 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 awsTerraform Provider.