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.ModifyReplicationTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Synopsis

Creating a Request

data ModifyReplicationTask Source #

See: newModifyReplicationTask smart constructor.

Constructors

ModifyReplicationTask'

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 “
migrationType :: Maybe MigrationTypeValue
The migration type. Valid values: full-load | cdc | full-load-and-cdc
replicationTaskIdentifier :: Maybe Text
The replication task identifier.
Constraints:
- Must contain 1-255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
replicationTaskSettings :: Maybe Text
JSON file that contains settings for the task, such as task metadata settings.
tableMappings :: Maybe Text
When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.
taskData :: Maybe Text
Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
replicationTaskArn :: Text
The Amazon Resource Name (ARN) of the replication task.

Instances

Instances details

ToJSON ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods toJSON :: ModifyReplicationTask -> Value # toEncoding :: ModifyReplicationTask -> Encoding # toJSONList :: [ModifyReplicationTask] -> Value # toEncodingList :: [ModifyReplicationTask] -> Encoding #
ToHeaders ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods toHeaders :: ModifyReplicationTask -> [Header] #
ToPath ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods toPath :: ModifyReplicationTask -> ByteString #
ToQuery ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods toQuery :: ModifyReplicationTask -> QueryString #
AWSRequest ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Associated Types type AWSResponse ModifyReplicationTask # Methods request :: (Service -> Service) -> ModifyReplicationTask -> Request ModifyReplicationTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyReplicationTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyReplicationTask))) #
Generic ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Associated Types type Rep ModifyReplicationTask :: Type -> Type # Methods from :: ModifyReplicationTask -> Rep ModifyReplicationTask x # to :: Rep ModifyReplicationTask x -> ModifyReplicationTask #
Read ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods readsPrec :: Int -> ReadS ModifyReplicationTask # readList :: ReadS [ModifyReplicationTask] # readPrec :: ReadPrec ModifyReplicationTask # readListPrec :: ReadPrec [ModifyReplicationTask] #
Show ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods showsPrec :: Int -> ModifyReplicationTask -> ShowS # show :: ModifyReplicationTask -> String # showList :: [ModifyReplicationTask] -> ShowS #
NFData ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods rnf :: ModifyReplicationTask -> () #
Eq ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods (==) :: ModifyReplicationTask -> ModifyReplicationTask -> Bool # (/=) :: ModifyReplicationTask -> ModifyReplicationTask -> Bool #
Hashable ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods hashWithSalt :: Int -> ModifyReplicationTask -> Int # hash :: ModifyReplicationTask -> Int #
type AWSResponse ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask type AWSResponse ModifyReplicationTask = ModifyReplicationTaskResponse
type Rep ModifyReplicationTask Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask type Rep ModifyReplicationTask = D1 ('MetaData "ModifyReplicationTask" "Amazonka.DMS.ModifyReplicationTask" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "ModifyReplicationTask'" '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 "migrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationTypeValue)))) :: ((S1 ('MetaSel ('Just "replicationTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationTaskSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tableMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "taskData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyReplicationTask Source #

Arguments

:: Text	`ModifyReplicationTask`
-> ModifyReplicationTask

Create a value of ModifyReplicationTask 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:

ModifyReplicationTask, modifyReplicationTask_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:ModifyReplicationTask', modifyReplicationTask_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”

ModifyReplicationTask, modifyReplicationTask_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 “

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

ModifyReplicationTask, modifyReplicationTask_replicationTaskIdentifier - The replication task identifier.

Constraints:

Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

ModifyReplicationTask, modifyReplicationTask_replicationTaskSettings - JSON file that contains settings for the task, such as task metadata settings.

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

ModifyReplicationTask, modifyReplicationTask_taskData - Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

ModifyReplicationTask, modifyReplicationTask_replicationTaskArn - The Amazon Resource Name (ARN) of the replication task.

Request Lenses

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

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

modifyReplicationTask_cdcStopPosition :: Lens' ModifyReplicationTask (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 “

modifyReplicationTask_migrationType :: Lens' ModifyReplicationTask (Maybe MigrationTypeValue) Source #

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

modifyReplicationTask_replicationTaskIdentifier :: Lens' ModifyReplicationTask (Maybe Text) Source #

The replication task identifier.

Constraints:

Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

modifyReplicationTask_replicationTaskSettings :: Lens' ModifyReplicationTask (Maybe Text) Source #

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

modifyReplicationTask_tableMappings :: Lens' ModifyReplicationTask (Maybe Text) Source #

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

modifyReplicationTask_taskData :: Lens' ModifyReplicationTask (Maybe Text) Source #

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

modifyReplicationTask_replicationTaskArn :: Lens' ModifyReplicationTask Text Source #

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

Destructuring the Response

data ModifyReplicationTaskResponse Source #

See: newModifyReplicationTaskResponse smart constructor.

Constructors

ModifyReplicationTaskResponse'
Fields replicationTask :: Maybe ReplicationTask The replication task that was modified. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Associated Types type Rep ModifyReplicationTaskResponse :: Type -> Type # Methods from :: ModifyReplicationTaskResponse -> Rep ModifyReplicationTaskResponse x # to :: Rep ModifyReplicationTaskResponse x -> ModifyReplicationTaskResponse #
Read ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods readsPrec :: Int -> ReadS ModifyReplicationTaskResponse # readList :: ReadS [ModifyReplicationTaskResponse] # readPrec :: ReadPrec ModifyReplicationTaskResponse # readListPrec :: ReadPrec [ModifyReplicationTaskResponse] #
Show ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods showsPrec :: Int -> ModifyReplicationTaskResponse -> ShowS # show :: ModifyReplicationTaskResponse -> String # showList :: [ModifyReplicationTaskResponse] -> ShowS #
NFData ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods rnf :: ModifyReplicationTaskResponse -> () #
Eq ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask Methods (==) :: ModifyReplicationTaskResponse -> ModifyReplicationTaskResponse -> Bool # (/=) :: ModifyReplicationTaskResponse -> ModifyReplicationTaskResponse -> Bool #
type Rep ModifyReplicationTaskResponse Source #
Instance details Defined in Amazonka.DMS.ModifyReplicationTask type Rep ModifyReplicationTaskResponse = D1 ('MetaData "ModifyReplicationTaskResponse" "Amazonka.DMS.ModifyReplicationTask" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "ModifyReplicationTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationTask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationTask)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyReplicationTaskResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyReplicationTaskResponse'`
-> ModifyReplicationTaskResponse

Create a value of ModifyReplicationTaskResponse 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:ModifyReplicationTaskResponse', modifyReplicationTaskResponse_replicationTask - The replication task that was modified.

$sel:httpStatus:ModifyReplicationTaskResponse', modifyReplicationTaskResponse_httpStatus - The response's http status code.

Response Lenses

modifyReplicationTaskResponse_replicationTask :: Lens' ModifyReplicationTaskResponse (Maybe ReplicationTask) Source #

The replication task that was modified.

modifyReplicationTaskResponse_httpStatus :: Lens' ModifyReplicationTaskResponse Int Source #

The response's http status code.