Package com.pulumi.aws.dms

Class ReplicationTask

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.dms.ReplicationTask

public class ReplicationTask
extends com.pulumi.resources.CustomResource

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 <!--Start PulumiCodeChooser -->

 
 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());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import replication tasks using the `replication_task_id`. For example: ```sh $ pulumi import aws:dms/replicationTask:ReplicationTask test test-dms-replication-task-tf ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
ReplicationTask(java.lang.String name)
ReplicationTask(java.lang.String name, ReplicationTaskArgs args)
ReplicationTask(java.lang.String name, ReplicationTaskArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	cdcStartPosition()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	cdcStartTime()
static ReplicationTask	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ReplicationTaskState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.lang.String>	migrationType()
com.pulumi.core.Output<java.lang.String>	replicationInstanceArn()
com.pulumi.core.Output<java.lang.String>	replicationTaskArn()
com.pulumi.core.Output<java.lang.String>	replicationTaskId()
com.pulumi.core.Output<java.lang.String>	replicationTaskSettings()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	resourceIdentifier()
com.pulumi.core.Output<java.lang.String>	sourceEndpointArn()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>	startReplicationTask()
com.pulumi.core.Output<java.lang.String>	status()
com.pulumi.core.Output<java.lang.String>	tableMappings()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()
com.pulumi.core.Output<java.lang.String>	targetEndpointArn()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplicationTask

public ReplicationTask(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

ReplicationTask

public ReplicationTask(java.lang.String name,
                       ReplicationTaskArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

ReplicationTask

public ReplicationTask(java.lang.String name,
                       ReplicationTaskArgs args,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

cdcStartPosition

public com.pulumi.core.Output<java.lang.String> cdcStartPosition()

Returns:

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](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native).

cdcStartTime

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> cdcStartTime()

Returns:

RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.

migrationType

public com.pulumi.core.Output<java.lang.String> migrationType()

Returns:

The migration type. Can be one of `full-load | cdc | full-load-and-cdc`.

replicationInstanceArn

public com.pulumi.core.Output<java.lang.String> replicationInstanceArn()

Returns:

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

replicationTaskArn

public com.pulumi.core.Output<java.lang.String> replicationTaskArn()

Returns:

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

replicationTaskId

public com.pulumi.core.Output<java.lang.String> replicationTaskId()

Returns:

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.

replicationTaskSettings

public com.pulumi.core.Output<java.lang.String> replicationTaskSettings()

Returns:

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](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html).

resourceIdentifier

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> resourceIdentifier()

Returns:

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

sourceEndpointArn

public com.pulumi.core.Output<java.lang.String> sourceEndpointArn()

Returns:

The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.

startReplicationTask

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> startReplicationTask()

Returns:

Whether to run or stop the replication task.

status

public com.pulumi.core.Output<java.lang.String> status()

Returns:

Replication Task status.

tableMappings

public com.pulumi.core.Output<java.lang.String> tableMappings()

Returns:

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](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html)

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

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

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

targetEndpointArn

public com.pulumi.core.Output<java.lang.String> targetEndpointArn()

Returns:

The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

get

public static ReplicationTask get(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  ReplicationTaskState state,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)

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

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.