com.pulumi.aws.dms.kotlin.ReplicationTaskArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.dms.kotlin
import com.pulumi.aws.dms.ReplicationTaskArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* 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
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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"])
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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}
* ```
*
* ## 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
* ```
* @property cdcStartPosition 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).
* @property cdcStartTime RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
* @property migrationType Migration type. Can be one of `full-load | cdc | full-load-and-cdc`.
* @property replicationInstanceArn ARN of the replication instance.
* @property replicationTaskId 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.
* @property replicationTaskSettings 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). 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.
* @property resourceIdentifier A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
* @property sourceEndpointArn ARN that uniquely identifies the source endpoint.
* @property startReplicationTask Whether to run or stop the replication task.
* @property tableMappings 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)
* @property tags 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.
* @property targetEndpointArn ARN that uniquely identifies the target endpoint.
*/
public data class ReplicationTaskArgs(
public val cdcStartPosition: Output? = null,
public val cdcStartTime: Output? = null,
public val migrationType: Output? = null,
public val replicationInstanceArn: Output? = null,
public val replicationTaskId: Output? = null,
public val replicationTaskSettings: Output? = null,
public val resourceIdentifier: Output? = null,
public val sourceEndpointArn: Output? = null,
public val startReplicationTask: Output? = null,
public val tableMappings: Output? = null,
public val tags: Output>? = null,
public val targetEndpointArn: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.dms.ReplicationTaskArgs =
com.pulumi.aws.dms.ReplicationTaskArgs.builder()
.cdcStartPosition(cdcStartPosition?.applyValue({ args0 -> args0 }))
.cdcStartTime(cdcStartTime?.applyValue({ args0 -> args0 }))
.migrationType(migrationType?.applyValue({ args0 -> args0 }))
.replicationInstanceArn(replicationInstanceArn?.applyValue({ args0 -> args0 }))
.replicationTaskId(replicationTaskId?.applyValue({ args0 -> args0 }))
.replicationTaskSettings(replicationTaskSettings?.applyValue({ args0 -> args0 }))
.resourceIdentifier(resourceIdentifier?.applyValue({ args0 -> args0 }))
.sourceEndpointArn(sourceEndpointArn?.applyValue({ args0 -> args0 }))
.startReplicationTask(startReplicationTask?.applyValue({ args0 -> args0 }))
.tableMappings(tableMappings?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.targetEndpointArn(targetEndpointArn?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ReplicationTaskArgs].
*/
@PulumiTagMarker
public class ReplicationTaskArgsBuilder internal constructor() {
private var cdcStartPosition: Output? = null
private var cdcStartTime: Output? = null
private var migrationType: Output? = null
private var replicationInstanceArn: Output? = null
private var replicationTaskId: Output? = null
private var replicationTaskSettings: Output? = null
private var resourceIdentifier: Output? = null
private var sourceEndpointArn: Output? = null
private var startReplicationTask: Output? = null
private var tableMappings: Output? = null
private var tags: Output>? = null
private var targetEndpointArn: Output? = null
/**
* @param value 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).
*/
@JvmName("wevdfitlblmgsvrt")
public suspend fun cdcStartPosition(`value`: Output) {
this.cdcStartPosition = value
}
/**
* @param value RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
*/
@JvmName("qqvxgbhlbvhdfycx")
public suspend fun cdcStartTime(`value`: Output) {
this.cdcStartTime = value
}
/**
* @param value Migration type. Can be one of `full-load | cdc | full-load-and-cdc`.
*/
@JvmName("vxijqysqjutfpulv")
public suspend fun migrationType(`value`: Output) {
this.migrationType = value
}
/**
* @param value ARN of the replication instance.
*/
@JvmName("dxvyxwmoduoxaqqo")
public suspend fun replicationInstanceArn(`value`: Output) {
this.replicationInstanceArn = value
}
/**
* @param value 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.
*/
@JvmName("crrbcprvprpnaxog")
public suspend fun replicationTaskId(`value`: Output) {
this.replicationTaskId = value
}
/**
* @param value 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). 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.
*/
@JvmName("bgtlnauqvmjodmcm")
public suspend fun replicationTaskSettings(`value`: Output) {
this.replicationTaskSettings = value
}
/**
* @param value A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
*/
@JvmName("bcvuwtfdobhlveda")
public suspend fun resourceIdentifier(`value`: Output) {
this.resourceIdentifier = value
}
/**
* @param value ARN that uniquely identifies the source endpoint.
*/
@JvmName("phxsybwrlcfjcsap")
public suspend fun sourceEndpointArn(`value`: Output) {
this.sourceEndpointArn = value
}
/**
* @param value Whether to run or stop the replication task.
*/
@JvmName("yxggsdjcdfrpdckd")
public suspend fun startReplicationTask(`value`: Output) {
this.startReplicationTask = value
}
/**
* @param value 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)
*/
@JvmName("fuwwgfhljdkxtmxa")
public suspend fun tableMappings(`value`: Output) {
this.tableMappings = value
}
/**
* @param value 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.
*/
@JvmName("hrpekdnmnqgguxpv")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value ARN that uniquely identifies the target endpoint.
*/
@JvmName("arnyjmmfegedmqtt")
public suspend fun targetEndpointArn(`value`: Output) {
this.targetEndpointArn = value
}
/**
* @param value 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).
*/
@JvmName("icesbrbystlwvtdv")
public suspend fun cdcStartPosition(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.cdcStartPosition = mapped
}
/**
* @param value RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation.
*/
@JvmName("psenprvtptvfpsra")
public suspend fun cdcStartTime(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.cdcStartTime = mapped
}
/**
* @param value Migration type. Can be one of `full-load | cdc | full-load-and-cdc`.
*/
@JvmName("numfqxympcuwlfph")
public suspend fun migrationType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.migrationType = mapped
}
/**
* @param value ARN of the replication instance.
*/
@JvmName("ufdpbgkuodnccqdj")
public suspend fun replicationInstanceArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicationInstanceArn = mapped
}
/**
* @param value 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.
*/
@JvmName("swvqrvrcnpwfmfos")
public suspend fun replicationTaskId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicationTaskId = mapped
}
/**
* @param value 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). 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.
*/
@JvmName("osetiltipvqejhse")
public suspend fun replicationTaskSettings(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicationTaskSettings = mapped
}
/**
* @param value A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
*/
@JvmName("cxbjjhquvqhxuqwc")
public suspend fun resourceIdentifier(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceIdentifier = mapped
}
/**
* @param value ARN that uniquely identifies the source endpoint.
*/
@JvmName("xcclscqrnlwtqqlw")
public suspend fun sourceEndpointArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sourceEndpointArn = mapped
}
/**
* @param value Whether to run or stop the replication task.
*/
@JvmName("qkandplnqivsvaul")
public suspend fun startReplicationTask(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.startReplicationTask = mapped
}
/**
* @param value 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)
*/
@JvmName("qqkjwxrrcbrfqncn")
public suspend fun tableMappings(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tableMappings = mapped
}
/**
* @param value 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.
*/
@JvmName("nlrcbvjcmrqnygtf")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values 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.
*/
@JvmName("hfbvegjcbfdfokmi")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value ARN that uniquely identifies the target endpoint.
*/
@JvmName("eoihpnjgsemklmry")
public suspend fun targetEndpointArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.targetEndpointArn = mapped
}
internal fun build(): ReplicationTaskArgs = ReplicationTaskArgs(
cdcStartPosition = cdcStartPosition,
cdcStartTime = cdcStartTime,
migrationType = migrationType,
replicationInstanceArn = replicationInstanceArn,
replicationTaskId = replicationTaskId,
replicationTaskSettings = replicationTaskSettings,
resourceIdentifier = resourceIdentifier,
sourceEndpointArn = sourceEndpointArn,
startReplicationTask = startReplicationTask,
tableMappings = tableMappings,
tags = tags,
targetEndpointArn = targetEndpointArn,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy