aws_sdk_databasemigration/client/
create_replication_task.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateReplicationTask`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`replication_task_identifier(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::replication_task_identifier) / [`set_replication_task_identifier(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_replication_task_identifier):<br>required: **true**<br><p>An identifier for the replication task.</p> <p>Constraints:</p> <ul>  <li>   <p>Must contain 1-255 alphanumeric characters or hyphens.</p></li>  <li>   <p>First character must be a letter.</p></li>  <li>   <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li> </ul><br>
    ///   - [`source_endpoint_arn(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::source_endpoint_arn) / [`set_source_endpoint_arn(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_source_endpoint_arn):<br>required: **true**<br><p>An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.</p><br>
    ///   - [`target_endpoint_arn(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::target_endpoint_arn) / [`set_target_endpoint_arn(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_target_endpoint_arn):<br>required: **true**<br><p>An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.</p><br>
    ///   - [`replication_instance_arn(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::replication_instance_arn) / [`set_replication_instance_arn(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_replication_instance_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of a replication instance.</p><br>
    ///   - [`migration_type(MigrationTypeValue)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::migration_type) / [`set_migration_type(Option<MigrationTypeValue>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_migration_type):<br>required: **true**<br><p>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> | <code>full-load-and-cdc</code></p><br>
    ///   - [`table_mappings(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::table_mappings) / [`set_table_mappings(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_table_mappings):<br>required: **true**<br><p>The table mappings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html">Using Table Mapping to Specify Task Settings</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`replication_task_settings(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::replication_task_settings) / [`set_replication_task_settings(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_replication_task_settings):<br>required: **false**<br><p>Overall settings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html">Specifying Task Settings for Database Migration Service Tasks</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`cdc_start_time(DateTime)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::cdc_start_time) / [`set_cdc_start_time(Option<DateTime>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::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::create_replication_task::builders::CreateReplicationTaskFluentBuilder::cdc_start_position) / [`set_cdc_start_position(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::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::create_replication_task::builders::CreateReplicationTaskFluentBuilder::cdc_stop_position) / [`set_cdc_stop_position(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::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>
    ///   - [`tags(Tag)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_tags):<br>required: **false**<br><p>One or more tags to be assigned to the replication task.</p><br>
    ///   - [`task_data(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::task_data) / [`set_task_data(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_task_data):<br>required: **false**<br><p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`resource_identifier(impl Into<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::resource_identifier) / [`set_resource_identifier(Option<String>)`](crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::set_resource_identifier):<br>required: **false**<br><p>A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.</p><br>
    /// - On success, responds with [`CreateReplicationTaskOutput`](crate::operation::create_replication_task::CreateReplicationTaskOutput) with field(s):
    ///   - [`replication_task(Option<ReplicationTask>)`](crate::operation::create_replication_task::CreateReplicationTaskOutput::replication_task): <p>The replication task that was created.</p>
    /// - On failure, responds with [`SdkError<CreateReplicationTaskError>`](crate::operation::create_replication_task::CreateReplicationTaskError)
    pub fn create_replication_task(&self) -> crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder {
        crate::operation::create_replication_task::builders::CreateReplicationTaskFluentBuilder::new(self.handle.clone())
    }
}