// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_replication_task::_start_replication_task_input::StartReplicationTaskInputBuilder;
pub use crate::operation::start_replication_task::_start_replication_task_output::StartReplicationTaskOutputBuilder;
impl crate::operation::start_replication_task::builders::StartReplicationTaskInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::start_replication_task::StartReplicationTaskOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_replication_task::StartReplicationTaskError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.start_replication_task();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `StartReplicationTask`.
///
/// <p>Starts the replication task.</p>
/// <p>For more information about DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks </a> in the <i>Database Migration Service User Guide.</i></p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartReplicationTaskFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_replication_task::builders::StartReplicationTaskInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::start_replication_task::StartReplicationTaskOutput,
crate::operation::start_replication_task::StartReplicationTaskError,
> for StartReplicationTaskFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::start_replication_task::StartReplicationTaskOutput,
crate::operation::start_replication_task::StartReplicationTaskError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl StartReplicationTaskFluentBuilder {
/// Creates a new `StartReplicationTaskFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the StartReplicationTask as a reference.
pub fn as_input(&self) -> &crate::operation::start_replication_task::builders::StartReplicationTaskInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::start_replication_task::StartReplicationTaskOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_replication_task::StartReplicationTaskError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::start_replication_task::StartReplicationTask::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::start_replication_task::StartReplicationTask::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::start_replication_task::StartReplicationTaskOutput,
crate::operation::start_replication_task::StartReplicationTaskError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The Amazon Resource Name (ARN) of the replication task to be started.</p>
pub fn replication_task_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.replication_task_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the replication task to be started.</p>
pub fn set_replication_task_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_replication_task_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the replication task to be started.</p>
pub fn get_replication_task_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_replication_task_arn()
}
/// <p>The type of replication task to start.</p>
/// <p><code>start-replication</code> is the only valid action that can be used for the first time a task with the migration type of <code>full-load</code>full-load, <code>full-load-and-cdc</code> or <code>cdc</code> is run. Any other action used for the first time on a given task, such as <code>resume-processing</code> and reload-target will result in data errors.</p>
/// <p>You can also use <code>ReloadTables</code> to reload specific tables that failed during migration instead of restarting the task.</p>
/// <p>For a <code>full-load</code> task, the resume-processing option will reload any tables that were partially loaded or not yet loaded 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>
/// <p>For a <code>cdc</code> only task, to start from a specific position, you must use start-replication and also specify the start position. Check the source endpoint DMS documentation for any limitations. For example, not all sources support starting from a time.</p><note>
/// <p><code>resume-processing</code> is only available for previously executed tasks.</p>
/// </note>
pub fn start_replication_task_type(mut self, input: crate::types::StartReplicationTaskTypeValue) -> Self {
self.inner = self.inner.start_replication_task_type(input);
self
}
/// <p>The type of replication task to start.</p>
/// <p><code>start-replication</code> is the only valid action that can be used for the first time a task with the migration type of <code>full-load</code>full-load, <code>full-load-and-cdc</code> or <code>cdc</code> is run. Any other action used for the first time on a given task, such as <code>resume-processing</code> and reload-target will result in data errors.</p>
/// <p>You can also use <code>ReloadTables</code> to reload specific tables that failed during migration instead of restarting the task.</p>
/// <p>For a <code>full-load</code> task, the resume-processing option will reload any tables that were partially loaded or not yet loaded 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>
/// <p>For a <code>cdc</code> only task, to start from a specific position, you must use start-replication and also specify the start position. Check the source endpoint DMS documentation for any limitations. For example, not all sources support starting from a time.</p><note>
/// <p><code>resume-processing</code> is only available for previously executed tasks.</p>
/// </note>
pub fn set_start_replication_task_type(mut self, input: ::std::option::Option<crate::types::StartReplicationTaskTypeValue>) -> Self {
self.inner = self.inner.set_start_replication_task_type(input);
self
}
/// <p>The type of replication task to start.</p>
/// <p><code>start-replication</code> is the only valid action that can be used for the first time a task with the migration type of <code>full-load</code>full-load, <code>full-load-and-cdc</code> or <code>cdc</code> is run. Any other action used for the first time on a given task, such as <code>resume-processing</code> and reload-target will result in data errors.</p>
/// <p>You can also use <code>ReloadTables</code> to reload specific tables that failed during migration instead of restarting the task.</p>
/// <p>For a <code>full-load</code> task, the resume-processing option will reload any tables that were partially loaded or not yet loaded 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>
/// <p>For a <code>cdc</code> only task, to start from a specific position, you must use start-replication and also specify the start position. Check the source endpoint DMS documentation for any limitations. For example, not all sources support starting from a time.</p><note>
/// <p><code>resume-processing</code> is only available for previously executed tasks.</p>
/// </note>
pub fn get_start_replication_task_type(&self) -> &::std::option::Option<crate::types::StartReplicationTaskTypeValue> {
self.inner.get_start_replication_task_type()
}
/// <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>
pub fn cdc_start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.cdc_start_time(input);
self
}
/// <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>
pub fn set_cdc_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_cdc_start_time(input);
self
}
/// <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>
pub fn get_cdc_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_cdc_start_time()
}
/// <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>
pub fn cdc_start_position(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.cdc_start_position(input.into());
self
}
/// <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>
pub fn set_cdc_start_position(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_cdc_start_position(input);
self
}
/// <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>
pub fn get_cdc_start_position(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_cdc_start_position()
}
/// <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>
pub fn cdc_stop_position(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.cdc_stop_position(input.into());
self
}
/// <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>
pub fn set_cdc_stop_position(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_cdc_stop_position(input);
self
}
/// <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>
pub fn get_cdc_stop_position(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_cdc_stop_position()
}
}