modify-replication-task

Описание

Изменяет указанную задачу репликации.

Вы не можете изменить конечные точки задачи. Задача должна быть остановлена перед её изменением.

Дополнительную информацию о задачах DMS см. в руководстве пользователя службы миграции баз данных AWS Работа с задачами миграции.

См. также: Документация API AWS

Синтаксис

  modify-replication-task
--replication-task-arn <value>
[--replication-task-identifier <value>]
[--migration-type <value>]
[--table-mappings <value>]
[--replication-task-settings <value>]
[--cdc-start-time <value>]
[--cdc-start-position <value>]
[--cdc-stop-position <value>]
[--task-data <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--replication-task-arn (строка)

Amazon Resource Name (ARN) задачи репликации.

--replication-task-identifier (строка)

Идентификатор задачи репликации.

Ограничения:

Должен содержать 1-255 буквенно-цифровых символов или дефисов.
Первый символ должен быть буквой.
Не может заканчиваться дефисом или содержать два дефиса подряд.

--migration-type (строка)

Тип миграции. Допустимые значения: full-load | cdc | full-load-and-cdc

Возможные значения:

full-load
cdc
full-load-and-cdc

--table-mappings (строка)

При использовании командной строки или boto3 укажите путь к файлу JSON, содержащему сопоставления таблиц. Префикс пути file:// . Например, --table-mappings file://mappingfile.json . При работе с API DMS укажите JSON в качестве значения параметра.

--replication-task-settings (строка)

Файл JSON, содержащий параметры для задачи, такие как параметры метаданных задачи.

--cdc-start-time (временная метка)

Указывает начальное время для операции захвата изменений данных (CDC). Используйте либо CdcStartTime, либо CdcStartPosition, чтобы указать время начала операции CDC. Указание обоих значений приводит к ошибке.

Пример временной метки: –cdc-start-time “2018-03-08T12:12:12”

--cdc-start-position (строка)

Указывает время начала операции захвата изменений данных (CDC). Используйте либо CdcStartPosition, либо CdcStartTime, чтобы указать время начала операции CDC. Указание обоих значений приводит к ошибке.

Значение может быть в формате даты, контрольной точки или LSN/SCN.

Пример даты: –cdc-start-position “2018-03-08T12:12:12”

Пример контрольной точки: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

Пример LSN: –cdc-start-position “mysql-bin-changelog.000024:373”

Примечание

При использовании этого параметра с источником PostgreSQL база данных должна быть создана репликация и связана с целевым конечным пунктом. Вы можете проверить это, установив дополнительный атрибут подключения slotName к имени этой логической репликации. Дополнительную информацию см. в статье Дополнительные атрибуты подключения при использовании PostgreSQL в качестве источника DMS.

--cdc-stop-position (строка)

Указывает время окончания операции захвата изменений данных (CDC). Значение может быть временем сервера или временем фиксации.

Пример времени сервера: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Пример времени фиксации: –cdc-stop-position “commit_time:2018-02-09T12:12:12“

--task-data (строка)

Дополнительная информация, необходимая задаче для миграции данных для определённых конечных точек источника и цели. Дополнительную информацию см. в руководстве пользователя службы миграции баз данных AWS Указание дополнительных данных для параметров задачи.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включает отладку регистрации.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с службами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.

--no-paginate (булево)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Используйте конкретный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

Включает/отключает цветной вывод.

включено
выключено
автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет времени ожидания. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет времени ожидания. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использоваться содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключает вывод постраничного переключения для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Изменение задачи репликации

Следующий modify-replication-task пример изменяет сопоставления таблиц для задачи.

aws dms modify-replication-task \
    --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \
    --table-mappings file://table-mappings.json

Содержимое table-mappings.json:

{
    "rules": [
        {
            "rule-type": "selection",
            "rule-id": "1",
            "rule-name": "1",
            "object-locator": {
                "schema-name": "prodrep",
                "table-name": "ACCT_%"
            },
            "rule-action": "include",
            "filters": []
        }
    ]
}

Вывод:

{
    "ReplicationTask": {
        "ReplicationTaskIdentifier": "moveit2",
        "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
        "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
        "MigrationType": "full-load",
        "TableMappings": ...output omitted...,
        "ReplicationTaskSettings": ...output omitted...,
        "Status": "modifying",
        "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
        "ReplicationTaskCreationDate": 1590524772.505,
        "ReplicationTaskStartDate": 1590789424.653,
        "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
    }
}

Дополнительную информацию см. в руководстве пользователя службы AWS DMS Работа с задачами AWS DMS.

Вывод

ReplicationTask -> (структура)

Изменённая задача репликации.

ReplicationTaskIdentifier -> (строка)

Идентификатор или имя задачи репликации, назначенные пользователем.

Ограничения:

Должно содержать от 1 до 255 буквенно-цифровых символов или дефисов.
Первый символ должен быть буквой.
Не должно оканчиваться на дефис или содержать два дефиса подряд.

SourceEndpointArn -> (строка)

Уникальный Amazon Resource Name (ARN) конечной точки.

TargetEndpointArn -> (строка)

ARN, уникально идентифицирующий конечную точку.

ReplicationInstanceArn -> (строка)

ARN экземпляра репликации.

MigrationType -> (строка)

Тип миграции.

TableMappings -> (строка)

Определения сопоставлений таблиц в задаче.

ReplicationTaskSettings -> (строка)

Настройки задачи репликации.

Status -> (строка)

Статус задачи репликации. Этот параметр ответа может возвращать одно из следующих значений:

"moving" – Задача перемещается в ответ на выполнение операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__.
"creating" – Задача создаётся в ответ на выполнение операции ` CreateReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html`__.
"deleting" – Задача удаляется в ответ на выполнение операции ` DeleteReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__.
"failed" – Задача не смогла успешно завершить миграцию базы данных в ответ на выполнение операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"failed-move" – Задача не смогла переместиться в ответ на выполнение операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__.
"modifying" – Определения задачи изменяются в ответ на выполнение операции ` ModifyReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html`__.
"ready" – Задача находится в состоянии ready, позволяющем отвечать на другие операции над задачами, такие как ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ или ` DeleteReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__.
"running" – Задача выполняет миграцию базы данных в ответ на выполнение операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"starting" – Задача готовится к выполнению миграции базы данных в ответ на выполнение операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"stopped" – Задача остановлена в ответ на выполнение операции ` StopReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__.
"stopping" – Задача готовится к остановке в ответ на выполнение операции ` StopReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__.
"testing" – Миграция базы данных для этой задачи тестируется в ответ на выполнение операции ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ или ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__.

Примечание

` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ — это улучшенная операция предварительной оценки задачи миграции. Операция ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ оценивает только совместимость типов данных между исходной и целевой базами данных заданной задачи миграции. В отличие от этого, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ позволяет указать различные предварительные оценки задач миграции, помимо совместимости типов данных. Эти оценки включают проверку валидности определений первичных ключей и вероятных проблем с производительностью миграции базы данных.

LastFailureMessage -> (строка)

Последнее сообщение об ошибке (остановке) для задачи репликации.

StopReason -> (строка)

Причина остановки задачи репликации. Этот параметр ответа может возвращать одно из следующих значений:

"Stop Reason NORMAL" – Задача завершена успешно без дополнительной информации.
"Stop Reason RECOVERABLE_ERROR"
"Stop Reason FATAL_ERROR"
"Stop Reason FULL_LOAD_ONLY_FINISHED" – Задача завершила этап полной загрузки. DMS применила кэшированные изменения, если вы установили StopTaskCachedChangesApplied в true.
"Stop Reason STOPPED_AFTER_FULL_LOAD" – Полная загрузка завершена, с кэшированными изменениями не применёнными
"Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Полная загрузка завершена, с кэшированными изменениями применёнными
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
"Stop Reason STOPPED_AFTER_DDL_APPLY" – Пользовательская остановка задачи после применения DDL
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
"Stop Reason STOPPED_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – Пользовательское время сервера для остановки задачи
"Stop Reason STOPPED_AT_COMMIT_TIME" – Пользовательское время коммита для остановки задачи
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"

ReplicationTaskCreationDate -> (метка времени)

Дата создания задачи репликации.

ReplicationTaskStartDate -> (метка времени)

Дата начала планируемого запуска задачи репликации.

CdcStartPosition -> (строка)

Указывает, когда должна начаться операция захвата изменений (CDC). Используйте либо CdcStartPosition, либо CdcStartTime для указания момента начала операции CDC. Указание обоих значений приведёт к ошибке.

Значение может быть в формате даты, контрольной точки или LSN/SCN.

Пример даты: –cdc-start-position “2018-03-08T12:12:12”

Пример контрольной точки: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

Пример LSN: –cdc-start-position “mysql-bin-changelog.000024:373”

CdcStopPosition -> (строка)

Указывает, когда должна завершиться операция захвата изменений (CDC). Значение может быть временем сервера или временем коммита.

Пример времени сервера: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Пример времени коммита: –cdc-stop-position “commit_time:2018-02-09T12:12:12“

RecoveryCheckpoint -> (строка)

Указывает последнюю контрольную точку, выполненную во время операции захвата изменений (CDC). Вы можете использовать это значение в параметре CdcStartPosition, чтобы запустить операцию CDC, начинающуюся с этой контрольной точки.

ReplicationTaskArn -> (строка)

Amazon Resource Name (ARN) задачи репликации.

ReplicationTaskStats -> (структура)

Статистика задачи, включая затраченное время, загруженные таблицы и ошибки в таблицах.

FullLoadProgressPercent -> (целое число)

Процент выполнения задачи полной загрузки миграции.

ElapsedTimeMillis -> (длинное целое число)

Затраченное время задачи в миллисекундах.

TablesLoaded -> (целое число)

Количество загруженных таблиц для данной задачи.

TablesLoading -> (целое число)

Количество таблиц, загружаемых в данный момент для данной задачи.

TablesQueued -> (целое число)

Количество таблиц, ожидающих обработки в этой задаче.

TablesErrored -> (целое число)

Количество ошибок, произошедших во время данной задачи.

FreshStartDate -> (метка времени)

Дата запуска задачи репликации с новым началом или перегрузкой целевого источника.

StartDate -> (метка времени)

Дата запуска задачи репликации с новым началом или возобновлением. Для получения дополнительной информации см. StartReplicationTaskType.

StopDate -> (метка времени)

Дата остановки задачи репликации.

FullLoadStartDate -> (метка времени)

Дата начала полной загрузки задачи репликации.

FullLoadFinishDate -> (метка времени)

Дата завершения полной загрузки задачи репликации.

TaskData -> (строка)

Дополнительная информация, необходимая задаче для миграции данных для определённых конечных точек источника и цели. Для получения дополнительной информации см. Указание дополнительных данных для настроек задачи в руководстве пользователя Database Migration Service.

TargetReplicationInstanceArn -> (строка)

ARN экземпляра репликации назначения, куда перемещена эта задача в ответ на выполнение операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ операции. В противном случае этот параметр ответа не является членом объекта ReplicationTask.