| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DMS.StartReplicationTask
Description
Starts the replication task.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
Synopsis
- data StartReplicationTask = StartReplicationTask' {}
- newStartReplicationTask :: Text -> StartReplicationTaskTypeValue -> StartReplicationTask
- startReplicationTask_cdcStartPosition :: Lens' StartReplicationTask (Maybe Text)
- startReplicationTask_cdcStartTime :: Lens' StartReplicationTask (Maybe UTCTime)
- startReplicationTask_cdcStopPosition :: Lens' StartReplicationTask (Maybe Text)
- startReplicationTask_replicationTaskArn :: Lens' StartReplicationTask Text
- startReplicationTask_startReplicationTaskType :: Lens' StartReplicationTask StartReplicationTaskTypeValue
- data StartReplicationTaskResponse = StartReplicationTaskResponse' {}
- newStartReplicationTaskResponse :: Int -> StartReplicationTaskResponse
- startReplicationTaskResponse_replicationTask :: Lens' StartReplicationTaskResponse (Maybe ReplicationTask)
- startReplicationTaskResponse_httpStatus :: Lens' StartReplicationTaskResponse Int
Creating a Request
data StartReplicationTask Source #
See: newStartReplicationTask smart constructor.
Constructors
| StartReplicationTask' | |
Fields
| |
Instances
newStartReplicationTask Source #
Arguments
| :: Text | |
| -> StartReplicationTaskTypeValue | |
| -> StartReplicationTask |
Create a value of StartReplicationTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartReplicationTask, startReplicationTask_cdcStartPosition - 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.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
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 slotName extra
connection attribute to the name of this logical replication slot. For
more information, see
Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
$sel:cdcStartTime:StartReplicationTask', startReplicationTask_cdcStartTime - 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.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
StartReplicationTask, startReplicationTask_cdcStopPosition - Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
StartReplicationTask, startReplicationTask_replicationTaskArn - The Amazon Resource Name (ARN) of the replication task to be started.
$sel:startReplicationTaskType:StartReplicationTask', startReplicationTask_startReplicationTaskType - The type of replication task to start.
When the migration type is full-load or full-load-and-cdc, the only
valid value for the first run of the task is start-replication. You
use reload-target to restart the task and resume-processing to
resume the task.
When the migration type is cdc, you use start-replication to start
or restart the task, and resume-processing to resume the task.
reload-target is not a valid value for a task with migration type of
cdc.
Request Lenses
startReplicationTask_cdcStartPosition :: Lens' StartReplicationTask (Maybe Text) Source #
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.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
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 slotName extra
connection attribute to the name of this logical replication slot. For
more information, see
Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
startReplicationTask_cdcStartTime :: Lens' StartReplicationTask (Maybe UTCTime) Source #
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.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
startReplicationTask_cdcStopPosition :: Lens' StartReplicationTask (Maybe Text) Source #
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
startReplicationTask_replicationTaskArn :: Lens' StartReplicationTask Text Source #
The Amazon Resource Name (ARN) of the replication task to be started.
startReplicationTask_startReplicationTaskType :: Lens' StartReplicationTask StartReplicationTaskTypeValue Source #
The type of replication task to start.
When the migration type is full-load or full-load-and-cdc, the only
valid value for the first run of the task is start-replication. You
use reload-target to restart the task and resume-processing to
resume the task.
When the migration type is cdc, you use start-replication to start
or restart the task, and resume-processing to resume the task.
reload-target is not a valid value for a task with migration type of
cdc.
Destructuring the Response
data StartReplicationTaskResponse Source #
See: newStartReplicationTaskResponse smart constructor.
Constructors
| StartReplicationTaskResponse' | |
Fields
| |
Instances
newStartReplicationTaskResponse Source #
Create a value of StartReplicationTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicationTask:StartReplicationTaskResponse', startReplicationTaskResponse_replicationTask - The replication task started.
$sel:httpStatus:StartReplicationTaskResponse', startReplicationTaskResponse_httpStatus - The response's http status code.
Response Lenses
startReplicationTaskResponse_replicationTask :: Lens' StartReplicationTaskResponse (Maybe ReplicationTask) Source #
The replication task started.
startReplicationTaskResponse_httpStatus :: Lens' StartReplicationTaskResponse Int Source #
The response's http status code.