aws_sdk_databasemigration/client/
start_replication_task.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartReplicationTask`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`replication_task_arn(impl Into<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::replication_task_arn) / [`set_replication_task_arn(Option<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::set_replication_task_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the replication task to be started.</p><br>
    ///   - [`start_replication_task_type(StartReplicationTaskTypeValue)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::start_replication_task_type) / [`set_start_replication_task_type(Option<StartReplicationTaskTypeValue>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::set_start_replication_task_type):<br>required: **true**<br><p>The type of replication task to start.</p> <p>When the migration type is <code>full-load</code> or <code>full-load-and-cdc</code>, the only valid value for the first run of the task is <code>start-replication</code>. This option will start the migration.</p> <p>You can also use <code>ReloadTables</code> to reload specific tables that failed during migration instead of restarting the task.</p> <p>The <code>resume-processing</code> option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.</p> <p>For a <code>full-load-and-cdc</code> task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use <code>reload-target</code>. Otherwise use <code>resume-processing</code>, to replicate the changes from the last stop position.</p><br>
    ///   - [`cdc_start_time(DateTime)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::cdc_start_time) / [`set_cdc_start_time(Option<DateTime>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::set_cdc_start_time):<br>required: **false**<br><p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p><br>
    ///   - [`cdc_start_position(impl Into<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::cdc_start_position) / [`set_cdc_start_position(Option<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::set_cdc_start_position):<br>required: **false**<br><p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p><note>  <p>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra Connection Attributes When Using PostgreSQL as a Source for DMS</a>.</p> </note><br>
    ///   - [`cdc_stop_position(impl Into<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::cdc_stop_position) / [`set_cdc_stop_position(Option<String>)`](crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::set_cdc_stop_position):<br>required: **false**<br><p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“</p><br>
    /// - On success, responds with [`StartReplicationTaskOutput`](crate::operation::start_replication_task::StartReplicationTaskOutput) with field(s):
    ///   - [`replication_task(Option<ReplicationTask>)`](crate::operation::start_replication_task::StartReplicationTaskOutput::replication_task): <p>The replication task started.</p>
    /// - On failure, responds with [`SdkError<StartReplicationTaskError>`](crate::operation::start_replication_task::StartReplicationTaskError)
    pub fn start_replication_task(&self) -> crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder {
        crate::operation::start_replication_task::builders::StartReplicationTaskFluentBuilder::new(self.handle.clone())
    }
}