Amazonka.DMS.StartReplicationTask

Starts the replication task.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Creating a Request

data StartReplicationTask

See: newStartReplicationTask smart constructor.

Constructors

StartReplicationTask'

Fields

• cdcStartPosition :: Maybe Text

  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.

• cdcStartTime :: Maybe POSIX

  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”

• cdcStopPosition :: Maybe Text

  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 “

• replicationTaskArn :: Text

  The Amazon Resource Name (ARN) of the replication task to be started.

• startReplicationTaskType :: StartReplicationTaskTypeValue

  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.

Instances

ToJSON StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

toJSON :: StartReplicationTask -> Value

toEncoding :: StartReplicationTask -> Encoding

toJSONList :: [StartReplicationTask] -> Value

toEncodingList :: [StartReplicationTask] -> Encoding

ToHeaders StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

toHeaders :: StartReplicationTask -> [Header]

ToPath StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

toPath :: StartReplicationTask -> ByteString

ToQuery StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

toQuery :: StartReplicationTask -> QueryString

AWSRequest StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Associated Types

type AWSResponse StartReplicationTask

Methods

request :: (Service -> Service) -> StartReplicationTask -> Request StartReplicationTask

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartReplicationTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartReplicationTask)))

Generic StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Associated Types

type Rep StartReplicationTask :: Type -> Type

Methods

from :: StartReplicationTask -> Rep StartReplicationTask x

to :: Rep StartReplicationTask x -> StartReplicationTask

Read StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

readsPrec :: Int -> ReadS StartReplicationTask

readList :: ReadS [StartReplicationTask]

readPrec :: ReadPrec StartReplicationTask

readListPrec :: ReadPrec [StartReplicationTask]

Show StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

showsPrec :: Int -> StartReplicationTask -> ShowS

show :: StartReplicationTask -> String

showList :: [StartReplicationTask] -> ShowS

NFData StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

rnf :: StartReplicationTask -> ()

Eq StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

(==) :: StartReplicationTask -> StartReplicationTask -> Bool

(/=) :: StartReplicationTask -> StartReplicationTask -> Bool

Hashable StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

Methods

hashWithSalt :: Int -> StartReplicationTask -> Int

hash :: StartReplicationTask -> Int

type AWSResponse StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

type AWSResponse StartReplicationTask = StartReplicationTaskResponse

type Rep StartReplicationTask

Defined in Amazonka.DMS.StartReplicationTask

type Rep StartReplicationTask = D1 ('MetaData "StartReplicationTask" "Amazonka.DMS.StartReplicationTask" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "StartReplicationTask'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cdcStartPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cdcStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "cdcStopPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startReplicationTaskType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StartReplicationTaskTypeValue)))))

newStartReplicationTask

Arguments

:: Text

StartReplicationTask

-> StartReplicationTaskTypeValue

$sel:startReplicationTaskType:StartReplicationTask'

-> 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)

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)

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)

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

The Amazon Resource Name (ARN) of the replication task to be started.

startReplicationTask_startReplicationTaskType :: Lens' StartReplicationTask StartReplicationTaskTypeValue

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

See: newStartReplicationTaskResponse smart constructor.

Constructors

StartReplicationTaskResponse'

Fields

• replicationTask :: Maybe ReplicationTask

  The replication task started.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

Associated Types

type Rep StartReplicationTaskResponse :: Type -> Type

Methods

from :: StartReplicationTaskResponse -> Rep StartReplicationTaskResponse x

to :: Rep StartReplicationTaskResponse x -> StartReplicationTaskResponse

Read StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

Methods

readsPrec :: Int -> ReadS StartReplicationTaskResponse

readList :: ReadS [StartReplicationTaskResponse]

readPrec :: ReadPrec StartReplicationTaskResponse

readListPrec :: ReadPrec [StartReplicationTaskResponse]

Show StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

Methods

showsPrec :: Int -> StartReplicationTaskResponse -> ShowS

show :: StartReplicationTaskResponse -> String

showList :: [StartReplicationTaskResponse] -> ShowS

NFData StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

Methods

rnf :: StartReplicationTaskResponse -> ()

Eq StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

Methods

(==) :: StartReplicationTaskResponse -> StartReplicationTaskResponse -> Bool

(/=) :: StartReplicationTaskResponse -> StartReplicationTaskResponse -> Bool

type Rep StartReplicationTaskResponse

Defined in Amazonka.DMS.StartReplicationTask

type Rep StartReplicationTaskResponse = D1 ('MetaData "StartReplicationTaskResponse" "Amazonka.DMS.StartReplicationTask" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "StartReplicationTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationTask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationTask)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartReplicationTaskResponse

Arguments

:: Int

$sel:httpStatus:StartReplicationTaskResponse'

-> StartReplicationTaskResponse

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)

The replication task started.

startReplicationTaskResponse_httpStatus :: Lens' StartReplicationTaskResponse Int

The response's http status code.