Network.AWS.DMS.ModifyReplicationTask

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about AWS DMS tasks, see the AWS DMS user guide at Working with Migration Tasks

Creating a Request

modifyReplicationTask

Arguments

:: Text

mrtReplicationTaskARN

-> ModifyReplicationTask

Creates a value of ModifyReplicationTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mrtReplicationTaskSettings - JSON file that contains settings for the task, such as target metadata settings.
• mrtReplicationTaskIdentifier - The replication task identifier. Constraints: * Must contain from 1 to 255 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.
• mrtCdcStartPosition - 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”
• mrtTableMappings - When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file:/". When working with the DMS API, provide the JSON as the parameter value. For example, --table-mappings file:/mappingfile.json
• mrtMigrationType - The migration type. Valid values: full-load | cdc | full-load-and-cdc
• mrtCdcStopPosition - 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:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
• mrtCdcStartTime - 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.
• mrtReplicationTaskARN - The Amazon Resource Name (ARN) of the replication task.

data ModifyReplicationTask

See: modifyReplicationTask smart constructor.

Instances

Eq ModifyReplicationTask

Methods

(==) :: ModifyReplicationTask -> ModifyReplicationTask -> Bool

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

Data ModifyReplicationTask

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyReplicationTask -> c ModifyReplicationTask

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyReplicationTask

toConstr :: ModifyReplicationTask -> Constr

dataTypeOf :: ModifyReplicationTask -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyReplicationTask)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyReplicationTask)

gmapT :: (forall b. Data b => b -> b) -> ModifyReplicationTask -> ModifyReplicationTask

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationTask -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationTask -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyReplicationTask -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyReplicationTask -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyReplicationTask -> m ModifyReplicationTask

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationTask -> m ModifyReplicationTask

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationTask -> m ModifyReplicationTask

Read ModifyReplicationTask

Methods

readsPrec :: Int -> ReadS ModifyReplicationTask

readList :: ReadS [ModifyReplicationTask]

readPrec :: ReadPrec ModifyReplicationTask

readListPrec :: ReadPrec [ModifyReplicationTask]

Show ModifyReplicationTask

Methods

showsPrec :: Int -> ModifyReplicationTask -> ShowS

show :: ModifyReplicationTask -> String

showList :: [ModifyReplicationTask] -> ShowS

Generic ModifyReplicationTask

Associated Types

type Rep ModifyReplicationTask :: * -> *

Methods

from :: ModifyReplicationTask -> Rep ModifyReplicationTask x

to :: Rep ModifyReplicationTask x -> ModifyReplicationTask

Hashable ModifyReplicationTask

Methods

hashWithSalt :: Int -> ModifyReplicationTask -> Int

hash :: ModifyReplicationTask -> Int

ToJSON ModifyReplicationTask

Methods

toJSON :: ModifyReplicationTask -> Value

toEncoding :: ModifyReplicationTask -> Encoding

toJSONList :: [ModifyReplicationTask] -> Value

toEncodingList :: [ModifyReplicationTask] -> Encoding

NFData ModifyReplicationTask

Methods

rnf :: ModifyReplicationTask -> ()

AWSRequest ModifyReplicationTask

Associated Types

type Rs ModifyReplicationTask :: *

Methods

request :: ModifyReplicationTask -> Request ModifyReplicationTask

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ModifyReplicationTask -> ClientResponse -> m (Response ModifyReplicationTask)

ToHeaders ModifyReplicationTask

Methods

toHeaders :: ModifyReplicationTask -> [Header]

ToPath ModifyReplicationTask

Methods

toPath :: ModifyReplicationTask -> ByteString

ToQuery ModifyReplicationTask

Methods

toQuery :: ModifyReplicationTask -> QueryString

type Rep ModifyReplicationTask

type Rep ModifyReplicationTask = D1 * (MetaData "ModifyReplicationTask" "Network.AWS.DMS.ModifyReplicationTask" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "ModifyReplicationTask'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mrtReplicationTaskSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mrtReplicationTaskIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrtCdcStartPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mrtTableMappings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mrtMigrationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MigrationTypeValue))) (S1 * (MetaSel (Just Symbol "_mrtCdcStopPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrtCdcStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_mrtReplicationTaskARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs ModifyReplicationTask

type Rs ModifyReplicationTask = ModifyReplicationTaskResponse

Request Lenses

mrtReplicationTaskSettings :: Lens' ModifyReplicationTask (Maybe Text)

JSON file that contains settings for the task, such as target metadata settings.

mrtReplicationTaskIdentifier :: Lens' ModifyReplicationTask (Maybe Text)

The replication task identifier. Constraints: * Must contain from 1 to 255 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.

mrtCdcStartPosition :: Lens' ModifyReplicationTask (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”

mrtTableMappings :: Lens' ModifyReplicationTask (Maybe Text)

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with "file:/". When working with the DMS API, provide the JSON as the parameter value. For example, --table-mappings file:/mappingfile.json

mrtMigrationType :: Lens' ModifyReplicationTask (Maybe MigrationTypeValue)

The migration type. Valid values: full-load | cdc | full-load-and-cdc

mrtCdcStopPosition :: Lens' ModifyReplicationTask (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:3018-02-09T12:12:12” Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

mrtCdcStartTime :: Lens' ModifyReplicationTask (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.

mrtReplicationTaskARN :: Lens' ModifyReplicationTask Text

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

Destructuring the Response

modifyReplicationTaskResponse

Arguments

:: Int

mrtrsResponseStatus

-> ModifyReplicationTaskResponse

Creates a value of ModifyReplicationTaskResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mrtrsReplicationTask - The replication task that was modified.
• mrtrsResponseStatus - -- | The response status code.

data ModifyReplicationTaskResponse

See: modifyReplicationTaskResponse smart constructor.

Instances

Eq ModifyReplicationTaskResponse

Methods

(==) :: ModifyReplicationTaskResponse -> ModifyReplicationTaskResponse -> Bool

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

Data ModifyReplicationTaskResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyReplicationTaskResponse -> c ModifyReplicationTaskResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyReplicationTaskResponse

toConstr :: ModifyReplicationTaskResponse -> Constr

dataTypeOf :: ModifyReplicationTaskResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyReplicationTaskResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyReplicationTaskResponse)

gmapT :: (forall b. Data b => b -> b) -> ModifyReplicationTaskResponse -> ModifyReplicationTaskResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationTaskResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationTaskResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyReplicationTaskResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyReplicationTaskResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyReplicationTaskResponse -> m ModifyReplicationTaskResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationTaskResponse -> m ModifyReplicationTaskResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationTaskResponse -> m ModifyReplicationTaskResponse

Read ModifyReplicationTaskResponse

Methods

readsPrec :: Int -> ReadS ModifyReplicationTaskResponse

readList :: ReadS [ModifyReplicationTaskResponse]

readPrec :: ReadPrec ModifyReplicationTaskResponse

readListPrec :: ReadPrec [ModifyReplicationTaskResponse]

Show ModifyReplicationTaskResponse

Methods

showsPrec :: Int -> ModifyReplicationTaskResponse -> ShowS

show :: ModifyReplicationTaskResponse -> String

showList :: [ModifyReplicationTaskResponse] -> ShowS

Generic ModifyReplicationTaskResponse

Associated Types

type Rep ModifyReplicationTaskResponse :: * -> *

Methods

from :: ModifyReplicationTaskResponse -> Rep ModifyReplicationTaskResponse x

to :: Rep ModifyReplicationTaskResponse x -> ModifyReplicationTaskResponse

NFData ModifyReplicationTaskResponse

Methods

rnf :: ModifyReplicationTaskResponse -> ()

type Rep ModifyReplicationTaskResponse

type Rep ModifyReplicationTaskResponse = D1 * (MetaData "ModifyReplicationTaskResponse" "Network.AWS.DMS.ModifyReplicationTask" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "ModifyReplicationTaskResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrtrsReplicationTask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ReplicationTask))) (S1 * (MetaSel (Just Symbol "_mrtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

mrtrsReplicationTask :: Lens' ModifyReplicationTaskResponse (Maybe ReplicationTask)

The replication task that was modified.

mrtrsResponseStatus :: Lens' ModifyReplicationTaskResponse Int

• - | The response status code.