создание-точкi-подключенiя

Описание

Создаёт точку подключения с указанными параметрами.

Примечание

Для точки подключения источника или целевого MySQL не указывайте явно базу данных с помощью параметра запроса DatabaseName на вызове API CreateEndpoint. Указание DatabaseName при создании точки подключения MySQL дублирует все таблицы задания в эту единственную базу данных. Для точек подключения MySQL базу данных указывают только при указании схемы в правилах сопоставления таблиц задания DMS.

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

Синтаксис

  create-endpoint
--endpoint-identifier <value>
--endpoint-type <value>
--engine-name <value>
[--username <value>]
[--password <value>]
[--server-name <value>]
[--port <value>]
[--database-name <value>]
[--extra-connection-attributes <value>]
[--kms-key-id <value>]
[--tags <value>]
[--certificate-arn <value>]
[--ssl-mode <value>]
[--service-access-role-arn <value>]
[--external-table-definition <value>]
[--dynamo-db-settings <value>]
[--s3-settings <value>]
[--dms-transfer-settings <value>]
[--mongo-db-settings <value>]
[--kinesis-settings <value>]
[--kafka-settings <value>]
[--elasticsearch-settings <value>]
[--neptune-settings <value>]
[--redshift-settings <value>]
[--postgre-sql-settings <value>]
[--my-sql-settings <value>]
[--oracle-settings <value>]
[--sybase-settings <value>]
[--microsoft-sql-server-settings <value>]
[--ibm-db2-settings <value>]
[--resource-identifier <value>]
[--doc-db-settings <value>]
[--redis-settings <value>]
[--gcp-my-sql-settings <value>]
[--timestream-settings <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]

Параметры

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

Идентификатор точки подключения к базе данных. Идентификаторы должны начинаться с буквы и содержать только ASCII-буквы, цифры и дефисы. Они не могут оканчиваться на дефис или содержать два дефиса подряд.

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

Тип точки подключения. Допустимые значения — source и target.

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

source
target

--engine-name (строка)

Тип движка для точки подключения. Допустимые значения, в зависимости от значения EndpointType, включают "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", "babelfish", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.

--username (строка)

Имя пользователя для входа в базу данных точки подключения.

--password (строка)

Пароль для входа в базу данных точки подключения.

--server-name (строка)

Имя сервера, на котором находится база данных точки подключения.

--port (целое число)

Порт, используемый базой данных точки подключения.

--database-name (строка)

Имя базы данных точки подключения. Для точки подключения источника или целевого MySQL не указывайте DatabaseName. Для миграции в определённую базу данных используйте это значение и targetDbType.

--extra-connection-attributes (строка)

Дополнительные атрибуты, связанные с подключением. Каждый атрибут задаётся как имя-значение, разделённые знаком равенства (=). Несколько атрибутов разделяются точкой с запятой (;), без дополнительных пробелов. Сведения об атрибутах, доступных для подключения точки подключения источника или целевого объекта, см. в руководстве по работе с точками подключения DMS.

--kms-key-id (строка)

Идентификатор ключа KMS, используемый для шифрования параметров подключения для точки подключения.

Если вы не укажете значение для параметра KmsKeyId, DMS будет использовать ваш ключ шифрования по умолчанию.

KMS создаёт ключ шифрования по умолчанию для вашей учётной записи Amazon Web Services. У каждой учётной записи Amazon Web Services есть другой ключ шифрования по умолчанию для каждой области Amazon Web Services.

--tags (список)

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

(структура)

Пользовательская пара ключ-значение, описывающая метаданные, добавленные к ресурсу DMS, и используемые в операциях, таких как:

AddTagsToResource
ListTagsForResource
RemoveTagsFromResource

Ключ -> (строка)

Ключ — это необходимое имя тега. Строковое значение может содержать от 1 до 128 символов Юникода и не может начинаться с «aws:» или «dms:». Строка может содержать только набор букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (регулярные выражения Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

Значение -> (строка)

Значение — это необязательное значение тега. Строковое значение может содержать от 1 до 256 символов Юникода и не может начинаться с «aws:» или «dms:». Строка может содержать только набор букв, цифр, пробелов, «_», «.», «/», «=», «+», «-» (регулярные выражения Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

ResourceArn -> (строка)

Строка Amazon Resource Name (ARN), которая однозначно идентифицирует ресурс, для которого создан тег.

Сокращённый синтаксис:

Key=string,Value=string,ResourceArn=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "ResourceArn": "string"
  }
  ...
]

--certificate-arn (строка)

Amazon Resource Name (ARN) сертификата.

--ssl-mode (строка)

Режим Secure Sockets Layer (SSL) для использования при подключении SSL. По умолчанию — none.

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

none
require
verify-ca
verify-full

--service-access-role-arn (строка)

Amazon Resource Name (ARN) роли доступа к сервису, которую нужно использовать для создания точки подключения. Роль должна разрешать действие iam:PassRole.

--external-table-definition (строка)

Определение внешней таблицы.

--dynamo-db-settings (структура)

Настройки в формате JSON для целевой точки подключения Amazon DynamoDB. Сведения об остальных доступных настройках см. в руководстве по работе с DMS.

ServiceAccessRoleArn -> (строка)

Amazon Resource Name (ARN), используемый сервисом для доступа к роли IAM. Роль должна разрешать действие iam:PassRole.

Сокращённый синтаксис:

ServiceAccessRoleArn=string

Синтаксис JSON:

{
  "ServiceAccessRoleArn": "string"
}

--s3-settings (структура)

Настройки в формате JSON для целевого конечного пункта Amazon S3. Дополнительную информацию о доступных настройках см. в руководстве пользователя Database Migration Service в разделе «Дополнительные атрибуты подключения при использовании Amazon S3 в качестве целевого объекта».

ServiceAccessRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN), используемый службой для доступа к роли IAM. Роль должна разрешать действие iam:PassRole. Это обязательный параметр, который позволяет DMS записывать и читать объекты из ведра S3.

ExternalTableDefinition -> (строка)

Определяет, как таблицы определяются только в исходных файлах S3.

CsvRowDelimiter -> (строка)

Разделитель, используемый для разделения строк в файле .csv как для источника, так и для целевого объекта. По умолчанию используется возврат каретки (\n).

CsvDelimiter -> (строка)

Разделитель, используемый для разделения столбцов в файле .csv как для источника, так и для целевого объекта. По умолчанию используется запятая.

BucketFolder -> (строка)

Необязательный параметр для задания имени папки в ведре S3. Если указан, таблицы создаются по пути `` bucketFolder /schema_name /table_name /`` . Если этот параметр не указан, используется путь `` schema_name /table_name /`` .

BucketName -> (строка)

Имя ведра S3.

CompressionType -> (строка)

Необязательный параметр для сжатия целевых файлов с помощью GZIP. Установите значение GZIP для сжатия целевых файлов. Установите этот параметр в значение NONE (по умолчанию) или не используйте его, чтобы оставить файлы несжатыми. Этот параметр применяется к форматам файлов .csv и .parquet.

EncryptionMode -> (строка)

Тип шифрования на стороне сервера, который вы хотите использовать для своих данных. Этот тип шифрования является частью настроек конечного пункта или дополнительных атрибутов подключения для Amazon S3. Вы можете выбрать либо SSE_S3 (по умолчанию), либо SSE_KMS .

Примечание

Для операции ModifyEndpoint вы можете изменить существующее значение параметра EncryptionMode со значения SSE_KMS на SSE_S3 . Но вы не можете изменить существующее значение с SSE_S3 на SSE_KMS .

Для использования SSE_S3 вам нужна роль Identity and Access Management (IAM) с разрешением на использование "arn:aws:s3:::dms-*" следующих действий:

s3:CreateBucket
s3:ListBucket
s3:DeleteBucket
s3:GetBucketLocation
s3:GetObject
s3:PutObject
s3:DeleteObject
s3:GetObjectVersion
s3:GetBucketPolicy
s3:PutBucketPolicy
s3:DeleteBucketPolicy

ServerSideEncryptionKmsKeyId -> (строка)

Если вы используете SSE_KMS для EncryptionMode , укажите идентификатор ключа KMS. Используемый ключ должен иметь прикрепленную политику, которая разрешает права пользователей Identity and Access Management (IAM) и позволяет использовать ключ.

Вот пример использования CLI: ``aws dms create-endpoint –endpoint-identifier value –endpoint-type target –engine-name s3 –s3-settings ServiceAccessRoleArn=*value* ,BucketFolder=*value* ,BucketName=*value* ,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=*value* ``

DataFormat -> (строка)

Формат данных, который вы хотите использовать для вывода. Вы можете выбрать один из следующих:

csv : Этот формат файла на основе строк со значениями, разделенными запятыми (.csv).
parquet : Apache Parquet (.parquet) — это столбцовый формат файлов хранения, который обеспечивает эффективное сжатие и ускоряет ответы на запросы.

EncodingType -> (строка)

Тип используемого кодирования:

RLE_DICTIONARY использует сочетание bit-packing и run-length encoding для более эффективного хранения повторяющихся значений. Это значение по умолчанию.
PLAIN вообще не использует кодирование. Значения хранятся так, как есть.
PLAIN_DICTIONARY создаёт словарь встреченных значений в определённом столбце. Словарь хранится в странице словаря для каждого блока столбца.

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

Максимальный размер страницы закодированного словаря столбца. Если страница словаря превышает это значение, этот столбец хранится с типом кодирования PLAIN . Этот параметр по умолчанию равен 1024 * 1024 байтам (1 МБ), максимальному размеру страницы словаря, прежде чем он вернётся к кодированию PLAIN . Это значение используется только для формата файлов .parquet.

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

Количество строк в группе строк. Более короткий размер группы строк обеспечивает более быстрый доступ к данным. Но с увеличением числа групп строк увеличиваются задержки при записи. По умолчанию этот параметр равен 10 000 строк. Это значение используется только для формата файлов .parquet.

Если вы выберете значение, большее, чем максимальное, RowGroupLength устанавливается в максимальную длину группы строк в байтах (64 * 1024 * 1024).

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

Размер одной страницы данных в байтах. По умолчанию этот параметр равен 1024 * 1024 байтам (1 МБ). Это значение используется только для формата файлов .parquet.

ParquetVersion -> (строка)

Версия формата Apache Parquet, которую вы хотите использовать: parquet_1_0 (по умолчанию) или parquet_2_0 .

EnableStatistics -> (булево)

Значение, которое включает статистику для страниц Parquet и групп строк. Выберите true для включения статистики, false для отключения. Статистика включает значения NULL , DISTINCT , MAX и MIN . По умолчанию true . Это значение используется только для формата файлов .parquet.

IncludeOpForFullLoad -> (булево)

Значение, которое включает полную загрузку для записи операций INSERT в файлы с разделителями запятыми (.csv) или .parquet, чтобы указать, как строки были добавлены в базу данных источника.

Примечание

DMS поддерживает параметр IncludeOpForFullLoad в версиях 3.1.4 и выше.

DMS поддерживает использование файлов .parquet с параметром IncludeOpForFullLoad в версиях 3.4.7 и выше.

Для полной загрузки записи могут быть только вставлены. По умолчанию (настройка false) никакая информация не записывается в эти выходные файлы для полной загрузки, чтобы указать, что строки были вставлены в базу данных источника. Если IncludeOpForFullLoad установлено в true или y , INSERT записывается как аннотация I в первом поле файла .csv. Это позволяет сделать формат целевых записей из полной загрузки согласованным с целевыми записями из загрузки CDC.

Примечание

Эта настройка работает вместе с параметрами CdcInsertsOnly и CdcInsertsAndUpdates для вывода в файлы .csv. Дополнительную информацию о совместной работе этих настроек см. в руководстве пользователя Database Migration Service в разделе «Указание операций базы данных источника в мигрированных данных S3».

CdcInsertsOnly -> (булево)

Значение, которое включает загрузку с изменением данных (CDC) для записи только операций INSERT в выходные файлы .csv или столбцового хранения (.parquet). По умолчанию (настройка false) первое поле в записи .csv или .parquet содержит букву I (INSERT), U (UPDATE) или D (DELETE). Эти значения указывают, была ли строка вставлена, обновлена или удалена в базе данных источника при загрузке CDC в целевой объект.

Если CdcInsertsOnly установлено в true или y , только INSERTы из базы данных источника мигрируются в файл .csv или .parquet. Только для формата .csv способ записи этих INSERTов зависит от значения IncludeOpForFullLoad . Если IncludeOpForFullLoad установлено в true , первое поле каждой записи CDC устанавливается в I, чтобы указать операцию INSERT в источнике. Если IncludeOpForFullLoad установлено в false , каждая запись CDC записывается без первого поля для указания операции INSERT в источнике. Дополнительную информацию о совместной работе этих настроек см. в руководстве пользователя Database Migration Service в разделе «Указание операций базы данных источника в мигрированных данных S3».

Примечание

DMS поддерживает взаимодействие, описанное выше, между параметрами CdcInsertsOnly и IncludeOpForFullLoad в версиях 3.1.4 и выше.

CdcInsertsOnly и CdcInsertsAndUpdates не могут быть одновременно установлены в true для одного конечного пункта. Установите либо CdcInsertsOnly, либо CdcInsertsAndUpdates в true для одного конечного пункта, но не оба.

TimestampColumnName -> (строка)

Значение, которое, если оно не пустое, заставляет DMS добавлять столбец со временем в данные конечного пункта для целевого объекта Amazon S3.

Примечание

DMS поддерживает параметр TimestampColumnName в версиях 3.1.4 и выше.

DMS включает дополнительный столбец STRING в файлы .csv или .parquet ваших мигрированных данных, когда вы устанавливаете TimestampColumnName в непустое значение.

При полной загрузке каждая строка этого столбца времени содержит метку времени, когда данные были перенесены из источника в целевой объект DMS.

При загрузке с изменением данных (CDC) каждая строка столбца времени содержит метку времени подтверждения этой строки в базе данных источника.

Формат строки для этого значения столбца времени — yyyy-MM-dd HH:mm:ss.SSSSSS . По умолчанию точность этого значения — микросекунды. При загрузке CDC округление точности зависит от времени подтверждения, поддерживаемого DMS для базы данных источника.

Когда параметр AddColumnName установлен в true , DMS также включает имя для столбца времени, которое вы устанавливаете с помощью TimestampColumnName .

ParquetTimestampInMillisecond -> (булево)

Значение, определяющее точность значений столбцов TIMESTAMP, записываемых в файл объекта Amazon S3 в формате .parquet.

Примечание

DMS поддерживает параметр ParquetTimestampInMillisecond в версиях 3.1.4 и выше.

Когда ParquetTimestampInMillisecond установлено в значение true или y, DMS записывает все столбцы TIMESTAMP в файл формата .parquet с миллисекундной точностью. В противном случае DMS записывает их с микросекундной точностью.

В настоящее время Amazon Athena и Glue могут обрабатывать только миллисекундную точность для значений TIMESTAMP. Установите этот параметр в значение true для файлов объектов конечной точки S3 в формате .parquet только в том случае, если планируется запросить или обработать данные с помощью Athena или Glue.

Примечание

DMS записывает значения любого столбца TIMESTAMP, записанные в файл S3 в формате .csv, с микросекундной точностью.

Установка значения ParquetTimestampInMillisecond не влияет на строковый формат значения столбца временной метки, вставленного при установке параметра TimestampColumnName.

CdcInsertsAndUpdates -> (boolean)

Значение, которое позволяет загрузке захвата изменений данных (CDC) записывать операции INSERT и UPDATE в выходные файлы .csv или .parquet (колоночный хранилище). Значение по умолчанию — false, но когда CdcInsertsAndUpdates установлено в значение true или y, только INSERTы и UPDATEы из источника базы данных мигрируются в файл .csv или .parquet.

Предупреждение

DMS поддерживает использование файлов .parquet в версиях 3.4.7 и выше.

Способ записи этих INSERT и UPDATE зависит от значения параметра IncludeOpForFullLoad. Если IncludeOpForFullLoad установлено в значение true, первый поле каждого записи CDC устанавливается либо в I, либо в U, чтобы указать операции INSERT и UPDATE в источнике. Но если IncludeOpForFullLoad установлено в значение false, записи CDC записываются без указания операций INSERT или UPDATE в источнике. Для получения дополнительной информации о том, как эти параметры работают вместе, см. Указание операций БД источника в мигрированных данных S3 в руководстве пользователя Database Migration Service.

Примечание

DMS поддерживает использование параметра CdcInsertsAndUpdates в версиях 3.3.1 и выше.

CdcInsertsOnly и CdcInsertsAndUpdates не могут быть одновременно установлены в значение true для одной и той же конечной точки. Установите либо CdcInsertsOnly, либо CdcInsertsAndUpdates в значение true для одной и той же конечной точки, но не оба.

DatePartitionEnabled -> (boolean)

При установке в значение true этот параметр разделяет папки ведра S3 на основе дат подтверждения транзакций. Значение по умолчанию — false. Дополнительную информацию о разделении папок по дате см. в разделе Использование разделения папок по дате.

DatePartitionSequence -> (string)

Определяет последовательность формата даты для использования при разделении папок. Значение по умолчанию — YYYYMMDD. Используйте этот параметр, когда DatePartitionedEnabled установлено в значение true.

DatePartitionDelimiter -> (string)

Указывает разделитель даты для разделения папок. Значение по умолчанию — SLASH. Используйте этот параметр, когда DatePartitionedEnabled установлено в значение true.

UseCsvNoSupValue -> (boolean)

Это значение применяется, если выходные файлы S3 при загрузке захвата изменений данных (CDC) записываются в формате .csv. Если установлено в значение true для столбцов, не включенных в дополнительный журнал, DMS использует значение, указанное в ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__. Если не установлено или установлено в значение false, DMS использует значение NULL для этих столбцов.

Примечание

Это значение поддерживается в версиях DMS 3.4.1 и выше.

CsvNoSupValue -> (string)

Это значение применяется только в том случае, если выходные файлы Amazon S3 при загрузке захвата изменений данных (CDC) записываются в формате .csv. Если ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ установлено в значение true, укажите строковое значение, которое DMS должен использовать для всех столбцов, не включенных в дополнительный журнал. Если вы не укажете строковое значение, DMS использует значение NULL для этих столбцов независимо от параметра UseCsvNoSupValue.

Примечание

Это значение поддерживается в версиях DMS 3.4.1 и выше.

PreserveTransactions -> (boolean)

Если установлено в значение true, DMS сохраняет порядок транзакций для загрузки захвата изменений данных (CDC) на целевом Amazon S3, указанном параметром ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__. Дополнительную информацию см. в разделе Захват изменений данных (CDC), включая порядок транзакций, на целевом S3.

Примечание

Это значение поддерживается в версиях DMS 3.4.2 и выше.

CdcPath -> (string)

Указывает путь к папке файлов CDC. Для источника S3 этот параметр обязателен, если задача захватывает данные изменений, в противном случае он необязателен. Если CdcPath задан, DMS считывает файлы CDC из этого пути и реплицирует изменения данных в целевую конечную точку. Для целевого S3, если вы установите ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ в значение true, DMS проверяет, что вы установили этот параметр в путь к папке на вашем целевом S3, где DMS может сохранить порядок транзакций для загрузки CDC. DMS создает этот путь к папке CDC либо в вашей рабочей директории S3-цели, либо в местоположении S3-цели, заданном параметрами ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ и ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__.

Например, если вы укажете CdcPath как MyChangedData, и вы укажете BucketName как MyTargetBucket, но не укажете BucketFolder, DMS создаст путь к папке CDC, следуя: MyTargetBucket/MyChangedData.

Если вы укажете тот же CdcPath, и вы укажете BucketName как MyTargetBucket и BucketFolder как MyTargetData, DMS создаст путь к папке CDC, следуя: MyTargetBucket/MyTargetData/MyChangedData.

Дополнительную информацию о CDC, включая порядок транзакций на целевом S3, см. в разделе Захват изменений данных (CDC), включая порядок транзакций, на целевом S3.

Примечание

Это значение поддерживается в версиях DMS 3.4.2 и выше.

UseTaskStartTimeForFullLoadTimestamp -> (boolean)

При установке в значение true этот параметр использует время запуска задачи как значение столбца временной метки вместо времени записи данных на целевой объект. Для полной загрузки, когда useTaskStartTimeForFullLoadTimestamp установлено в значение true, каждая строка столбца временной метки содержит время запуска задачи. Для загрузок CDC каждая строка столбца временной метки содержит время подтверждения транзакции.

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

CannedAclForObjects -> (string)

Значение, позволяющее DMS указать предварительно определенный (канный) список управления доступом для объектов, созданных в ведре Amazon S3, в виде файлов .csv или .parquet. Дополнительную информацию о кэннированных ACL Amazon S3 см. в разделе Canned ACL в Руководстве разработчика Amazon S3.

Значение по умолчанию — NONE. Допустимые значения включают NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ и BUCKET_OWNER_FULL_CONTROL.

AddColumnName -> (boolean)

Необязательный параметр, который при установке в значение true или y можно использовать для добавления информации о имени столбца в выходной файл .csv.

Значение по умолчанию — false. Допустимые значения — true, false, y и n.

CdcMaxBatchInterval -> (integer)

Максимальная длительность интервала в секундах, после которой выходной файл отправляется в Amazon S3.

Когда CdcMaxBatchInterval и CdcMinFileSize оба заданы, запись файла инициируется тем параметром, условие которого выполняется первым в шаблоне DMS CloudFormation.

Значение по умолчанию — 60 секунд.

CdcMinFileSize -> (integer)

Минимальный размер файла в килобайтах, который должен быть достигнут для выходного файла в Amazon S3.

Когда CdcMinFileSize и CdcMaxBatchInterval оба заданы, запись файла инициируется тем параметром, условие которого выполняется первым в шаблоне DMS CloudFormation.

Значение по умолчанию — 32 МБ.

CsvNullValue -> (string)

Необязательный параметр, определяющий, как DMS обрабатывает значения NULL. При обработке значения NULL вы можете использовать этот параметр, чтобы передать строку, определенную пользователем, как NULL при записи в целевой объект. Например, когда целевые столбцы могут иметь значение NULL, вы можете использовать этот параметр для различения значения пустой строки и значения NULL. Таким образом, если вы установите это значение параметра в пустую строку ("" или ''), DMS будет рассматривать пустую строку как значение NULL вместо NULL.

Значение по умолчанию — NULL. Допустимые значения — любые допустимые строки.

IgnoreHeaderRows -> (integer)

Если это значение установлено в 1, DMS игнорирует заголовок первой строки в файле .csv. Значение 1 включает функцию, а 0 — отключает.

Значение по умолчанию — 0.

MaxFileSize -> (integer)

Значение, определяющее максимальный размер (в КБ) любого файла .csv, который будет создан при миграции на целевой S3 при полной загрузке.

Значение по умолчанию — 1 048 576 КБ (1 ГБ). Допустимые значения — от 1 до 1 048 576.

Rfc4180 -> (boolean)

Для источника S3, когда это значение установлено в true или y, каждый ведущий двойной кавычка должен быть последован закрывающей двойной кавычкой. Этот формат соответствует RFC 4180. Когда это значение установлено в false или n, строковые литералы копируются в целевой объект как есть. В этом случае разделитель (строка или столбец) сигнализирует об окончании поля. Таким образом, вы не можете использовать разделитель как часть строки, потому что он сигнализирует об окончании значения.

Для целевого S3, необязательный параметр, используемый для настройки поведения в соответствии с RFC 4180 для данных, мигрированных в Amazon S3 только в формате .csv. Когда это значение установлено в true или y с использованием Amazon S3 в качестве цели, если данные содержат кавычки или символы новой строки, DMS заключает весь столбец в дополнительные двойные кавычки («). Каждая кавычка внутри данных повторяется дважды.

Значение по умолчанию — true. Допустимые значения включают true, false, y и n.

DatePartitionTimezone -> (строка)

При создании целевого конечного пункта S3, установите DatePartitionTimezone для преобразования текущего времени UTC в указанную временную зону. Преобразование происходит при создании папки раздела даты и генерировании имени файла CDC. Формат временной зоны — Area/Location. Используйте этот параметр, когда DatePartitionedEnabled установлено в true, как показано в следующем примере.

s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":"*Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'

AddTrailingPaddingCharacter -> (булево)

Используйте параметр целевого конечного пункта S3 AddTrailingPaddingCharacter для добавления заполнения в строковые данные. Значение по умолчанию — false.

ExpectedBucketOwner -> (строка)

Чтобы указать владельца корзины и предотвратить «sniping», можно использовать параметр конечного пункта ExpectedBucketOwner.

Пример: --s3-settings='{"ExpectedBucketOwner": "*AWS_Account_ID* "}'

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

GlueCatalogGeneration -> (булево)

При значении true Glue может каталогизировать вашу корзину S3. Создание каталога Glue позволяет использовать Athena для запроса ваших данных.

Синтаксис в сокращенном виде:

ServiceAccessRoleArn=string,ExternalTableDefinition=string,CsvRowDelimiter=string,CsvDelimiter=string,BucketFolder=string,BucketName=string,CompressionType=string,EncryptionMode=string,ServerSideEncryptionKmsKeyId=string,DataFormat=string,EncodingType=string,DictPageSizeLimit=integer,RowGroupLength=integer,DataPageSize=integer,ParquetVersion=string,EnableStatistics=boolean,IncludeOpForFullLoad=boolean,CdcInsertsOnly=boolean,TimestampColumnName=string,ParquetTimestampInMillisecond=boolean,CdcInsertsAndUpdates=boolean,DatePartitionEnabled=boolean,DatePartitionSequence=string,DatePartitionDelimiter=string,UseCsvNoSupValue=boolean,CsvNoSupValue=string,PreserveTransactions=boolean,CdcPath=string,UseTaskStartTimeForFullLoadTimestamp=boolean,CannedAclForObjects=string,AddColumnName=boolean,CdcMaxBatchInterval=integer,CdcMinFileSize=integer,CsvNullValue=string,IgnoreHeaderRows=integer,MaxFileSize=integer,Rfc4180=boolean,DatePartitionTimezone=string,AddTrailingPaddingCharacter=boolean,ExpectedBucketOwner=string,GlueCatalogGeneration=boolean

Синтаксис JSON:

{
  "ServiceAccessRoleArn": "string",
  "ExternalTableDefinition": "string",
  "CsvRowDelimiter": "string",
  "CsvDelimiter": "string",
  "BucketFolder": "string",
  "BucketName": "string",
  "CompressionType": "none"|"gzip",
  "EncryptionMode": "sse-s3"|"sse-kms",
  "ServerSideEncryptionKmsKeyId": "string",
  "DataFormat": "csv"|"parquet",
  "EncodingType": "plain"|"plain-dictionary"|"rle-dictionary",
  "DictPageSizeLimit": integer,
  "RowGroupLength": integer,
  "DataPageSize": integer,
  "ParquetVersion": "parquet-1-0"|"parquet-2-0",
  "EnableStatistics": true|false,
  "IncludeOpForFullLoad": true|false,
  "CdcInsertsOnly": true|false,
  "TimestampColumnName": "string",
  "ParquetTimestampInMillisecond": true|false,
  "CdcInsertsAndUpdates": true|false,
  "DatePartitionEnabled": true|false,
  "DatePartitionSequence": "YYYYMMDD"|"YYYYMMDDHH"|"YYYYMM"|"MMYYYYDD"|"DDMMYYYY",
  "DatePartitionDelimiter": "SLASH"|"UNDERSCORE"|"DASH"|"NONE",
  "UseCsvNoSupValue": true|false,
  "CsvNoSupValue": "string",
  "PreserveTransactions": true|false,
  "CdcPath": "string",
  "UseTaskStartTimeForFullLoadTimestamp": true|false,
  "CannedAclForObjects": "none"|"private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control",
  "AddColumnName": true|false,
  "CdcMaxBatchInterval": integer,
  "CdcMinFileSize": integer,
  "CsvNullValue": "string",
  "IgnoreHeaderRows": integer,
  "MaxFileSize": integer,
  "Rfc4180": true|false,
  "DatePartitionTimezone": "string",
  "AddTrailingPaddingCharacter": true|false,
  "ExpectedBucketOwner": "string",
  "GlueCatalogGeneration": true|false
}

--dms-transfer-settings (структура)

Параметры в формате JSON для конечного пункта источника типа передачи DMS.

Возможные параметры включают:

ServiceAccessRoleArn — Amazon Resource Name (ARN), используемый ролью доступа к службе IAM. Роль должна разрешать действие iam:PassRole.
BucketName — Имя корзины S3 для использования.

Синтаксис в сокращенном виде для этих параметров: ServiceAccessRoleArn=string,BucketName=string

Синтаксис JSON для этих параметров: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

ServiceAccessRoleArn -> (строка)

Amazon Resource Name (ARN), используемый ролью доступа к службе IAM. Роль должна разрешать действие iam:PassRole.

BucketName -> (строка)

Имя корзины S3 для использования.

Синтаксис в сокращенном виде:

ServiceAccessRoleArn=string,BucketName=string

Синтаксис JSON:

{
  "ServiceAccessRoleArn": "string",
  "BucketName": "string"
}

--mongo-db-settings (структура)

Настройки в формате JSON для конечного пункта источника MongoDB. Дополнительную информацию о доступных настройках см. в разделе «Настройки конфигурации конечного пункта при использовании MongoDB в качестве источника для Database Migration Service» в руководстве пользователя Database Migration Service.

Username -> (строка)

Имя пользователя для доступа к конечной точке источника MongoDB.

Password -> (строка)

Пароль для учетной записи пользователя, используемой для доступа к конечному пункту источника MongoDB.

ServerName -> (строка)

Имя сервера на конечной точке источника MongoDB. Для MongoDB Atlas укажите имя сервера для любого из серверов в наборе репликации.

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

Значение порта для конечного пункта источника MongoDB.

DatabaseName -> (строка)

Имя базы данных на конечном пункте источника MongoDB.

AuthType -> (строка)

Тип аутентификации, используемый для доступа к конечному пункту источника MongoDB.

При установке значения в "no", параметры имени пользователя и пароля не используются и могут быть пустыми.

AuthMechanism -> (строка)

Механизм аутентификации, используемый для доступа к конечному пункту источника MongoDB.

Для значения по умолчанию, в MongoDB версии 2.x, "default" равно "mongodb_cr". Для MongoDB версии 3.x или более поздних версий "default" равно "scram_sha_1". Этот параметр не используется, когда AuthType установлено в "no".

NestingLevel -> (строка)

Указывает режим документа или таблицы.

Значение по умолчанию — "none". Укажите "none", чтобы использовать режим документа. Укажите "one", чтобы использовать режим таблицы.

ExtractDocId -> (строка)

Указывает идентификатор документа. Используйте эту настройку, когда NestingLevel установлено в "none".

Значение по умолчанию — "false".

DocsToInvestigate -> (строка)

Указывает количество документов для предварительного просмотра, чтобы определить организацию документов. Используйте эту настройку, когда NestingLevel установлено в "one".

Должно быть положительным значением, большим чем 0. Значение по умолчанию — 1000.

AuthSource -> (строка)

Имя базы данных MongoDB. Этот параметр не используется, когда AuthType установлено в "no".

Значение по умолчанию — "admin".

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для шифрования содержимого на репликации. Если вы не укажете значение для параметра KmsKeyId, DMS использует ваш ключ шифрования по умолчанию. KMS создает ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У вашей учетной записи Amazon Web Services есть другой ключ шифрования по умолчанию для каждого региона Amazon Web Services.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, указывающей DMS в качестве доверенного субъекта и предоставляющей необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, позволяющее получить доступ к конечному пункту MongoDB.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых SecretsManagerAccessRoleArn и SecretsManagerSecretId для доступа к ней см. в разделе «Использование секретов для доступа к ресурсам Database Migration Service» в руководстве пользователя Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или дружественное имя SecretsManagerSecret, содержащего данные подключения к конечному пункту MongoDB.

UseUpdateLookUp -> (булево)

Если true, DMS извлекает весь документ из источника MongoDB во время миграции. Это может привести к сбоям миграции, если ответ сервера превысит пределы пропускной способности. Чтобы извлечь только обновления и удаления во время миграции, установите этот параметр в значение false.

ReplicateShardCollections -> (булево)

Если true, DMS реплицирует данные в коллекции фрагментов. DMS использует этот параметр только в том случае, если целевой конечный пункт — это кластер DocumentDB elastic.

Когда эта настройка имеет значение true, обратите внимание на следующее:

Вы должны установить TargetTablePrepMode в значение nothing.
DMS автоматически устанавливает useUpdateLookup в значение false.

Синтаксис в сокращенном виде:

Username=string,Password=string,ServerName=string,Port=integer,DatabaseName=string,AuthType=string,AuthMechanism=string,NestingLevel=string,ExtractDocId=string,DocsToInvestigate=string,AuthSource=string,KmsKeyId=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,UseUpdateLookUp=boolean,ReplicateShardCollections=boolean

Синтаксис JSON:

{
  "Username": "string",
  "Password": "string",
  "ServerName": "string",
  "Port": integer,
  "DatabaseName": "string",
  "AuthType": "no"|"password",
  "AuthMechanism": "default"|"mongodb_cr"|"scram_sha_1",
  "NestingLevel": "none"|"one",
  "ExtractDocId": "string",
  "DocsToInvestigate": "string",
  "AuthSource": "string",
  "KmsKeyId": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "UseUpdateLookUp": true|false,
  "ReplicateShardCollections": true|false
}

--kinesis-settings (структура)

Настройки в формате JSON для целевого конечного пункта Amazon Kinesis Data Streams. Дополнительную информацию о доступных настройках см. в руководстве пользователя Database Migration Service в разделе «Использование отображения объектов для миграции данных в поток Kinesis».

StreamArn -> (строка)

Идентификатор ресурса Amazon (ARN) для конечного пункта Amazon Kinesis Data Streams.

MessageFormat -> (строка)

Формат вывода записей, созданных в конечном пункте. Формат сообщения — JSON (по умолчанию) или JSON_UNFORMATTED (одна строка без табуляции).

ServiceAccessRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) для роли IAM, которую DMS использует для записи в поток Kinesis. Роль должна разрешать действие iam:PassRole.

IncludeTransactionDetails -> (булево)

Предоставляет подробную информацию о транзакции из исходной базы данных. Эта информация включает отметку времени фиксации, позицию журнала и значения для transaction_id , предыдущие transaction_id и transaction_record_id (смещение записи в рамках транзакции). По умолчанию — false.

IncludePartitionValue -> (булево)

Отображает значение раздела в выходном сообщении Kinesis, если тип раздела не равен schema-table-type. По умолчанию — false.

PartitionIncludeSchemaTable -> (булево)

Добавляет префиксы со схемой и именем таблицы к значениям раздела, если тип раздела равен primary-key-type. Это увеличивает распределение данных среди фрагментов Kinesis. Например, предположим, что схема SysBench содержит тысячи таблиц, а каждая таблица имеет ограниченный диапазон для первичного ключа. В этом случае тот же первичный ключ отправляется из тысяч таблиц в один и тот же фрагмент, что приводит к ограничению скорости. По умолчанию — false.

IncludeTableAlterOperations -> (булево)

Включает любые операции языка определения данных (DDL), которые изменяют таблицу в управляющих данных, такие как rename-table , drop-table , add-column , drop-column и rename-column. По умолчанию — false.

IncludeControlDetails -> (булево)

Отображает подробную информацию о определении таблицы, столбца, а также изменениях таблиц и столбцов в выходном сообщении Kinesis. По умолчанию — false.

IncludeNullAndEmpty -> (булево)

Включает значения NULL и пустые столбцы для записей, мигрированных в конечный пункт. По умолчанию — false.

NoHexPrefix -> (булево)

Установите этот необязательный параметр в true, чтобы избежать добавления префикса ‘0x’ к необработанным данным в шестнадцатеричном формате. Например, по умолчанию DMS добавляет префикс ‘0x’ к типу столбца LOB в шестнадцатеричном формате при миграции из источника Oracle в целевой Amazon Kinesis. Используйте настройку конечного пункта NoHexPrefix для включения миграции столбцов типа RAW данных без добавления префикса ‘0x’.

UseLargeIntegerValue -> (булево)

Указывает использование большого целого значения с Kinesis.

Сокращенная запись:

StreamArn=string,MessageFormat=string,ServiceAccessRoleArn=string,IncludeTransactionDetails=boolean,IncludePartitionValue=boolean,PartitionIncludeSchemaTable=boolean,IncludeTableAlterOperations=boolean,IncludeControlDetails=boolean,IncludeNullAndEmpty=boolean,NoHexPrefix=boolean,UseLargeIntegerValue=boolean

Синтаксис JSON:

{
  "StreamArn": "string",
  "MessageFormat": "json"|"json-unformatted",
  "ServiceAccessRoleArn": "string",
  "IncludeTransactionDetails": true|false,
  "IncludePartitionValue": true|false,
  "PartitionIncludeSchemaTable": true|false,
  "IncludeTableAlterOperations": true|false,
  "IncludeControlDetails": true|false,
  "IncludeNullAndEmpty": true|false,
  "NoHexPrefix": true|false,
  "UseLargeIntegerValue": true|false
}

--kafka-settings (структура)

Настройки в формате JSON для целевого конечного пункта Apache Kafka. Дополнительную информацию о доступных настройках см. в руководстве пользователя Database Migration Service в разделе «Использование отображения объектов для миграции данных в тему Kafka».

Broker -> (строка)

Список из одной или нескольких точек расположения брокеров в кластере Kafka, которые принимают ваш экземпляр Kafka, разделенные запятыми. Укажите каждую точку расположения брокера в формате `` имя_хоста_или_IP_брокера :порт ``. Например, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". Дополнительную информацию и примеры указания списка точек расположения брокеров см. в руководстве пользователя Database Migration Service в разделе «Использование Apache Kafka в качестве целевого пункта для Database Migration Service».

Topic -> (строка)

Тема, в которую мигрируются данные. Если тема не указана, DMS укажет "kafka-default-topic" в качестве темы миграции.

MessageFormat -> (строка)

IncludeTransactionDetails -> (булево)

IncludePartitionValue -> (булево)

Отображает значение раздела в выходном сообщении Kafka, если тип раздела не равен schema-table-type. По умолчанию — false.

PartitionIncludeSchemaTable -> (булево)

Добавляет префиксы со схемой и именем таблицы к значениям раздела, если тип раздела равен primary-key-type. Это увеличивает распределение данных среди разделов Kafka. Например, предположим, что схема SysBench содержит тысячи таблиц, а каждая таблица имеет ограниченный диапазон для первичного ключа. В этом случае тот же первичный ключ отправляется из тысяч таблиц в один и тот же раздел, что приводит к ограничению скорости. По умолчанию — false.

IncludeTableAlterOperations -> (булево)

IncludeControlDetails -> (булево)

Отображает подробную информацию о определении таблицы, столбца, а также изменениях таблиц и столбцов в выходном сообщении Kafka. По умолчанию — false.

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

Максимальный размер в байтах для записей, созданных в конечном пункте. По умолчанию — 1 000 000.

IncludeNullAndEmpty -> (булево)

Включает значения NULL и пустые столбцы для записей, мигрированных в конечный пункт. По умолчанию — false.

SecurityProtocol -> (строка)

Установите безопасное подключение к целевому конечном пункту Kafka с использованием Transport Layer Security (TLS). Доступные варианты включают ssl-encryption , ssl-authentication и sasl-ssl. sasl-ssl требует SaslUsername и SaslPassword.

SslClientCertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) клиентского сертификата, используемого для безопасного подключения к целевому конечном пункту Kafka.

SslClientKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) для закрытого ключа клиента, используемого для безопасного подключения к целевому конечном пункту Kafka.

SslClientKeyPassword -> (строка)

Пароль для закрытого ключа клиента, используемого для безопасного подключения к целевому конечном пункту Kafka.

SslCaCertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) сертификата центра сертификации (CA), который DMS использует для безопасного подключения к целевому конечном пункту Kafka.

SaslUsername -> (строка)

Безопасное имя пользователя, которое вы создали при настройке кластера MSK, для проверки подлинности клиента и создания зашифрованного соединения между сервером и клиентом с использованием аутентификации SASL-SSL.

SaslPassword -> (строка)

Безопасный пароль, который вы создали при настройке кластера MSK, для проверки подлинности клиента и создания зашифрованного соединения между сервером и клиентом с использованием аутентификации SASL-SSL.

NoHexPrefix -> (булево)

Установите этот необязательный параметр в true, чтобы избежать добавления префикса ‘0x’ к необработанным данным в шестнадцатеричном формате. Например, по умолчанию DMS добавляет префикс ‘0x’ к типу столбца LOB в шестнадцатеричном формате при миграции из источника Oracle в целевой Kafka. Используйте настройку конечного пункта NoHexPrefix для включения миграции столбцов типа RAW данных без добавления префикса ‘0x’.

SaslMechanism -> (строка)

Для аутентификации SASL/SSL DMS по умолчанию поддерживает механизм SCRAM-SHA-512. Версии DMS 3.5.0 и выше также поддерживают механизм PLAIN. Для использования механизма PLAIN установите этот параметр в PLAIN.

SslEndpointIdentificationAlgorithm -> (строка)

Устанавливает проверку имени хоста для сертификата. Эта настройка поддерживается в версии DMS 3.5.1 и выше.

UseLargeIntegerValue -> (булево)

Указывает использование большого целого значения с Kafka.

Сокращенная запись:

Broker=string,Topic=string,MessageFormat=string,IncludeTransactionDetails=boolean,IncludePartitionValue=boolean,PartitionIncludeSchemaTable=boolean,IncludeTableAlterOperations=boolean,IncludeControlDetails=boolean,MessageMaxBytes=integer,IncludeNullAndEmpty=boolean,SecurityProtocol=string,SslClientCertificateArn=string,SslClientKeyArn=string,SslClientKeyPassword=string,SslCaCertificateArn=string,SaslUsername=string,SaslPassword=string,NoHexPrefix=boolean,SaslMechanism=string,SslEndpointIdentificationAlgorithm=string,UseLargeIntegerValue=boolean

Синтаксис JSON:

{
  "Broker": "string",
  "Topic": "string",
  "MessageFormat": "json"|"json-unformatted",
  "IncludeTransactionDetails": true|false,
  "IncludePartitionValue": true|false,
  "PartitionIncludeSchemaTable": true|false,
  "IncludeTableAlterOperations": true|false,
  "IncludeControlDetails": true|false,
  "MessageMaxBytes": integer,
  "IncludeNullAndEmpty": true|false,
  "SecurityProtocol": "plaintext"|"ssl-authentication"|"ssl-encryption"|"sasl-ssl",
  "SslClientCertificateArn": "string",
  "SslClientKeyArn": "string",
  "SslClientKeyPassword": "string",
  "SslCaCertificateArn": "string",
  "SaslUsername": "string",
  "SaslPassword": "string",
  "NoHexPrefix": true|false,
  "SaslMechanism": "scram-sha-512"|"plain",
  "SslEndpointIdentificationAlgorithm": "none"|"https",
  "UseLargeIntegerValue": true|false
}

--elasticsearch-settings (структура)

Настройки в формате JSON для целевого конечного пункта OpenSearch. Дополнительную информацию о доступных настройках см. в руководстве пользователя Database Migration Service в разделе «Дополнительные атрибуты подключения при использовании OpenSearch в качестве целевого пункта для DMS».

ServiceAccessRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN), используемый службой для доступа к роли IAM. Роль должна разрешать действие iam:PassRole.

EndpointUri -> (строка)

Конечный пункт для кластера OpenSearch. DMS использует HTTPS, если протокол передачи (http/https) не указан.

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

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

Чтобы избежать преждевременной ошибки, этот счетчик эффективен только после передачи 1000 записей. OpenSearch также имеет концепцию мониторинга ошибок в течение последних 10 минут окна наблюдения. Если передача всех записей завершается ошибкой в последние 10 минут, операция полной загрузки останавливается.

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

Максимальное количество секунд, в течение которого DMS повторно пытается выполнить не удавшиеся API-запросы к кластеру OpenSearch.

UseNewMappingType -> (булево)

Установите этот параметр в true для миграции DMS документации с использованием типа документации _doc. OpenSearch и кластер Elasticsearch поддерживают только тип документации _doc в версиях 7.x и выше. Значение по умолчанию — false.

Сокращенная запись:

ServiceAccessRoleArn=string,EndpointUri=string,FullLoadErrorPercentage=integer,ErrorRetryDuration=integer,UseNewMappingType=boolean

Синтаксис JSON:

{
  "ServiceAccessRoleArn": "string",
  "EndpointUri": "string",
  "FullLoadErrorPercentage": integer,
  "ErrorRetryDuration": integer,
  "UseNewMappingType": true|false
}

--neptune-settings (структура)

Настройки в формате JSON для целевого узла Amazon Neptune. Дополнительную информацию об доступных настройках см. в Руководстве пользователя службы миграции баз данных, раздел «Указание правил сопоставления графов с помощью Gremlin и R2RML для Amazon Neptune в качестве целевого узла».

ServiceAccessRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли службы, которую вы создали для целевого узла Neptune. Роль должна разрешать действие iam:PassRole. Дополнительную информацию см. в Руководстве пользователя службы миграции баз данных, разделе «Создание роли службы IAM для доступа к Amazon Neptune в качестве целевого узла».

S3BucketName -> (строка)

Имя ведра Amazon S3, в котором DMS может временно хранить мигрированные данные графа в файлах .csv перед их массовым загрузкой в целевую базу данных Neptune. DMS сопоставляет данные исходной SQL-базы данных с данными графа, прежде чем сохранить их в этих файлах .csv.

S3BucketFolder -> (строка)

Путь к папке, в которую вы хотите, чтобы DMS сохранял мигрированные данные графа в ведре S3, указанном в S3BucketName.

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

Количество миллисекунд, которое DMS ждет, чтобы повторить массовую загрузку мигрированных данных графа в целевую базу данных Neptune, прежде чем выдать ошибку. По умолчанию 250.

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

Максимальный размер в килобайтах мигрированных данных графа, хранящихся в файле .csv, прежде чем DMS массово загрузит данные в целевую базу данных Neptune. По умолчанию 1 048 576 КБ. Если массовая загрузка прошла успешно, DMS очищает ведро, готовое к хранению следующей порции мигрированных данных графа.

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

Количество попыток, которое DMS предпримет для повторной массовой загрузки мигрированных данных графа в целевую базу данных Neptune перед выдачей ошибки. По умолчанию 5.

IamAuthEnabled -> (логическое значение)

Если вы хотите включить авторизацию Identity and Access Management (IAM) для этого узла, установите этот параметр в значение true. Затем прикрепите соответствующий документ политики IAM к вашей роли службы, указанной в ServiceAccessRoleArn. По умолчанию false.

Краткая синтаксическая запись:

ServiceAccessRoleArn=string,S3BucketName=string,S3BucketFolder=string,ErrorRetryDuration=integer,MaxFileSize=integer,MaxRetryCount=integer,IamAuthEnabled=boolean

Синтаксис JSON:

{
  "ServiceAccessRoleArn": "string",
  "S3BucketName": "string",
  "S3BucketFolder": "string",
  "ErrorRetryDuration": integer,
  "MaxFileSize": integer,
  "MaxRetryCount": integer,
  "IamAuthEnabled": true|false
}

--redshift-settings (структура)

Предоставляет информацию, определяющую конечную точку Amazon Redshift.

AcceptAnyDate -> (boolean)

Значение, указывающее на разрешение любого формата даты, включая недопустимые форматы, такие как 00/00/00 00:00:00, для загрузки без генерации ошибки. Вы можете выбрать true или false (по умолчанию).

Этот параметр применим только к столбцам TIMESTAMP и DATE. Всегда используйте ACCEPTANYDATE с параметром DATEFORMAT. Если формат даты данных не соответствует спецификации DATEFORMAT, Amazon Redshift вставляет значение NULL в этот столбец.

AfterConnectScript -> (string)

Код для выполнения после подключения. Этот параметр должен содержать сам код, а не имя файла, содержащего код.

BucketFolder -> (string)

Папка S3, где хранятся файлы с разделителями-запятыми (.csv) перед загрузкой в целевой кластер Redshift.

Для режима полной загрузки DMS преобразует исходные записи в файлы .csv и загружает их в путь BucketFolder/TableID. DMS использует команду Redshift COPY для загрузки файлов .csv в целевую таблицу. Файлы удаляются после завершения операции COPY. Дополнительную информацию см. в разделе COPY в Руководстве разработчика базы данных Amazon Redshift.

Для режима захвата изменений (CDC) DMS создает таблицу NetChanges и загружает файлы .csv в этот путь BucketFolder/NetChangesTableID.

BucketName -> (string)

Имя промежуточного ведра S3, используемого для хранения файлов .csv перед загрузкой данных в Redshift.

CaseSensitiveNames -> (boolean)

Если Amazon Redshift настроен на поддержку имен схем, чувствительных к регистру, установите CaseSensitiveNames в значение true. Значение по умолчанию - false.

CompUpdate -> (boolean)

Если вы установите CompUpdate в значение true, Amazon Redshift применит автоматическое сжатие, если таблица пуста. Это применяется даже если столбцы таблицы уже имеют кодировки, отличные от RAW. Если вы установите CompUpdate в значение false, автоматическое сжатие будет отключено, и существующие кодировки столбцов не будут изменены. Значение по умолчанию - true.

ConnectionTimeout -> (integer)

Значение, устанавливающее время ожидания (в миллисекундах) перед истечением времени ожидания, начиная с момента первоначального установления соединения.

DatabaseName -> (string)

Имя хранилища данных Amazon Redshift (сервиса), с которым вы работаете.

DateFormat -> (string)

Используемый формат даты. Допустимые значения: auto (регистрозависимый), строка вашего формата даты в кавычках или NULL. Если этот параметр не задан (NULL), по умолчанию используется формат 'ГГГГ-ММ-ДД'. При использовании auto распознаются большинство строк, даже некоторые, которые не поддерживаются при использовании строки формата даты.

Если ваши значения даты и времени используют разные форматы, установите этот параметр в значение auto.

EmptyAsNull -> (boolean)

Значение, указывающее, следует ли DMS мигрировать пустые поля CHAR и VARCHAR как NULL. Значение true устанавливает пустые поля CHAR и VARCHAR в null. Значение по умолчанию - false.

EncryptionMode -> (string)

Тип шифрования на стороне сервера, который вы хотите использовать для ваших данных. Этот тип шифрования является частью параметров конечной точки или дополнительных атрибутов соединений для Amazon S3. Вы можете выбрать либо SSE_S3 (по умолчанию), либо SSE_KMS.

Примечание

Для операции ModifyEndpoint вы можете изменить существующее значение параметра EncryptionMode со значения SSE_KMS на SSE_S3. Но вы не можете изменить существующее значение с SSE_S3 на SSE_KMS.

Для использования SSE_S3 создайте роль Identity and Access Management (IAM) с политикой, которая позволяет "arn:aws:s3:::*" использовать следующие действия: "s3:PutObject", "s3:ListBucket"

ExplicitIds -> (boolean)

Этот параметр действителен только для задачи миграции полной загрузки. Установите ExplicitIds в значение true, чтобы таблицы со столбцами IDENTITY переопределяли свои автоматически сгенерированные значения явными значениями, загруженными из исходных файлов данных, используемых для заполнения таблиц. По умолчанию значение - false.

FileTransferUploadStreams -> (integer)

Количество потоков, используемых для загрузки одного файла. Этот параметр принимает значение от 1 до 64. По умолчанию значение равно 10.

Количество параллельных потоков, используемых для загрузки одного файла .csv в ведро S3 с помощью многочастотной загрузки S3. Дополнительную информацию см. в разделе Обзор многочастотной загрузки.

FileTransferUploadStreams принимает значение от 1 до 64. По умолчанию значение равно 10.

LoadTimeout -> (integer)

Время ожидания (в миллисекундах) операций DMS в кластере Redshift, таких как Redshift COPY, INSERT, DELETE и UPDATE.

MaxFileSize -> (integer)

Максимальный размер (в КБ) любого файла .csv, используемого для загрузки данных в ведро S3 и передачи данных в Amazon Redshift. По умолчанию значение равно 1048576 КБ (1 ГБ).

Password -> (string)

Пароль для пользователя, указанного в свойстве username.

Port -> (integer)

Номер порта для Amazon Redshift. Значение по умолчанию равно 5439.

RemoveQuotes -> (boolean)

Значение, указывающее на удаление окружающих кавычек из строк в поступающих данных. Все символы внутри кавычек, включая разделители, сохраняются. Выберите true для удаления кавычек. Значение по умолчанию - false.

ReplaceInvalidChars -> (string)

Список символов, которые вы хотите заменить. Используйте с ReplaceChars.

ReplaceChars -> (string)

Значение, указывающее на замену недопустимых символов, указанных в ReplaceInvalidChars, с заменой указанными символами. Значение по умолчанию - "?".

ServerName -> (string)

Имя используемого вами кластера Amazon Redshift.

ServiceAccessRoleArn -> (string)

Amazon Resource Name (ARN) роли IAM, имеющей доступ к сервису Amazon Redshift. Роль должна разрешать действие iam:PassRole.

ServerSideEncryptionKmsKeyId -> (string)

Идентификатор KMS-ключа. Если вы используете SSE_KMS для EncryptionMode, укажите этот идентификатор ключа. Используемый вами ключ должен иметь прикрепленную политику, которая включает разрешения IAM-пользователей и позволяет использовать ключ.

TimeFormat -> (string)

Используемый формат времени. Допустимые значения: auto (регистрозависимый), 'timeformat_string', 'epochsecs' или 'epochmillisecs'. Значение по умолчанию - 10. Используя auto, распознаются большинство строк, даже некоторые, которые не поддерживаются при использовании строки формата времени.

Если ваши значения даты и времени используют разные форматы, установите этот параметр в значение auto.

TrimBlanks -> (boolean)

Значение, указывающее на удаление символов пробела из строки VARCHAR. Этот параметр применим только к столбцам с типом данных VARCHAR. Выберите true для удаления ненужных пробелов. Значение по умолчанию - false.

TruncateColumns -> (boolean)

Значение, указывающее на обрезку данных в столбцах до соответствующего количества символов, чтобы данные поместились в столбец. Этот параметр применим только к столбцам с типами данных VARCHAR или CHAR и строкам размером 4 МБ или меньше. Выберите true для обрезки данных. Значение по умолчанию - false.

Username -> (string)

Имя пользователя Amazon Redshift для зарегистрированного пользователя.

WriteBufferSize -> (integer)

Размер (в КБ) буфера записи в памяти, используемого при генерации файлов .csv на локальном диске на экземпляре репликации DMS. Значение по умолчанию - 1000 (размер буфера - 1000 КБ).

SecretsManagerAccessRoleArn -> (string)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret имеет значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке Amazon Redshift.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в Руководстве пользователя Database Migration Service в разделе Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (string)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке Amazon Redshift.

MapBooleanAsBoolean -> (boolean)

При значении true Redshift мигрирует тип boolean как boolean. По умолчанию Redshift мигрирует boolean как varchar(1). Вам необходимо установить этот параметр как на исходной, так и на целевой конечных точках для его активации.

Сокращенная синтаксическая запись:

AcceptAnyDate=boolean,AfterConnectScript=string,BucketFolder=string,BucketName=string,CaseSensitiveNames=boolean,CompUpdate=boolean,ConnectionTimeout=integer,DatabaseName=string,DateFormat=string,EmptyAsNull=boolean,EncryptionMode=string,ExplicitIds=boolean,FileTransferUploadStreams=integer,LoadTimeout=integer,MaxFileSize=integer,Password=string,Port=integer,RemoveQuotes=boolean,ReplaceInvalidChars=string,ReplaceChars=string,ServerName=string,ServiceAccessRoleArn=string,ServerSideEncryptionKmsKeyId=string,TimeFormat=string,TrimBlanks=boolean,TruncateColumns=boolean,Username=string,WriteBufferSize=integer,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,MapBooleanAsBoolean=boolean

Синтаксис JSON:

{
  "AcceptAnyDate": true|false,
  "AfterConnectScript": "string",
  "BucketFolder": "string",
  "BucketName": "string",
  "CaseSensitiveNames": true|false,
  "CompUpdate": true|false,
  "ConnectionTimeout": integer,
  "DatabaseName": "string",
  "DateFormat": "string",
  "EmptyAsNull": true|false,
  "EncryptionMode": "sse-s3"|"sse-kms",
  "ExplicitIds": true|false,
  "FileTransferUploadStreams": integer,
  "LoadTimeout": integer,
  "MaxFileSize": integer,
  "Password": "string",
  "Port": integer,
  "RemoveQuotes": true|false,
  "ReplaceInvalidChars": "string",
  "ReplaceChars": "string",
  "ServerName": "string",
  "ServiceAccessRoleArn": "string",
  "ServerSideEncryptionKmsKeyId": "string",
  "TimeFormat": "string",
  "TrimBlanks": true|false,
  "TruncateColumns": true|false,
  "Username": "string",
  "WriteBufferSize": integer,
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "MapBooleanAsBoolean": true|false
}

--postgre-sql-settings (структура)

Настройки в формате JSON для источника и целевого конечного узла PostgreSQL. Дополнительную информацию об имеющихся настройках см. в разделе «Дополнительные атрибуты подключения при использовании PostgreSQL в качестве источника для DMS» и «Дополнительные атрибуты подключения при использовании PostgreSQL в качестве целевого конечного узла для DMS» в руководстве пользователя службы миграции баз данных.

AfterConnectScript -> (строка)

Только для использования с функцией захвата изменений данных (CDC) этот атрибут позволяет DMS игнорировать внешние ключи и пользовательские триггеры для сокращения времени массовой загрузки данных.

Пример: afterConnectScript=SET session_replication_role='replica'

CaptureDdls -> (логическое значение)

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

Значение по умолчанию — true.

Если это значение установлено в N, вам не нужно создавать таблицы или триггеры в источниковой базе данных.

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

Устанавливает максимальный размер (в КБ) любого файла .csv, используемого для передачи данных в PostgreSQL.

Значение по умолчанию — 32 768 КБ (32 МБ).

Пример: maxFileSize=512

DatabaseName -> (строка)

Имя базы данных для конечного узла.

DdlArtifactsSchema -> (строка)

Схема, в которой создаются операционные артефакты базы данных DDL.

Значение по умолчанию — public.

Пример: ddlArtifactsSchema=xyzddlschema;

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

Устанавливает таймаут оператора клиента для экземпляра PostgreSQL в секундах. Значение по умолчанию — 60 секунд.

Пример: executeTimeout=100;

FailTasksOnLobTruncation -> (логическое значение)

Если установлено в true, это значение заставляет задачу завершиться неудачно, если фактический размер столбца LOB больше, чем указанный LobMaxSize.

Значение по умолчанию — false.

Если задача настроена в режиме ограниченного LOB и этот параметр установлен в значение true, задача завершается неудачно вместо усечения данных LOB.

HeartbeatEnable -> (логическое значение)

Функция «сердцебиения» журнала предварительной записи (WAL) имитирует фиктивную транзакцию. Это предотвращает удержание старых журналов WAL неактивными слотами логической репликации, что может привести к заполнению хранилища на источнике. Это сердцебиение сохраняет restart_lsn в движении и предотвращает ситуации заполнения хранилища.

Значение по умолчанию — false.

HeartbeatSchema -> (строка)

Устанавливает схему, в которой создаются артефакты сердцебиения.

Значение по умолчанию — public.

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

Устанавливает частоту сердцебиения WAL (в минутах).

Значение по умолчанию — 5 минут.

Password -> (строка)

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

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

TCP-порт конечного узла. По умолчанию — 5432.

ServerName -> (строка)

Имя хоста базы данных конечного узла.

Для экземпляра Amazon RDS PostgreSQL это вывод DescribeDBInstances в поле «Endpoint.Address».

Для экземпляра Aurora PostgreSQL это вывод DescribeDBClusters в поле Endpoint.

Username -> (строка)

Имя пользователя подключения к конечному узлу.

SlotName -> (строка)

Устанавливает имя ранее созданного логического слота репликации для загрузки данных изменения (CDC) экземпляра PostgreSQL.

При использовании параметра CdcStartPosition API службы DMS этот атрибут также позволяет использовать исходные точки CDC. DMS проверяет, существует ли указанный логический слот репликации, прежде чем начать задачу загрузки CDC. Также проверяется, что задача была создана с допустимым значением CdcStartPosition. Если указанного слота не существует или у задачи нет допустимого значения CdcStartPosition, DMS возвращает ошибку.

Дополнительную информацию об установке параметра запроса CdcStartPosition см. в разделе «Определение исходной точки CDC» в руководстве пользователя службы миграции баз данных. Дополнительную информацию об использовании CdcStartPosition см. в разделах CreateReplicationTask, StartReplicationTask и ModifyReplicationTask.

PluginName -> (строка)

Указывает плагин, используемый для создания слота репликации.

Значение по умолчанию — pglogical.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечному узлу PostgreSQL.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать явные значения для UserName, Password, ServerName и Port. Вы не можете указать оба варианта. Дополнительную информацию о создании этого SecretsManagerSecret и необходимых для доступа к нему действиях SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в разделе «Использование секретов для доступа к ресурсам службы миграции баз данных» в руководстве пользователя службы миграции баз данных.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или имя-пометка SecretsManagerSecret, содержащего данные подключения к конечному узлу PostgreSQL.

TrimSpaceInChar -> (логическое значение)

Используйте настройку конечного узла источника TrimSpaceInChar для обрезки данных типов данных CHAR и NCHAR во время миграции. Значение по умолчанию — true.

MapBooleanAsBoolean -> (логическое значение)

Если true, позволяет PostgreSQL мигрировать тип boolean как boolean. По умолчанию PostgreSQL мигрирует boolean как varchar(5). Для этого необходимо установить эту настройку на обоих конечных узлах источника и цели.

Значение по умолчанию — false.

MapJsonbAsClob -> (логическое значение)

При значении true DMS мигрирует значения JSONB как CLOB.

Значение по умолчанию — false.

MapLongVarcharAs -> (строка)

Устанавливает тип данных для отображения значений LONG.

Значение по умолчанию — wstring.

DatabaseMode -> (строка)

Определяет поведение по умолчанию обработки репликации для конечных узлов, совместимых с PostgreSQL, требующих дополнительной настройки, таких как конечные узлы Babelfish.

BabelfishDatabaseName -> (строка)

Имя базы данных Babelfish для конечного узла Aurora PostgreSQL.

DisableUnicodeSourceFilter -> (логическое значение)

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

Поддержка Unicode следует отключать только при использовании фильтра правила выбора на индексированном текстовом столбце в источниковой базе данных.

ServiceAccessRoleArn -> (строка)

ARN роли IAM, которую можно использовать для аутентификации подключения к конечному узлу. Убедитесь, что в политике разрешений включены действия iam:PassRole и rds-db:connect.

AuthenticationMethod -> (строка)

Этот атрибут позволяет указать метод аутентификации как «iam auth».

Краткая синтаксическая запись:

AfterConnectScript=string,CaptureDdls=boolean,MaxFileSize=integer,DatabaseName=string,DdlArtifactsSchema=string,ExecuteTimeout=integer,FailTasksOnLobTruncation=boolean,HeartbeatEnable=boolean,HeartbeatSchema=string,HeartbeatFrequency=integer,Password=string,Port=integer,ServerName=string,Username=string,SlotName=string,PluginName=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,TrimSpaceInChar=boolean,MapBooleanAsBoolean=boolean,MapJsonbAsClob=boolean,MapLongVarcharAs=string,DatabaseMode=string,BabelfishDatabaseName=string,DisableUnicodeSourceFilter=boolean,ServiceAccessRoleArn=string,AuthenticationMethod=string

Синтаксис JSON:

{
  "AfterConnectScript": "string",
  "CaptureDdls": true|false,
  "MaxFileSize": integer,
  "DatabaseName": "string",
  "DdlArtifactsSchema": "string",
  "ExecuteTimeout": integer,
  "FailTasksOnLobTruncation": true|false,
  "HeartbeatEnable": true|false,
  "HeartbeatSchema": "string",
  "HeartbeatFrequency": integer,
  "Password": "string",
  "Port": integer,
  "ServerName": "string",
  "Username": "string",
  "SlotName": "string",
  "PluginName": "no-preference"|"test-decoding"|"pglogical",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "TrimSpaceInChar": true|false,
  "MapBooleanAsBoolean": true|false,
  "MapJsonbAsClob": true|false,
  "MapLongVarcharAs": "wstring"|"clob"|"nclob",
  "DatabaseMode": "default"|"babelfish",
  "BabelfishDatabaseName": "string",
  "DisableUnicodeSourceFilter": true|false,
  "ServiceAccessRoleArn": "string",
  "AuthenticationMethod": "password"|"iam"
}

--my-sql-settings (структура)

Настройки в формате JSON для исходного и целевого MySQL-соединения. Сведения об остальных доступных настройках см. в разделе «Дополнительные атрибуты подключения при использовании MySQL в качестве источника для DMS» и «Дополнительные атрибуты подключения при использовании MySQL-совместимой базы данных в качестве целевой базы данных для DMS» в руководстве пользователя службы миграции баз данных.

AfterConnectScript -> (строка)

Указывает скрипт, который будет выполнен сразу после подключения DMS к конечной точке. Задача миграции продолжит выполняться независимо от успешности или неудачи выполнения SQL-запроса.

Для этого параметра укажите сам код скрипта, а не имя файла, содержащего скрипт.

CleanSourceMetadataOnMismatch -> (булево)

Очищает и пересоздает сведения о метаданных таблицы на экземпляре репликации при возникновении несоответствия. Например, в ситуации, когда выполнение оператора alter DDL для таблицы может привести к различной информации о таблице, кэшированной в экземпляре репликации.

DatabaseName -> (строка)

Имя базы данных для конечной точки. Для конечной точки MySQL-источника или MySQL-цели не указывайте явным образом базу данных, используя параметр DatabaseName в запросе CreateEndpoint или ModifyEndpoint API. Указание DatabaseName при создании или изменении MySQL-конечной точки реплицирует все таблицы задач в эту единственную базу данных. Для MySQL-конечных точек вы указываете базу данных только тогда, когда вы указываете схему в правилах сопоставления таблиц задачи DMS.

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

Определяет частоту проверки двоичного журнала на новые изменения/события, когда база данных простаивает. По умолчанию — пять секунд.

Пример: eventsPollInterval=5;

В примере DMS проверяет изменения в двоичных журналах каждые пять секунд.

TargetDbType -> (строка)

Определяет, где мигрировать исходные таблицы на целевой стороне, в одну базу данных или несколько баз данных. Если вы укажете SPECIFIC_DATABASE, укажите имя базы данных, используя параметр DatabaseName объекта Endpoint.

Пример: targetDbType=MULTIPLE_DATABASES

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

Указывает максимальный размер (в КБ) любого файла .csv, используемого для передачи данных в MySQL-совместимую базу данных.

Пример: maxFileSize=512

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

Повышает производительность при загрузке данных в целевую MySQL-совместимую базу данных. Указывает количество потоков для загрузки данных в целевую MySQL-совместимую базу данных. Установка большого числа потоков может негативно сказаться на производительности базы данных, так как для каждого потока требуется отдельное подключение. По умолчанию — один.

Пример: parallelLoadThreads=1

Password -> (строка)

Пароль для подключения к конечной точке.

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

TCP-порт конечной точки.

ServerName -> (строка)

Имя хоста базы данных конечной точки.

Для экземпляра Amazon RDS MySQL это результат DescribeDBInstances, в поле ``Endpoint.Address``.

Для экземпляра Aurora MySQL это результат DescribeDBClusters, в поле Endpoint.

ServerTimezone -> (строка)

Указывает часовой пояс исходной MySQL-базы данных.

Пример: serverTimezone=US/Pacific;

Примечание: не заключайте часовые пояса в одинарные кавычки.

Username -> (строка)

Имя пользователя для подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая определяет DMS как доверенного субъекта и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, позволяющего получить доступ к MySQL-конечной точке.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых SecretsManagerAccessRoleArn и SecretsManagerSecretId для доступа к ней см. в разделе «Использование секретов для доступа к ресурсам службы миграции баз данных» в руководстве пользователя службы миграции баз данных.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или имя секрета SecretsManagerSecret, содержащий данные подключения к MySQL-конечной точке.

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

Устанавливает таймаут клиентского запроса (в секундах) для MySQL-источника конечной точки.

ServiceAccessRoleArn -> (строка)

Роль IAM, которую вы можете использовать для аутентификации при подключении к конечной точке. Убедитесь, что в политике разрешений включены действия iam:PassRole и rds-db:connect.

AuthenticationMethod -> (строка)

Этот атрибут позволяет указать метод аутентификации как «iam auth».

Сокращенная запись:

AfterConnectScript=string,CleanSourceMetadataOnMismatch=boolean,DatabaseName=string,EventsPollInterval=integer,TargetDbType=string,MaxFileSize=integer,ParallelLoadThreads=integer,Password=string,Port=integer,ServerName=string,ServerTimezone=string,Username=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,ExecuteTimeout=integer,ServiceAccessRoleArn=string,AuthenticationMethod=string

JSON-запись:

{
  "AfterConnectScript": "string",
  "CleanSourceMetadataOnMismatch": true|false,
  "DatabaseName": "string",
  "EventsPollInterval": integer,
  "TargetDbType": "specific-database"|"multiple-databases",
  "MaxFileSize": integer,
  "ParallelLoadThreads": integer,
  "Password": "string",
  "Port": integer,
  "ServerName": "string",
  "ServerTimezone": "string",
  "Username": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "ExecuteTimeout": integer,
  "ServiceAccessRoleArn": "string",
  "AuthenticationMethod": "password"|"iam"
}

--oracle-settings (структура)

Настройки в формате JSON для источника и целевого Oracle-эндпоинта. Дополнительные доступные настройки см. в руководстве Database Migration Service User Guide в разделах "Дополнительные атрибуты подключения при использовании Oracle в качестве источника для DMS" и "Дополнительные атрибуты подключения при использовании Oracle в качестве целевого для DMS".

AddSupplementalLogging -> (boolean)

Установите этот атрибут для настройки дополнительного журналирования на уровне таблиц для базы данных Oracle. Этот атрибут включает дополнительное журналирование PRIMARY KEY для всех таблиц, выбранных для задачи миграции.

Если вы используете этот параметр, вам по-прежнему необходимо включить дополнительное журналирование на уровне базы данных.

ArchivedLogDestId -> (integer)

Указывает ID назначения для архивированных журналов перестроек. Это значение должно совпадать с числом в столбце dest_id представления v$archived_log. Если вы работаете с дополнительным назначением для журналов перестроек, используйте параметр AdditionalArchivedLogDestId для указания дополнительного ID назначения. Это повышает производительность, гарантируя, что с самого начала будут доступны правильные журналы.

AdditionalArchivedLogDestId -> (integer)

Установите этот атрибут с значением ArchivedLogDestId в настройке основного/резервного сервера. Этот атрибут полезен в случае переключения ролей. В этом случае DMS необходимо знать, из какого назначения получать архивные журналы перестроек для чтения изменений. Эта необходимость возникает, поскольку после переключения ролей предыдущий основной экземпляр становится резервным экземпляром.

Хотя DMS поддерживает использование параметра Oracle RESETLOGS для открытия базы данных, никогда не используйте RESETLOGS, если это не обязательно. Дополнительную информацию об RESETLOGS см. в разделе "Понятия восстановления данных RMAN" руководства Oracle Database Backup and Recovery User’s Guide.

ExtraArchivedLogDestIds -> (list)

Указывает ID дополнительных назначений для одного или нескольких архивированных журналов перестроек. Эти ID — значения столбца dest_id в представлении v$archived_log. Используйте эту настройку вместе с дополнительным атрибутом подключения archivedLogDestId в настройке основного сервера и одного резервного или основного сервера и нескольких резервных.

Эта настройка полезна при переключении ролей, когда источником является база данных Oracle Data Guard. В этом случае DMS нуждается в информации о том, из какого назначения получать архивные журналы перестроек для чтения изменений. DMS нуждается в этом, потому что после переключения ролей предыдущий основной экземпляр становится резервным. Например, в настройке основного сервера и одного резервного вы можете применить следующие настройки.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

В настройке основного сервера и нескольких резервных вы можете применить следующие настройки.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

(integer)

AllowSelectNestedTables -> (boolean)

Установите этот атрибут в true, чтобы включить репликацию таблиц Oracle, содержащих вложенные таблицы или определенные типы.

ParallelAsmReadThreads -> (integer)

Установите этот атрибут для изменения количества потоков, которые DMS настраивает для выполнения загрузки изменений данных (CDC) с использованием Oracle Automatic Storage Management (ASM). Вы можете указать целое число от 2 (по умолчанию) до 8 (максимум). Используйте этот атрибут вместе с атрибутом readAheadBlocks.

ReadAheadBlocks -> (integer)

Установите этот атрибут для изменения количества блоков предварительной выборки, которые DMS настраивает для выполнения загрузки изменений данных (CDC) с использованием Oracle Automatic Storage Management (ASM). Вы можете указать целое число от 1000 (по умолчанию) до 200 000 (максимум).

AccessAlternateDirectly -> (boolean)

Установите этот атрибут в false, чтобы использовать двоичный чтец для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это указывает экземпляру DMS не обращаться к журналам перестроек через указанный префикс пути с заменой, используя прямой доступ к файлам.

UseAlternateFolderForOnline -> (boolean)

Установите этот атрибут в true, чтобы использовать двоичный чтец для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это указывает экземпляру DMS использовать любую указанную замену префикса для доступа ко всем онлайн-журналам перестроек.

OraclePathPrefix -> (string)

Установите строковый атрибут в нужное значение, чтобы использовать двоичный чтец для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это значение задает корневой каталог Oracle по умолчанию для доступа к журналам перестроек.

UsePathPrefix -> (string)

Установите этот строковый атрибут в нужное значение, чтобы использовать двоичный чтец для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это значение задает префикс пути, используемый для замены корневого каталога Oracle по умолчанию для доступа к журналам перестроек.

ReplacePathPrefix -> (boolean)

Установите этот атрибут в значение true, чтобы использовать двоичный чтец для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Эта настройка указывает экземпляру DMS заменить корневой каталог Oracle по умолчанию указанным значением usePathPrefix для доступа к журналам перестроек.

EnableHomogenousTablespace -> (boolean)

Установите этот атрибут для включения репликации однородных табличных пространств и создания существующих таблиц или индексов в том же табличном пространстве на целевом сервере.

DirectPathNoLog -> (boolean)

При установке в true этот атрибут помогает увеличить скорость подтверждения на целевой базе данных Oracle, записывая данные непосредственно в таблицы, а не записывая журнал в журналы базы данных.

ArchivedLogsOnly -> (boolean)

При установке этого поля в True DMS обращается только к архивированным журналам перестроек. Если архивированные журналы перестроек хранятся только в Oracle Automatic Storage Management (ASM), учетная запись пользователя DMS должна иметь права ASM.

AsmPassword -> (string)

Для Oracle-эндпоинта источника — пароль Oracle Automatic Storage Management (ASM). Вы можете установить это значение из значения `` asm_user_password ``. Вы устанавливаете это значение как часть значения, разделенного запятыми, которое вы задаете для параметра запроса Password при создании эндпоинта для доступа к журналам транзакций с помощью Binary Reader. Дополнительную информацию см. в Конфигурация для захвата изменений данных (CDC) в базе данных Oracle-источника.

AsmServer -> (string)

Для Oracle-эндпоинта источника — адрес сервера ASM. Вы можете установить это значение из значения asm_server. Вы задаете asm_server как часть строки дополнительного атрибута подключения для доступа к серверу Oracle с Binary Reader, использующему ASM. Дополнительную информацию см. в Конфигурация для захвата изменений данных (CDC) в базе данных Oracle-источника.

AsmUser -> (string)

Для Oracle-эндпоинта источника — имя пользователя ASM. Вы можете установить это значение из значения asm_user. Вы задаете asm_user как часть строки дополнительного атрибута подключения для доступа к серверу Oracle с Binary Reader, использующему ASM. Дополнительную информацию см. в Конфигурация для захвата изменений данных (CDC) в базе данных Oracle-источника.

CharLengthSemantics -> (string)

Указывает, в байтах или символах хранится длина символьного столбца. Для указания того, что длина символьного столбца хранится в символах, установите этот атрибут в значение CHAR. В противном случае длина символьного столбца хранится в байтах.

Пример: charLengthSemantics=CHAR;

DatabaseName -> (string)

Имя базы данных для эндпоинта.

DirectPathParallelLoad -> (boolean)

При установке в true этот атрибут определяет параллельную загрузку, когда useDirectPathFullLoad установлено в Y. Этот атрибут также применяется только при использовании функции параллельной загрузки DMS. Обратите внимание, что целевая таблица не может иметь ограничений или индексов.

FailTasksOnLobTruncation -> (boolean)

При установке в true этот атрибут заставляет задачу завершаться неудачей, если фактический размер столбца LOB больше, чем заданный LobMaxSize.

Если задача настроена в ограниченном режиме LOB, а этот параметр установлен в true, задача завершается неудачей вместо усечения данных LOB.

NumberDatatypeScale -> (integer)

Указывает масштаб числа. Вы можете выбрать масштаб до 38 или FLOAT. По умолчанию тип данных NUMBER преобразуется в точность 38, масштаб 10.

Пример: numberDataTypeScale=12

Password -> (string)

Пароль подключения к эндпоинту.

Port -> (integer)

TCP-порт эндпоинта.

ReadTableSpaceName -> (boolean)

При установке в true этот атрибут поддерживает репликацию табличных пространств.

RetryInterval -> (integer)

Указывает количество секунд, которое система ждет перед повторной отправкой запроса.

Пример: retryInterval=6;

SecurityDbEncryption -> (string)

Для Oracle-эндпоинта источника — пароль прозрачного шифрования данных (TDE), необходимый AWM DMS для доступа к зашифрованным журналам перестроек Oracle с помощью Binary Reader. Также это часть значения, разделенного запятыми, которую вы задаете для параметра запроса Password при создании эндпоинта. Настройка SecurityDbEncryptian связана с настройкой SecurityDbEncryptionName. Дополнительную информацию см. в разделе "Поддерживаемые методы шифрования для использования Oracle в качестве источника для DMS" в руководстве Database Migration Service User Guide.

SecurityDbEncryptionName -> (string)

Для Oracle-эндпоинта источника — имя ключа, используемого для прозрачного шифрования данных (TDE) столбцов и табличных пространств в базе данных Oracle-источника, зашифрованной с помощью TDE. Значение ключа — значение настройки SecurityDbEncryption. Дополнительную информацию о настройке имени ключа SecurityDbEncryptionName, а также пример см. в разделе о настройке дополнительного атрибута подключения securityDbEncryptionName в "Поддерживаемые методы шифрования для использования Oracle в качестве источника для DMS" в руководстве Database Migration Service User Guide.

ServerName -> (string)

Полное доменное имя эндпоинта.

Для экземпляра Amazon RDS Oracle это вывод из DescribeDBInstances , в поле `` Endpoint .Address``.

SpatialDataOptionToGeoJsonFunctionName -> (string)

Используйте этот атрибут для преобразования данных SDO_GEOMETRY в формат GEOJSON. По умолчанию DMS вызывает пользовательскую функцию SDO2GEOJSON, если она присутствует и доступна. Или вы можете создать свою собственную пользовательскую функцию, которая имитирует работу SDOGEOJSON, и установить SpatialDataOptionToGeoJsonFunctionName для вызова ее вместо нее.

StandbyDelayTime -> (integer)

Используйте этот атрибут для указания времени в минутах для задержки синхронизации в режиме ожидания. Если источником является резервная база данных Oracle Active Data Guard, используйте этот атрибут для указания временного лага между основной и резервной базами данных.

В DMS вы можете создать задачу Oracle CDC, которая использует резервную инстанцию Active Data Guard в качестве источника для репликации текущих изменений. Это позволяет избежать необходимости подключения к активной базе данных, которая может находиться в производстве.

Username -> (строка)

Имя пользователя подключения к конечной точке.

UseBFile -> (логическое значение)

Установите этот атрибут в значение True, чтобы захватить данные изменений с помощью утилиты Binary Reader. Установите UseLogminerReader в значение False, чтобы установить этот атрибут в значение True. Для использования Binary Reader с Amazon RDS for Oracle в качестве источника, вы устанавливаете дополнительные атрибуты. Дополнительную информацию об использовании этого параметра с Oracle Automatic Storage Management (ASM) см. в разделе Использование Oracle LogMiner или DMS Binary Reader для CDC .

UseDirectPathFullLoad -> (логическое значение)

Установите этот атрибут в значение True, чтобы DMS использовал прямой полный загруз. Укажите это значение, чтобы использовать протокол прямой траектории в Oracle Call Interface (OCI). Используя этот протокол OCI, вы можете выполнить массовую загрузку таблиц Oracle-целей во время полной загрузки.

UseLogminerReader -> (логическое значение)

Установите этот атрибут в значение True для захвата данных изменений с помощью утилиты Oracle LogMiner (по умолчанию). Установите этот атрибут в значение False, если вы хотите получить доступ к журналам обратной записи как к двоичному файлу. Когда вы установите UseLogminerReader в значение False, также установите UseBfile в значение True. Дополнительную информацию об этом параметре и использовании Oracle ASM см. в разделе Использование Oracle LogMiner или DMS Binary Reader для CDC в руководстве пользователя DMS .

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенное лицо и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret . Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, который предоставляет доступ к конечной точке Oracle.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId . Или вы можете указать значения в открытом виде для UserName , Password , ServerName и Port . Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке Oracle.

SecretsManagerOracleAsmAccessRoleArn -> (строка)

Требуется только если ваша конечная точка Oracle использует Automatic Storage Management (ASM). Полный ARN роли IAM, которая указывает DMS как доверенное лицо и предоставляет необходимые разрешения для доступа к SecretsManagerOracleAsmSecret . Этот SecretsManagerOracleAsmSecret содержит секретное значение, которое позволяет получить доступ к Oracle ASM конечной точки.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerOracleAsmSecretId . Или вы можете указать значения в открытом виде для AsmUser , AsmPassword и AsmServerName . Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerOracleAsmSecret и требуемых для доступа к ней SecretsManagerOracleAsmAccessRoleArn и SecretsManagerOracleAsmSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerOracleAsmSecretId -> (строка)

Требуется только если ваша конечная точка Oracle использует Automatic Storage Management (ASM). Полный ARN, частичный ARN или понятное имя SecretsManagerOracleAsmSecret, содержащего данные подключения к Oracle ASM для конечной точки Oracle.

TrimSpaceInChar -> (логическое значение)

Используйте параметр конечной точки источника TrimSpaceInChar для обрезки данных типов CHAR и NCHAR во время миграции. Значение по умолчанию — true.

ConvertTimestampWithZoneToUTC -> (логическое значение)

При значении true выполняется преобразование временных меток с типом данных timezone в их значение UTC.

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

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

Вы можете указать целое число от 0 (значение по умолчанию) до 240 (максимальное значение).

Примечание

Этот параметр действителен только в версии DMS 3.5.0 и более поздних.

AuthenticationMethod -> (строка)

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

Сокращенная синтаксическая запись:

AddSupplementalLogging=boolean,ArchivedLogDestId=integer,AdditionalArchivedLogDestId=integer,ExtraArchivedLogDestIds=integer,integer,AllowSelectNestedTables=boolean,ParallelAsmReadThreads=integer,ReadAheadBlocks=integer,AccessAlternateDirectly=boolean,UseAlternateFolderForOnline=boolean,OraclePathPrefix=string,UsePathPrefix=string,ReplacePathPrefix=boolean,EnableHomogenousTablespace=boolean,DirectPathNoLog=boolean,ArchivedLogsOnly=boolean,AsmPassword=string,AsmServer=string,AsmUser=string,CharLengthSemantics=string,DatabaseName=string,DirectPathParallelLoad=boolean,FailTasksOnLobTruncation=boolean,NumberDatatypeScale=integer,Password=string,Port=integer,ReadTableSpaceName=boolean,RetryInterval=integer,SecurityDbEncryption=string,SecurityDbEncryptionName=string,ServerName=string,SpatialDataOptionToGeoJsonFunctionName=string,StandbyDelayTime=integer,Username=string,UseBFile=boolean,UseDirectPathFullLoad=boolean,UseLogminerReader=boolean,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,SecretsManagerOracleAsmAccessRoleArn=string,SecretsManagerOracleAsmSecretId=string,TrimSpaceInChar=boolean,ConvertTimestampWithZoneToUTC=boolean,OpenTransactionWindow=integer,AuthenticationMethod=string

Синтаксис JSON:

{
  "AddSupplementalLogging": true|false,
  "ArchivedLogDestId": integer,
  "AdditionalArchivedLogDestId": integer,
  "ExtraArchivedLogDestIds": [integer, ...],
  "AllowSelectNestedTables": true|false,
  "ParallelAsmReadThreads": integer,
  "ReadAheadBlocks": integer,
  "AccessAlternateDirectly": true|false,
  "UseAlternateFolderForOnline": true|false,
  "OraclePathPrefix": "string",
  "UsePathPrefix": "string",
  "ReplacePathPrefix": true|false,
  "EnableHomogenousTablespace": true|false,
  "DirectPathNoLog": true|false,
  "ArchivedLogsOnly": true|false,
  "AsmPassword": "string",
  "AsmServer": "string",
  "AsmUser": "string",
  "CharLengthSemantics": "default"|"char"|"byte",
  "DatabaseName": "string",
  "DirectPathParallelLoad": true|false,
  "FailTasksOnLobTruncation": true|false,
  "NumberDatatypeScale": integer,
  "Password": "string",
  "Port": integer,
  "ReadTableSpaceName": true|false,
  "RetryInterval": integer,
  "SecurityDbEncryption": "string",
  "SecurityDbEncryptionName": "string",
  "ServerName": "string",
  "SpatialDataOptionToGeoJsonFunctionName": "string",
  "StandbyDelayTime": integer,
  "Username": "string",
  "UseBFile": true|false,
  "UseDirectPathFullLoad": true|false,
  "UseLogminerReader": true|false,
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "SecretsManagerOracleAsmAccessRoleArn": "string",
  "SecretsManagerOracleAsmSecretId": "string",
  "TrimSpaceInChar": true|false,
  "ConvertTimestampWithZoneToUTC": true|false,
  "OpenTransactionWindow": integer,
  "AuthenticationMethod": "password"|"kerberos"
}

--sybase-settings (структура)

Параметры в формате JSON для конечных точек источника и целевого SAP ASE. Дополнительную информацию об остальных доступных параметрах см. в разделах Дополнительные атрибуты подключения при использовании SAP ASE в качестве источника для DMS и Дополнительные атрибуты подключения при использовании SAP ASE в качестве целевого сервера для DMS в руководстве пользователя Database Migration Service.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки. По умолчанию — 5000.

ServerName -> (строка)

Полное доменное имя конечной точки.

Username -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId . Или вы можете указать значения в открытом виде для UserName , Password , ServerName и Port . Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке SAP ASE.

Сокращенная синтаксическая запись:

DatabaseName=string,Password=string,Port=integer,ServerName=string,Username=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string

Синтаксис JSON:

{
  "DatabaseName": "string",
  "Password": "string",
  "Port": integer,
  "ServerName": "string",
  "Username": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string"
}

--microsoft-sql-server-settings (структура)

Настройки в формате JSON для источника и целевого узла Microsoft SQL Server. Дополнительные сведения о других доступных настройках см. в разделе "Дополнительные атрибуты подключения при использовании SQL Server в качестве источника для DMS" и "Дополнительные атрибуты подключения при использовании SQL Server в качестве целевого узла для DMS" в руководстве пользователя Database Migration Service.

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

TCP-порт конечной точки.

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

Максимальный размер пакетов (в байтах), используемых для передачи данных с помощью BCP.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

ControlTablesFileGroup -> (строка)

Указывает группу файлов для внутренних таблиц DMS. При запуске задачи репликации все внутренние таблицы управления DMS (awsdms_ apply_exception, awsdms_apply, awsdms_changes) создаются для указанной группы файлов.

Password -> (строка)

Пароль подключения к конечной точке.

QuerySingleAlwaysOnNode -> (булево)

Очищает и пересоздаёт метаданные таблицы в экземпляре репликации при возникновении несоответствия. Например, при выполнении оператора alter DDL для таблицы могут получиться различные сведения о таблице, кэшированные в экземпляре репликации.

ReadBackupOnly -> (булево)

Если этот атрибут установлен в значение Y , DMS считывает изменения только из резервных копий журнала транзакций и не считывает их из активного файла журнала транзакций во время текущей репликации. Установка этого параметра в значение Y позволяет управлять ростом активного файла журнала транзакций во время задач полного загрузки и текущей репликации. Однако это может добавить некоторую задержку в источнике для текущей репликации.

SafeguardPolicy -> (строка)

Используйте этот атрибут, чтобы свести к минимуму необходимость доступа к резервному журналу и позволить DMS предотвратить обрезку одним из двух следующих способов.

Начало транзакций в базе данных: Это метод по умолчанию. При использовании этого метода DMS предотвращает обрезку TLOG, имитируя транзакцию в базе данных. Пока такая транзакция открыта, изменения, появившиеся после начала транзакции, не обрезаются. Если вам нужна включенная Microsoft Replication в вашей базе данных, то вы должны выбрать этот метод.

Использование sp_repldone исключительно в рамках одной задачи: При использовании этого метода DMS считывает изменения, а затем использует sp_repldone для отметки транзакций TLOG как готовых к обрезке. Хотя этот метод не включает никаких транзакционных действий, он может использоваться только при отсутствии Microsoft Replication. Кроме того, при использовании этого метода только одна задача DMS может получить доступ к базе данных в любой момент времени. Поэтому, если вам нужно выполнять параллельные задачи DMS для одной базы данных, используйте метод по умолчанию.

ServerName -> (строка)

Полное доменное имя конечной точки. Для экземпляра Amazon RDS SQL Server это результат выполнения DescribeDBInstances в поле `` Endpoint .Address``.

Username -> (строка)

Имя пользователя подключения к конечной точке.

UseBcpFullLoad -> (булево)

Используйте этот атрибут для передачи данных для операций полной загрузки с помощью BCP. Если целевая таблица содержит столбец идентификатора, которого нет в исходной таблице, необходимо отключить опцию использования BCP для загрузки таблицы.

UseThirdPartyBackupDevice -> (булево)

Если этот атрибут установлен в значение Y , DMS обрабатывает резервные копии журнала транзакций сторонних производителей, если они созданы в родном формате.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенное лицо и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret . Роль должна разрешать действие iam:PassRole . SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке SQL Server.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId . Или вы можете указать значения в открытом виде для UserName , Password , ServerName и Port . Вы не можете указать оба варианта. Дополнительные сведения о создании этой SecretsManagerSecret и требуемых SecretsManagerAccessRoleArn и SecretsManagerSecretId для доступа к ней см. в руководстве пользователя Database Migration Service в разделе "Использование секретов для доступа к ресурсам Database Migration Service".

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret , содержащее данные подключения к конечной точке SQL Server.

TrimSpaceInChar -> (булево)

Используйте настройку источника конечной точки TrimSpaceInChar для обрезки справа данных типов данных CHAR и NCHAR во время миграции. Установка значения TrimSpaceInChar не обрезает данные слева. Значение по умолчанию — true.

TlogAccessMode -> (строка)

Указывает режим, используемый для извлечения данных CDC.

ForceLobLookup -> (булево)

Вынуждает поиск LOB встраиваемых LOB.

AuthenticationMethod -> (строка)

Указывает метод аутентификации, который будет использоваться с Microsoft SQL Server.

Сокращенная синтаксическая запись:

Port=integer,BcpPacketSize=integer,DatabaseName=string,ControlTablesFileGroup=string,Password=string,QuerySingleAlwaysOnNode=boolean,ReadBackupOnly=boolean,SafeguardPolicy=string,ServerName=string,Username=string,UseBcpFullLoad=boolean,UseThirdPartyBackupDevice=boolean,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,TrimSpaceInChar=boolean,TlogAccessMode=string,ForceLobLookup=boolean,AuthenticationMethod=string

Синтаксис JSON:

{
  "Port": integer,
  "BcpPacketSize": integer,
  "DatabaseName": "string",
  "ControlTablesFileGroup": "string",
  "Password": "string",
  "QuerySingleAlwaysOnNode": true|false,
  "ReadBackupOnly": true|false,
  "SafeguardPolicy": "rely-on-sql-server-replication-agent"|"exclusive-automatic-truncation"|"shared-automatic-truncation",
  "ServerName": "string",
  "Username": "string",
  "UseBcpFullLoad": true|false,
  "UseThirdPartyBackupDevice": true|false,
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "TrimSpaceInChar": true|false,
  "TlogAccessMode": "BackupOnly"|"PreferBackup"|"PreferTlog"|"TlogOnly",
  "ForceLobLookup": true|false,
  "AuthenticationMethod": "password"|"kerberos"
}

--ibm-db2-settings (структура)

Настройки в формате JSON для конечной точки источника IBM Db2 LUW. Дополнительные сведения о других доступных настройках см. в разделе "Дополнительные атрибуты подключения при использовании Db2 LUW в качестве источника для DMS" в руководстве пользователя Database Migration Service.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки. Значение по умолчанию — 50000.

ServerName -> (строка)

Полное доменное имя конечной точки.

SetDataCaptureChanges -> (булево)

Включает текущую репликацию (CDC) в виде булевого значения. По умолчанию значение true.

CurrentLsn -> (строка)

Для текущей репликации (CDC) используйте CurrentLSN для указания номера последовательности журнала (LSN), с которого нужно начать репликацию.

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

Максимальное количество байтов на чтение в виде числового значения. Значение по умолчанию — 64 КБ.

Username -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенное лицо и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret . Роль должна разрешать действие iam:PassRole . SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке Db2 LUW.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId . Или вы можете указать значения в открытом виде для UserName , Password , ServerName и Port . Вы не можете указать оба варианта. Дополнительные сведения о создании этой SecretsManagerSecret и требуемых SecretsManagerAccessRoleArn и SecretsManagerSecretId для доступа к ней см. в руководстве пользователя Database Migration Service в разделе "Использование секретов для доступа к ресурсам Database Migration Service".

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret , содержащее данные подключения к конечной точке Db2 LUW.

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

Время (в миллисекундах) ожидания DMS перед завершением операций, выполняемых DMS в целевом узле Db2. Значение по умолчанию — 1200 (20 минут).

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

Размер (в КБ) буфера записи в оперативной памяти, используемого при создании файлов .csv на локальном диске в экземпляре репликации DMS. Значение по умолчанию — 1024 (1 МБ).

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

Указывает максимальный размер (в КБ) файлов .csv, используемых для передачи данных в Db2 LUW.

KeepCsvFiles -> (булево)

Если значение true, DMS сохраняет все файлы .csv в целевой узел Db2 LUW, которые использовались для репликации данных. DMS использует эти файлы для анализа и устранения неполадок.

Значение по умолчанию — false.

Сокращенная синтаксическая запись:

DatabaseName=string,Password=string,Port=integer,ServerName=string,SetDataCaptureChanges=boolean,CurrentLsn=string,MaxKBytesPerRead=integer,Username=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,LoadTimeout=integer,WriteBufferSize=integer,MaxFileSize=integer,KeepCsvFiles=boolean

Синтаксис JSON:

{
  "DatabaseName": "string",
  "Password": "string",
  "Port": integer,
  "ServerName": "string",
  "SetDataCaptureChanges": true|false,
  "CurrentLsn": "string",
  "MaxKBytesPerRead": integer,
  "Username": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "LoadTimeout": integer,
  "WriteBufferSize": integer,
  "MaxFileSize": integer,
  "KeepCsvFiles": true|false
}

--resource-identifier (строка)

Понятное имя идентификатора ресурса в конце параметра EndpointArn ответа, возвращаемого в созданном объекте Endpoint . Значение этого параметра может содержать до 31 символа. Оно может содержать только ASCII-буквы, цифры и дефисы (‘-‘). Также оно не может заканчиваться дефисом или содержать два последовательных дефиса, и может начинаться только с буквы, например, Example-App-ARN1 . Например, это значение может привести к значению EndpointArn arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . Если вы не укажете значение ResourceIdentifier , DMS сгенерирует значение идентификатора по умолчанию для конца EndpointArn.

--doc-db-settings (структура)

Предоставляет информацию, определяющую конечную точку DocumentDB.

Имя пользователя -> (строка)

Имя пользователя, используемое для доступа к исходной конечной точке DocumentDB.

Пароль -> (строка)

Пароль для учетной записи пользователя, используемой для доступа к исходной конечной точке DocumentDB.

Имя сервера -> (строка)

Имя сервера на исходной конечной точке DocumentDB.

Порт -> (целое число)

Значение порта для исходной конечной точки DocumentDB.

Имя базы данных -> (строка)

Имя базы данных на исходной конечной точке DocumentDB.

Уровень вложенности -> (строка)

Определяет режим документа или таблицы.

Значение по умолчанию — "none". Укажите "none" для использования режима документов. Укажите "one" для использования режима таблиц.

Извлечь идентификатор документа -> (булево)

Определяет идентификатор документа. Используйте эту настройку, когда NestingLevel установлено в значение "none".

Значение по умолчанию — "false".

Документы для исследования -> (целое число)

Должно быть положительным значением, большим, чем 0. Значение по умолчанию — 1000.

Идентификатор ключа KMS -> (строка)

Идентификатор ключа KMS, используемый для шифрования содержимого на экземпляре репликации. Если вы не укажете значение для параметра KmsKeyId, DMS будет использовать ваш ключ шифрования по умолчанию. KMS создает ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У каждой учетной записи Amazon Web Services есть другой ключ шифрования по умолчанию для каждой области Amazon Web Services.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret имеет значение секрета Amazon Web Services Secrets Manager, который позволяет получить доступ к конечной точке DocumentDB.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба варианта. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service в разделе Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке DocumentDB.

Использовать обновление поиска -> (булево)

Если true, DMS извлекает весь документ из источника DocumentDB во время миграции. Это может привести к сбою миграции, если ответ сервера превысит пределы пропускной способности. Чтобы извлечь только обновления и удаления во время миграции, установите этот параметр в значение false.

Реплицировать наборы фрагментов -> (булево)

Если true, DMS реплицирует данные в наборы фрагментов. DMS использует эту настройку только в том случае, если целевая конечная точка — это кластер DocumentDB с возможностью масштабирования.

Когда эта настройка установлена в значение true, обратите внимание на следующее:

Вы должны установить TargetTablePrepMode в значение nothing.
DMS автоматически устанавливает useUpdateLookup в значение false.

Краткая запись:

Username=string,Password=string,ServerName=string,Port=integer,DatabaseName=string,NestingLevel=string,ExtractDocId=boolean,DocsToInvestigate=integer,KmsKeyId=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string,UseUpdateLookUp=boolean,ReplicateShardCollections=boolean

Синтаксис JSON:

{
  "Username": "string",
  "Password": "string",
  "ServerName": "string",
  "Port": integer,
  "DatabaseName": "string",
  "NestingLevel": "none"|"one",
  "ExtractDocId": true|false,
  "DocsToInvestigate": integer,
  "KmsKeyId": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string",
  "UseUpdateLookUp": true|false,
  "ReplicateShardCollections": true|false
}

--redis-settings (структура)

Настройки в формате JSON для целевой конечной точки Redis.

Имя сервера -> (строка)

Полное доменное имя конечной точки.

Порт -> (целое число)

Порт протокола TCP для конечной точки.

SslSecurityProtocol -> (строка)

Подключение к целевой конечной точке Redis с использованием TLS (Transport Layer Security). Допустимые значения включают plaintext и ssl-encryption. По умолчанию используется ssl-encryption. Вариант ssl-encryption создаёт зашифрованное соединение. Дополнительно вы можете указать Amazon Resource Name (ARN) для сертификата центра сертификации (CA) с помощью параметра SslCaCertificateArn. Если для CA не указан ARN, DMS использует корневой сертификат Amazon.

Вариант plaintext не обеспечивает шифрование TLS для трафика между конечной точкой и базой данных.

AuthType -> (строка)

Тип аутентификации при подключении к целевой конечной точке Redis. Доступны варианты none, auth-token и auth-role. Вариант auth-token требует предоставления значения AuthPassword. Вариант auth-role требует предоставления значений AuthUserName и AuthPassword.

AuthUserName -> (строка)

Имя пользователя, предоставленное с вариантом auth-role настройки AuthType для целевой конечной точки Redis.

AuthPassword -> (строка)

Пароль, предоставленный с вариантами auth-role и auth-token настройки AuthType для целевой конечной точки Redis.

SslCaCertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата центра сертификации (CA), который DMS использует для подключения к целевой конечной точке Redis.

Краткая запись:

ServerName=string,Port=integer,SslSecurityProtocol=string,AuthType=string,AuthUserName=string,AuthPassword=string,SslCaCertificateArn=string

Синтаксис JSON:

{
  "ServerName": "string",
  "Port": integer,
  "SslSecurityProtocol": "plaintext"|"ssl-encryption",
  "AuthType": "none"|"auth-role"|"auth-token",
  "AuthUserName": "string",
  "AuthPassword": "string",
  "SslCaCertificateArn": "string"
}

--gcp-my-sql-settings (структура)

Настройки в формате JSON для исходной конечной точки GCP MySQL.

AfterConnectScript -> (строка)

Указывает скрипт, который выполняется сразу после подключения DMS к конечной точке. Задача миграции продолжает работу независимо от того, успешно ли выполняется SQL-запрос или нет.

Для этого параметра укажите сам код скрипта, а не имя файла, содержащего скрипт.

CleanSourceMetadataOnMismatch -> (булево)

Очищает и воссоздаёт метаданные таблицы на экземпляре репликации при возникновении несоответствия. Например, в ситуации, когда выполнение alter DDL для таблицы может привести к разным данным о таблице, кэшированным в экземпляре репликации.

Имя базы данных -> (строка)

Имя базы данных для конечной точки. Для конечной точки MySQL-источника или -цели не указывайте явным образом базу данных с помощью параметра запроса DatabaseName в вызовах API CreateEndpoint или ModifyEndpoint. Указание DatabaseName при создании или изменении конечной точки MySQL реплицирует все таблицы задач в эту единственную базу данных. Для конечных точек MySQL базу данных указывают только при указании схемы в правилах сопоставления таблиц задачи DMS.

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

Указывает, как часто проверять бинарный журнал на наличие новых изменений/событий, когда база данных бездействует. По умолчанию — пять секунд.

Пример: eventsPollInterval=5;

В примере DMS проверяет изменения в бинарных журналах каждые пять секунд.

TargetDbType -> (строка)

Указывает, куда мигрировать исходные таблицы на целевой стороне, в одну базу данных или несколько баз данных.

Пример: targetDbType=MULTIPLE_DATABASES

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

Указывает максимальный размер (в КБ) любого файла .csv, используемого для передачи данных в базу данных, совместимую с MySQL.

Пример: maxFileSize=512

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

Повышает производительность при загрузке данных в целевую базу данных, совместимую с MySQL. Указывает количество потоков для загрузки данных в целевую базу данных, совместимую с MySQL. Установка большого количества потоков может отрицательно сказаться на производительности базы данных, так как для каждого потока требуется отдельное подключение. По умолчанию — один.

Пример: parallelLoadThreads=1

Пароль -> (строка)

Пароль для подключения к конечной точке.

Порт -> (целое число)

Порт TCP конечной точки.

Имя сервера -> (строка)

Имя хоста MySQL.

ServerTimezone -> (строка)

Указывает часовой пояс для исходной базы данных MySQL.

Пример: serverTimezone=US/Pacific;

Примечание: не заключайте часовые пояса в одинарные кавычки.

Имя пользователя -> (строка)

Имя пользователя для подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret.. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret имеет значение секрета Amazon Web Services Secrets Manager, который позволяет получить доступ к конечной точке MySQL.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба варианта. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service в разделе Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке MySQL.

Краткая запись:

AfterConnectScript=string,CleanSourceMetadataOnMismatch=boolean,DatabaseName=string,EventsPollInterval=integer,TargetDbType=string,MaxFileSize=integer,ParallelLoadThreads=integer,Password=string,Port=integer,ServerName=string,ServerTimezone=string,Username=string,SecretsManagerAccessRoleArn=string,SecretsManagerSecretId=string

Синтаксис JSON:

{
  "AfterConnectScript": "string",
  "CleanSourceMetadataOnMismatch": true|false,
  "DatabaseName": "string",
  "EventsPollInterval": integer,
  "TargetDbType": "specific-database"|"multiple-databases",
  "MaxFileSize": integer,
  "ParallelLoadThreads": integer,
  "Password": "string",
  "Port": integer,
  "ServerName": "string",
  "ServerTimezone": "string",
  "Username": "string",
  "SecretsManagerAccessRoleArn": "string",
  "SecretsManagerSecretId": "string"
}

--timestream-settings (структура)

Настройки в формате JSON для целевого конечного пункта Amazon Timestream.

DatabaseName -> (строка)

Имя базы данных для конечного пункта.

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

Установите этот атрибут, чтобы указать время хранения всех таблиц в памяти, которые импортируются в Amazon Timestream из исходной базы данных. Время измеряется в часах. Когда данные Timestream поступают, они сначала хранятся в памяти в течение указанного периода, что позволяет быстро получить к ним доступ.

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

Установите этот атрибут, чтобы указать значение по умолчанию для магнитного периода, применяемого к таблицам Amazon Timestream в днях. Это количество дней, в течение которых записи хранятся в магнитном хранилище, прежде чем будут удалены. Для получения дополнительной информации см. раздел Хранение в Руководстве разработчика Amazon Timestream.

CdcInsertsAndUpdates -> (логическое значение)

Установите этот атрибут в true, чтобы указать, что DMS применяет только операции вставки и обновления, а не удаления. Amazon Timestream не позволяет удалять записи, поэтому если это значение равно false, DMS обнуляет соответствующую запись в базе данных Timestream вместо ее удаления.

EnableMagneticStoreWrites -> (логическое значение)

Установите этот атрибут в true, чтобы включить запись в хранилище памяти. Когда это значение равно false, DMS не записывает записи, которые старше, чем значение, указанное в MagneticDuration, потому что Amazon Timestream по умолчанию не позволяет запись в память. Для получения дополнительной информации см. раздел Хранение в Руководстве разработчика Amazon Timestream.

Сокращенная запись:

DatabaseName=string,MemoryDuration=integer,MagneticDuration=integer,CdcInsertsAndUpdates=boolean,EnableMagneticStoreWrites=boolean

Синтаксис JSON:

{
  "DatabaseName": "string",
  "MemoryDuration": integer,
  "MagneticDuration": integer,
  "CdcInsertsAndUpdates": true|false,
  "EnableMagneticStoreWrites": true|false
}

--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
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для создания конечного пункта

Следующий пример create-endpoint создает конечный пункт для исходного источника Amazon S3.

aws dms create-endpoint \
    --endpoint-type source \
    --engine-name s3 \
    --endpoint-identifier src-endpoint \
    --s3-settings file://s3-settings.json

Содержимое s3-settings.json:

{
    "BucketName":"my-corp-data",
    "BucketFolder":"sourcedata",
    "ServiceAccessRoleArn":"arn:aws:iam::123456789012:role/my-s3-access-role"
}

Вывод:

{
    "Endpoint": {
        "EndpointIdentifier": "src-endpoint",
        "EndpointType": "SOURCE",
        "EngineName": "s3",
        "EngineDisplayName": "Amazon S3",
        "ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;",
        "Status": "active",
        "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U",
        "SslMode": "none",
        "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
        "S3Settings": {
            "ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
            "CsvRowDelimiter": "\\n",
            "CsvDelimiter": ",",
            "BucketFolder": "sourcedata",
            "BucketName": "my-corp-data",
            "CompressionType": "NONE",
            "EnableStatistics": true
        }
    }
}

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

Вывод

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

Созданный конечный пункт.

EndpointIdentifier -> (строка)

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

EndpointType -> (строка)

Тип конечного пункта. Допустимые значения — source и target.

EngineName -> (строка)

Имя движка базы данных. Допустимые значения, в зависимости от EndpointType, включают "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "redshift" , "redshift-serverless" , "s3" , "db2" , "db2-zos" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , "neptune" и "babelfish".

EngineDisplayName -> (строка)

Расширенное имя для имени движка. Например, если параметр EngineName равен «aurora», это значение будет «Amazon Aurora MySQL».

Username -> (строка)

Имя пользователя, используемое для подключения к конечной точке.

ServerName -> (строка)

Имя сервера в конечной точке.

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

Значение порта, используемого для доступа к конечной точке.

DatabaseName -> (строка)

Имя базы данных в конечной точке.

ExtraConnectionAttributes -> (строка)

Дополнительные атрибуты подключения, используемые для подключения к конечной точке.

Status -> (строка)

Состояние конечной точки.

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для шифрования параметров подключения для конечной точки.

Если вы не укажете значение для параметра KmsKeyId, DMS будет использовать ваш ключ шифрования по умолчанию.

KMS создает ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У каждой учетной записи Amazon Web Services в каждом регионе Amazon Web Services есть отдельный ключ шифрования по умолчанию.

EndpointArn -> (строка)

Строка Amazon Resource Name (ARN), которая уникально идентифицирует конечную точку.

CertificateArn -> (строка)

Amazon Resource Name (ARN), используемый для SSL-соединения с конечной точкой.

SslMode -> (строка)

Режим SSL, используемый для подключения к конечной точке. Значение по умолчанию — none.

ServiceAccessRoleArn -> (строка)

Amazon Resource Name (ARN), используемый сервисом для доступа к роли IAM. Роль должна разрешать действие iam:PassRole.

ExternalTableDefinition -> (строка)

Определение внешней таблицы.

ExternalId -> (строка)

Значение, возвращаемое вызовом CreateEndpoint, которое может использоваться для проверки между аккаунтами. Используйте его в последующем вызове CreateEndpoint для создания конечной точки между аккаунтами.

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

Настройки для конечной точки DynamoDB. Для получения дополнительной информации см. структуру DynamoDBSettings.

ServiceAccessRoleArn -> (строка)

Amazon Resource Name (ARN), используемый сервисом для доступа к роли IAM. Роль должна разрешать действие iam:PassRole.

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

Настройки конечной точки S3-цели. Дополнительную информацию см. в структуре S3Settings.

ServiceAccessRoleArn -> (строка)

Используемый службой Amazon Resource Name (ARN) для доступа к роли IAM. Роль должна разрешать действие iam:PassRole. Это обязательный параметр, который позволяет DMS записывать и читать объекты из ведра S3.

ExternalTableDefinition -> (строка)

Определяет, как таблицы определяются только в исходных файлах S3.

CsvRowDelimiter -> (строка)

Разделитель строк в файле .csv для источника и цели. По умолчанию используется перевод строки (\n).

CsvDelimiter -> (строка)

Разделитель столбцов в файле .csv для источника и цели. По умолчанию используется запятая.

BucketFolder -> (строка)

Необязательный параметр для установки имени папки в ведре S3. Если указан, таблицы создаются в пути `` bucketFolder /schema_name /table_name /`` . Если этот параметр не указан, используется путь `` schema_name /table_name /`` .

BucketName -> (строка)

Имя ведра S3.

CompressionType -> (строка)

EncryptionMode -> (строка)

Тип шифрования на стороне сервера, который вы хотите использовать для своих данных. Этот тип шифрования является частью настроек конечной точки или дополнительных атрибутов подключений для Amazon S3. Вы можете выбрать либо SSE_S3 (по умолчанию), либо SSE_KMS.

Примечание

Для операции ModifyEndpoint вы можете изменить существующее значение параметра EncryptionMode со значения SSE_KMS на SSE_S3. Но вы не можете изменить существующее значение со значения SSE_S3 на SSE_KMS.

Чтобы использовать SSE_S3, вам нужна роль Identity and Access Management (IAM) с разрешением на использование "arn:aws:s3:::dms-*" следующих действий:

s3:CreateBucket
s3:ListBucket
s3:DeleteBucket
s3:GetBucketLocation
s3:GetObject
s3:PutObject
s3:DeleteObject
s3:GetObjectVersion
s3:GetBucketPolicy
s3:PutBucketPolicy
s3:DeleteBucketPolicy

ServerSideEncryptionKmsKeyId -> (строка)

Если вы используете SSE_KMS для EncryptionMode, укажите идентификатор KMS-ключа. Используемый ключ должен иметь прикрепленную политику, которая разрешает разрешения пользователей Identity and Access Management (IAM) и позволяет использовать ключ.

DataFormat -> (строка)

Формат данных, который вы хотите использовать для вывода. Вы можете выбрать один из следующих:

csv: Это формат файла на основе строк со значениями, разделенными запятыми (.csv).
parquet: Apache Parquet (.parquet) — это столбцовый формат файла хранения, который обеспечивает эффективное сжатие и ускоряет ответы на запросы.

EncodingType -> (строка)

Тип используемого кодирования:

RLE_DICTIONARY использует сочетание битового упаковывания и кодирования по длине последовательности для более эффективного хранения повторяющихся значений. Это значение по умолчанию.
PLAIN вообще не использует кодирование. Значения сохраняются в исходном виде.
PLAIN_DICTIONARY создает словарь встреченных значений в заданном столбце. Словарь хранится в странице словаря для каждого фрагмента столбца.

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

Максимальный размер страницы закодированного словаря столбца. Если размер страницы словаря превышает это значение, этот столбец сохраняется с типом кодирования PLAIN. По умолчанию этот параметр равен 1024 * 1024 байта (1 МБ), максимальный размер страницы словаря перед переходом к кодированию PLAIN. Этот размер используется только для формата файлов .parquet.

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

Количество строк в группе строк. Более меньший размер группы строк обеспечивает более быстрый доступ. Но по мере увеличения числа групп строк скорость записи замедляется. По умолчанию этот параметр равен 10 000 строк. Это число используется только для формата файлов .parquet.

Если вы выберете значение, превышающее максимальное значение, RowGroupLength устанавливается в максимальную длину группы строк в байтах (64 * 1024 * 1024).

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

Размер одной страницы данных в байтах. По умолчанию этот параметр равен 1024 * 1024 байта (1 МБ). Это число используется только для формата файлов .parquet.

ParquetVersion -> (строка)

Версия формата Apache Parquet, которую вы хотите использовать: parquet_1_0 (по умолчанию) или parquet_2_0.

EnableStatistics -> (логическое значение)

Значение, которое включает статистику для страниц и групп строк Parquet. Выберите true для включения статистики, false для отключения. Статистика включает значения NULL, DISTINCT, MAX и MIN. По умолчанию это значение равно true. Это значение используется только для формата файлов .parquet.

IncludeOpForFullLoad -> (логическое значение)

Значение, которое включает полную загрузку для записи операций INSERT в файлы вывода со значениями, разделенными запятыми (.csv), или .parquet, чтобы указать, как строки были добавлены в базу данных источника.

Примечание

DMS поддерживает параметр IncludeOpForFullLoad в версиях 3.1.4 и более поздних.

DMS поддерживает использование файлов .parquet с параметром IncludeOpForFullLoad в версиях 3.4.7 и более поздних.

Для полной загрузки записи могут быть только вставлены. По умолчанию (настройка false) никакая информация не записывается в эти выходные файлы для полной загрузки, чтобы указать, что строки были вставлены в базу данных источника. Если IncludeOpForFullLoad установлено в значения true или y, вставка записывается как аннотация I в первом поле файла .csv. Это позволяет сделать формат ваших целевых записей из полной загрузки согласованным с целевыми записями из загрузки CDC.

Примечание

Эта настройка работает совместно с параметрами CdcInsertsOnly и CdcInsertsAndUpdates для вывода только в файлы .csv. Дополнительную информацию о работе этих настроек вместе см. в разделе «Указание операций базы данных источника в мигрированных данных S3» в руководстве пользователя службы миграции баз данных.

CdcInsertsOnly -> (логическое значение)

Значение, которое включает загрузку захвата изменений (CDC) для записи только операций INSERT в выходные файлы .csv или столбцового хранилища (.parquet). По умолчанию (настройка false) первое поле в записи .csv или .parquet содержит букву I (INSERT), U (UPDATE) или D (DELETE). Эти значения указывают, была ли строка вставлена, обновлена или удалена в базе данных источника для загрузки CDC в цель.

Если CdcInsertsOnly установлено в значение true или y, в файл .csv или .parquet мигрируются только вставки из базы данных источника. Только для формата .csv способ записи этих вставок зависит от значения IncludeOpForFullLoad. Если IncludeOpForFullLoad установлено в значение true, первое поле каждой записи CDC устанавливается в I для обозначения операции INSERT в источнике. Если IncludeOpForFullLoad установлено в значение false, каждая запись CDC записывается без первого поля для обозначения операции INSERT в источнике. Дополнительную информацию о работе этих настроек вместе см. в разделе «Указание операций базы данных источника в мигрированных данных S3» в руководстве пользователя службы миграции баз данных.

Примечание

DMS поддерживает взаимодействие, описанное выше, между параметрами CdcInsertsOnly и IncludeOpForFullLoad в версиях 3.1.4 и более поздних.

CdcInsertsOnly и CdcInsertsAndUpdates не могут быть одновременно установлены в значение true для одной конечной точки. Установите либо CdcInsertsOnly, либо CdcInsertsAndUpdates в значение true для одной конечной точки, но не оба.

TimestampColumnName -> (строка)

Значение, которое, если оно не пустое, заставляет DMS добавлять столбец со временем в данные конечной точки для целевой конечной точки Amazon S3.

Примечание

DMS поддерживает параметр TimestampColumnName в версиях 3.1.4 и более поздних.

DMS включает дополнительный столбец STRING в файлы .csv или .parquet ваших мигрированных данных, когда вы устанавливаете TimestampColumnName в ненулевое значение.

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

Для загрузки захвата изменений (CDC) каждая строка столбца времени содержит отметку времени подтверждения этой строки в базе данных источника.

Формат строки для этого значения столбца времени — yyyy-MM-dd HH:mm:ss.SSSSSS. По умолчанию точность этого значения составляет микросекунды. Для загрузки CDC округление точности зависит от отметки времени подтверждения, поддерживаемой DMS для базы данных источника.

Когда параметр AddColumnName установлен в значение true, DMS также включает имя столбца времени, которое вы задали с помощью TimestampColumnName.

ParquetTimestampInMillisecond -> (логическое значение)

Значение, определяющее точность значений любых столбцов TIMESTAMP, которые записываются в файл объекта Amazon S3 в формате .parquet.

Примечание

DMS поддерживает параметр ParquetTimestampInMillisecond в версиях 3.1.4 и выше.

Когда ParquetTimestampInMillisecond установлено в true или y , DMS записывает все столбцы TIMESTAMP в файле формата .parquet с миллисекундной точностью. В противном случае DMS записывает их с микросекундной точностью.

В настоящее время Amazon Athena и Glue могут обрабатывать только миллисекундную точность для значений TIMESTAMP. Установите этот параметр в значение true для файлов объектов S3-эндпоинта в формате .parquet только в том случае, если вы планируете запросы или обработку данных с помощью Athena или Glue.

Примечание

DMS записывает любые значения столбцов TIMESTAMP, записанные в файл S3 в формате .csv, с микросекундной точностью.

Установка ParquetTimestampInMillisecond не влияет на строчный формат значения столбца timestamp, который вставляется с помощью параметра TimestampColumnName.

CdcInsertsAndUpdates -> (boolean)

Значение, которое включает загрузку захвата изменений (CDC) для записи операций INSERT и UPDATE в выходные файлы .csv или .parquet (колоночная структура). Значение по умолчанию — false, но когда CdcInsertsAndUpdates установлено в true или y , только INSERTы и UPDATEы из исходной базы данных мигрируются в файл .csv или .parquet.

Предупреждение

DMS поддерживает использование файлов .parquet в версиях 3.4.7 и выше.

Как записываются эти INSERTы и UPDATEы зависит от значения параметра IncludeOpForFullLoad. Если IncludeOpForFullLoad установлено в true , первое поле каждого записывается либо I, либо U, чтобы указать операции INSERT и UPDATE в источнике. Но если IncludeOpForFullLoad установлено в false , записи CDC записываются без указания операций INSERT или UPDATE в источнике. Для получения дополнительной информации о том, как эти параметры работают вместе, см. Указание операций исходной БД в мигрированных данных S3 в Руководстве пользователя Database Migration Service. .

Примечание

DMS поддерживает использование параметра CdcInsertsAndUpdates в версиях 3.3.1 и выше.

CdcInsertsOnly и CdcInsertsAndUpdates не могут быть одновременно установлены в true для одного и того же конечного пункта. Установите либо CdcInsertsOnly, либо CdcInsertsAndUpdates в значение true для одного и того же конечного пункта, но не оба.

DatePartitionEnabled -> (boolean)

При установке в значение true, этот параметр разделяет папки ведра S3 на основе дат подтверждения транзакций. Значение по умолчанию — false. Для получения дополнительной информации о разделении папок по датам, см. Использование разделения папок по датам.

DatePartitionSequence -> (string)

DatePartitionDelimiter -> (string)

Указывает разделитель даты для использования при разделении папок. Значение по умолчанию — SLASH. Используйте этот параметр, когда DatePartitionedEnabled установлено в true.

UseCsvNoSupValue -> (boolean)

Это настройка применяется, если выходные файлы S3 во время загрузки захвата изменений (CDC) записываются в формате .csv. Если установлено в значение true для столбцов, не включённых в дополнительный журнал, DMS использует значение, указанное параметром ` CsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue`__ . Если не установлено или установлено в false, DMS использует значение null для этих столбцов.

Примечание

Эта настройка поддерживается в версиях DMS 3.4.1 и выше.

CsvNoSupValue -> (string)

Это настройка применяется только если выходные файлы Amazon S3 во время загрузки захвата изменений (CDC) записываются в формате .csv. Если ` UseCsvNoSupValue https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue`__ установлено в true, укажите строковое значение, которое вы хотите, чтобы DMS использовал для всех столбцов, не включённых в дополнительный журнал. Если вы не укажете строковое значение, DMS использует значение null для этих столбцов независимо от параметра UseCsvNoSupValue.

Примечание

Эта настройка поддерживается в версиях DMS 3.4.1 и выше.

PreserveTransactions -> (boolean)

Если установлено в true, DMS сохраняет порядок транзакций для загрузки захвата изменений (CDC) на целевом Amazon S3, указанном параметром ` CdcPath https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath`__ . Для получения дополнительной информации см. Захват изменений данных (CDC), включая порядок транзакций, на целевом S3.

Примечание

Эта настройка поддерживается в версиях DMS 3.4.2 и выше.

CdcPath -> (string)

Указывает путь к папке файлов CDC. Для источника S3 этот параметр обязателен, если задача захватывает изменения данных; в противном случае — необязателен. Если CdcPath задан, DMS считывает файлы CDC из этого пути и реплицирует изменения данных на целевой конечный пункт. Для целевого S3, если вы установите ` PreserveTransactions https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions`__ в true, DMS проверит, что вы установили этот параметр в путь к папке на вашем целевом S3, где DMS может сохранить порядок транзакций для загрузки CDC. DMS создаёт этот путь к папке CDC либо в вашей рабочей директории S3, либо в местоположении целевого S3, указанном параметрами ` BucketFolder https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder`__ и ` BucketName https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName`__.

Например, если вы укажете CdcPath как MyChangedData, и укажете BucketName как MyTargetBucket, но не укажете BucketFolder, DMS создаст путь к папке CDC, следуя: MyTargetBucket/MyChangedData.

Если вы укажете тот же CdcPath, и укажете BucketName как MyTargetBucket и BucketFolder как MyTargetData, DMS создаст путь к папке CDC, следуя: MyTargetBucket/MyTargetData/MyChangedData.

Для получения дополнительной информации о CDC, включая порядок транзакций на целевом S3, см. Захват изменений данных (CDC), включая порядок транзакций, на целевом S3.

Примечание

Эта настройка поддерживается в версиях DMS 3.4.2 и выше.

UseTaskStartTimeForFullLoadTimestamp -> (boolean)

При установке в значение true этот параметр использует время запуска задачи в качестве значения столбца timestamp вместо времени записи данных на целевой объект. Для полной загрузки, когда useTaskStartTimeForFullLoadTimestamp установлено в true, каждая строка столбца timestamp содержит время запуска задачи. Для загрузки CDC каждая строка столбца timestamp содержит время подтверждения транзакции.

Когда useTaskStartTimeForFullLoadTimestamp установлено в false, метка времени полной загрузки в столбце timestamp увеличивается по мере поступления данных на целевой объект.

CannedAclForObjects -> (string)

Значение, которое позволяет DMS указывать предопределенный (canned) список управления доступом для объектов, созданных в ведре Amazon S3 в качестве файлов .csv или .parquet. Для получения дополнительной информации об Amazon S3 canned ACL, см. Canned ACL в Руководстве разработчика Amazon S3.

AddColumnName -> (boolean)

Необязательный параметр, который при установке в true или y позволяет добавить информацию о имени столбца в выходной файл .csv.

Значение по умолчанию — false. Допустимые значения — true, false, y и n.

CdcMaxBatchInterval -> (integer)

Максимальная длина интервала, определяемая в секундах, после которой файл выводится в Amazon S3.

Когда CdcMaxBatchInterval и CdcMinFileSize оба указаны, запись файла запускается по условию параметра, которое выполняется первым в шаблоне DMS CloudFormation.

Значение по умолчанию — 60 секунд.

CdcMinFileSize -> (integer)

Минимальный размер файла, определяемый в килобайтах, для достижения которого файл выводится в Amazon S3.

Когда CdcMinFileSize и CdcMaxBatchInterval оба указаны, запись файла запускается по условию параметра, которое выполняется первым в шаблоне DMS CloudFormation.

Значение по умолчанию — 32 МБ.

CsvNullValue -> (string)

Необязательный параметр, который определяет, как DMS обрабатывает значения null. При обработке значения null, вы можете использовать этот параметр для передачи пользовательской строки как null при записи в целевой объект. Например, при наличии nullable столбцов в целевой базе данных, вы можете использовать этот параметр для различения пустой строки и значения null. Поэтому, если вы установите это значение параметра в пустую строку ("" или ''), DMS будет рассматривать пустую строку как значение null, а не NULL.

Значение по умолчанию — NULL. Допустимые значения — любые допустимые строки.

IgnoreHeaderRows -> (integer)

Когда это значение установлено в 1, DMS игнорирует первую строку заголовка в файле .csv. Значение 1 включает функцию; значение 0 — выключает.

Значение по умолчанию — 0.

MaxFileSize -> (integer)

Значение, определяющее максимальный размер (в КБ) любого файла .csv, который будет создан при миграции на целевой S3 во время полной загрузки.

Значение по умолчанию — 1 048 576 КБ (1 ГБ). Допустимые значения — от 1 до 1 048 576.

Rfc4180 -> (boolean)

Для источника S3, когда это значение установлено в true или y, каждая ведущая двойная кавычка должна следовать за завершающей двойной кавычкой. Этот формат соответствует RFC 4180. Когда это значение установлено в false или n, строковые литералы копируются в целевой ресурс как есть. В этом случае разделитель (строка или столбец) сигнализирует об окончании поля. Таким образом, вы не можете использовать разделитель как часть строки, потому что он сигнализирует об окончании значения.

Для целевого источника S3, необязательный параметр, используемый для настройки поведения в соответствии с RFC 4180 для данных, мигрированных в Amazon S3 только в формате .csv. Когда это значение установлено в true или y с использованием Amazon S3 в качестве целевого источника, если данные содержат кавычки или символы новой строки, DMS включает весь столбец в дополнительные пары двойных кавычек («). Каждая кавычка внутри данных повторяется дважды.

Значение по умолчанию — true. Допустимые значения включают true, false, y и n.

DatePartitionTimezone -> (строка)

При создании целевого конечного пункта S3, установите DatePartitionTimezone для преобразования текущего времени UTC в указанную часовую зону. Преобразование выполняется при создании папки раздела дат и генерации имени файла CDC. Формат часовой зоны — Area/Location. Используйте этот параметр, когда DatePartitionedEnabled установлено в true, как показано в следующем примере.

s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":"*Asia/Seoul* ", "BucketName": "dms-nattarat-test"}'

AddTrailingPaddingCharacter -> (булево)

Используйте параметр целевого конечного пункта S3 AddTrailingPaddingCharacter для добавления заполнения к строковым данным. Значение по умолчанию — false.

ExpectedBucketOwner -> (строка)

Для указания владельца корзины и предотвращения «sniping» можно использовать параметр конечного пункта ExpectedBucketOwner.

Пример: --s3-settings='{"ExpectedBucketOwner": "*AWS_Account_ID* "}'

При запросе для тестирования подключения или выполнения миграции S3 проверяет идентификатор учетной записи владельца корзины по отношению к указанному параметру.

GlueCatalogGeneration -> (булево)

При значении true, позволяет Glue каталогизировать вашу корзину S3. Создание каталога Glue позволяет использовать Athena для запроса ваших данных.

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

Настройки для источника типа DMS Transfer. Дополнительная информация приведена в структуре DmsTransferSettings.

ServiceAccessRoleArn -> (строка)

Идентификатор Amazon Resource Name (ARN), используемый ролью доступа к сервису IAM. Роль должна разрешать действие iam:PassRole.

BucketName -> (строка)

Имя корзины S3 для использования.

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

Настройки для конечного пункта источника MongoDB. Дополнительная информация приведена в структуре MongoDbSettings.

Username -> (строка)

Имя пользователя, используемое для доступа к конечному пункту источника MongoDB.

Password -> (строка)

Пароль учетной записи пользователя для доступа к конечному пункту источника MongoDB.

ServerName -> (строка)

Имя сервера конечного пункта источника MongoDB. Для MongoDB Atlas укажите имя сервера для любого из серверов в наборе репликации.

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

Значение порта для конечного пункта источника MongoDB.

DatabaseName -> (строка)

Имя базы данных конечного пункта источника MongoDB.

AuthType -> (строка)

Тип аутентификации, используемый для доступа к конечному пункту источника MongoDB.

При установке значения в "no", параметры имени пользователя и пароля не используются и могут быть пустыми.

AuthMechanism -> (строка)

Механизм аутентификации, используемый для доступа к конечному пункту источника MongoDB.

Для значения по умолчанию, в MongoDB версии 2.x, "default" имеет значение "mongodb_cr". Для MongoDB версии 3.x или новее, "default" имеет значение "scram_sha_1". Это значение не используется, когда AuthType установлено в "no".

NestingLevel -> (строка)

Указывает режим документа или таблицы.

ExtractDocId -> (строка)

Указывает идентификатор документа. Используйте эту настройку, когда NestingLevel установлено в "none".

Значение по умолчанию — "false".

DocsToInvestigate -> (строка)

Должно быть положительным значением, большим чем 0. Значение по умолчанию — 1000.

AuthSource -> (строка)

Имя базы данных MongoDB. Это значение не используется, когда AuthType установлено в "no".

Значение по умолчанию — "admin".

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для шифрования содержимого на экземпляре репликации. Если вы не укажете значение для параметра KmsKeyId, DMS использует ваш ключ шифрования по умолчанию. KMS создаёт ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У вашей учетной записи Amazon Web Services есть отдельный ключ шифрования по умолчанию для каждой зоны Amazon Web Services.

SecretsManagerAccessRoleArn -> (строка)

Полный идентификатор Amazon Resource Name (ARN) роли IAM, указывающей DMS в качестве доверенного субъекта и предоставляющей необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечному пункту MongoDB.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Для получения более подробной информации о создании этой SecretsManagerSecret и требуемых SecretsManagerAccessRoleArn и SecretsManagerSecretId для доступа к ней, см. Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечному пункту MongoDB.

UseUpdateLookUp -> (булево)

Если true, DMS извлекает весь документ из источника MongoDB во время миграции. Это может привести к ошибке миграции, если ответ сервера превышает лимиты пропускной способности. Для извлечения только обновлений и удалений во время миграции установите этот параметр в false.

ReplicateShardCollections -> (булево)

Если true, DMS реплицирует данные в разделы коллекций. DMS использует эту настройку только в том случае, если целевой конечный пункт — это кластер DocumentDB elastic.

Когда эта настройка true, обратите внимание на следующее:

Вы должны установить TargetTablePrepMode в nothing.
DMS автоматически устанавливает useUpdateLookup в false.

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

Настройки для целевого конечного пункта Amazon Kinesis. Дополнительная информация приведена в структуре KinesisSettings.

StreamArn -> (строка)

Идентификатор Amazon Resource Name (ARN) для конечного пункта Amazon Kinesis Data Streams.

MessageFormat -> (строка)

Формат вывода записей, созданных на конечном пункте. Формат сообщения — JSON (по умолчанию) или JSON_UNFORMATTED (одна строка без табуляции).

ServiceAccessRoleArn -> (строка)

Идентификатор Amazon Resource Name (ARN) для роли IAM, которую DMS использует для записи в поток данных Kinesis. Роль должна разрешать действие iam:PassRole.

IncludeTransactionDetails -> (булево)

Предоставляет подробную информацию о транзакции из исходной базы данных. Эта информация включает временную метку подтверждения, позицию журнала и значения для transaction_id, предыдущего transaction_id и transaction_record_id (смещение записи внутри транзакции). Значение по умолчанию — false.

IncludePartitionValue -> (булево)

Отображает значение раздела в выводе сообщения Kinesis, если тип раздела не является schema-table-type. Значение по умолчанию — false.

PartitionIncludeSchemaTable -> (булево)

Добавляет префиксы схем и имен таблиц к значениям раздела, когда тип раздела — primary-key-type. Это увеличивает распределение данных между фрагментами Kinesis. Например, предположим, что схема SysBench имеет тысячи таблиц, и каждая таблица имеет ограниченный диапазон для первичного ключа. В этом случае один и тот же первичный ключ отправляется из тысяч таблиц в один и тот же фрагмент, что приводит к ограничению пропускной способности. Значение по умолчанию — false.

IncludeTableAlterOperations -> (булево)

Включает все операции языка определения данных (DDL), изменяющие таблицу в управляющих данных, такие как rename-table, drop-table, add-column, drop-column и rename-column. Значение по умолчанию — false.

IncludeControlDetails -> (булево)

Отображает подробную информацию о контроле определения таблицы, определения столбцов и изменений таблиц и столбцов в выводе сообщения Kinesis. Значение по умолчанию — false.

IncludeNullAndEmpty -> (булево)

Включает NULL и пустые столбцы для записей, мигрированных на конечный пункт. Значение по умолчанию — false.

NoHexPrefix -> (булево)

Установите этот необязательный параметр в true, чтобы избежать добавления префикса ‘0x’ к исходным данным в шестнадцатеричном формате. Например, по умолчанию DMS добавляет префикс ‘0x’ к типу столбца LOB в шестнадцатеричном формате при перемещении из источника Oracle в целевой ресурс Amazon Kinesis. Используйте настройку конечного пункта NoHexPrefix для включения миграции столбцов типа RAW данных без добавления префикса ‘0x’.

UseLargeIntegerValue -> (булево)

Указывает использование большого целого значения с Kinesis.

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

Настройки целевого конечного узла Apache Kafka. Дополнительную информацию см. в структуре KafkaSettings.

Broker -> (строка)

Список, разделенный запятыми, одного или нескольких узлов брокеров в вашем кластере Kafka, на которых размещен ваш экземпляр Kafka. Укажите каждый узел брокера в формате `` имя_хоста_или_IP_брокера :порт `` . Например, "ec2-12-345-678-901.compute-1.amazonaws.com:2345" . Дополнительную информацию и примеры указания списка узлов брокеров см. в разделе «Использование Apache Kafka в качестве целевого узла для Database Migration Service» в руководстве пользователя Database Migration Service.

Topic -> (строка)

Тема, в которую вы мигрируете данные. Если вы не укажете тему, DMS укажет "kafka-default-topic" в качестве темы миграции.

MessageFormat -> (строка)

Формат вывода записей, созданных на конечном узле. Формат сообщения — JSON (по умолчанию) или JSON_UNFORMATTED (одна строка без табуляции).

IncludeTransactionDetails -> (булево)

Предоставляет подробную информацию о транзакциях из исходной базы данных. Эта информация включает отметку времени фиксации, позицию журнала и значения для transaction_id , предыдущих transaction_id и transaction_record_id (смещение записи внутри транзакции). По умолчанию значение — false.

IncludePartitionValue -> (булево)

Отображает значение раздела в выводе сообщения Kafka, если тип раздела не равен schema-table-type. По умолчанию значение — false.

PartitionIncludeSchemaTable -> (булево)

Добавляет префиксы схемы и имени таблицы к значениям разделов, когда тип раздела — primary-key-type. Это увеличивает распределение данных между разделами Kafka. Например, предположим, что у схемы SysBench есть тысячи таблиц, и каждая таблица имеет ограниченный диапазон для первичного ключа. В этом случае один и тот же первичный ключ отправляется из тысяч таблиц в один и тот же раздел, что приводит к ограничению пропускной способности. По умолчанию значение — false.

IncludeTableAlterOperations -> (булево)

Включает любые операции языка определения данных (DDL), изменяющие таблицу в управляющих данных, такие как rename-table , drop-table , add-column , drop-column и rename-column . По умолчанию значение — false.

IncludeControlDetails -> (булево)

Отображает подробную информацию о определении таблицы, определении столбца и изменениях таблицы и столбца в выводе сообщения Kafka. По умолчанию значение — false.

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

Максимальный размер в байтах записей, созданных на конечном узле. По умолчанию — 1 000 000.

IncludeNullAndEmpty -> (булево)

Включать столбцы NULL и пустые столбцы для записей, мигрированных на конечный узел. По умолчанию значение — false.

SecurityProtocol -> (строка)

Установите защищенное соединение с целевым конечным узлом Kafka с помощью Transport Layer Security (TLS). Доступные варианты включают ssl-encryption , ssl-authentication и sasl-ssl. sasl-ssl требует SaslUsername и SaslPassword.

SslClientCertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) клиентского сертификата, используемого для безопасного подключения к целевому конечному узлу Kafka.

SslClientKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) для закрытого ключа клиента, используемого для безопасного подключения к целевому конечному узлу Kafka.

SslClientKeyPassword -> (строка)

Пароль для закрытого ключа клиента, используемого для безопасного подключения к целевому конечном узлу Kafka.

SslCaCertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) сертификата центра сертификации (CA), который DMS использует для безопасного подключения к вашему целевому конечном узлу Kafka.

SaslUsername -> (строка)

Указанное вами имя пользователя, созданное при настройке вашего кластера MSK для проверки подлинности клиента и установления зашифрованного соединения между сервером и клиентом с помощью аутентификации SASL-SSL.

SaslPassword -> (строка)

Указанный вами пароль, созданный при настройке вашего кластера MSK для проверки подлинности клиента и установления зашифрованного соединения между сервером и клиентом с помощью аутентификации SASL-SSL.

NoHexPrefix -> (булево)

Установите это необязательное значение в true, чтобы избежать добавления префикса «0x» к исходным данным в шестнадцатеричном формате. Например, по умолчанию DMS добавляет префикс «0x» к типу LOB-столбца в шестнадцатеричном формате при миграции из Oracle в Kafka. Используйте настройку конечного узла NoHexPrefix, чтобы включить миграцию столбцов типа RAW-данных без добавления префикса «0x».

SaslMechanism -> (строка)

SslEndpointIdentificationAlgorithm -> (строка)

Устанавливает проверку имени хоста для сертификата. Эта настройка поддерживается в версии DMS 3.5.1 и выше.

UseLargeIntegerValue -> (булево)

Указывает на использование большого целочисленного значения с Kafka.

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

Настройки конечного узла источника OpenSearch. Дополнительную информацию см. в структуре ElasticsearchSettings.

ServiceAccessRoleArn -> (строка)

EndpointUri -> (строка)

Конечный узел кластера OpenSearch. DMS использует HTTPS, если протокол передачи (http/https) не указан.

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

Чтобы избежать ранней ошибки, этот счетчик действует только после передачи 1000 записей. OpenSearch также имеет понятие мониторинга ошибок в течение последних 10 минут окна наблюдения. Если передача всех записей завершится неудачно в последние 10 минут, операция полной загрузки остановится.

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

Максимальное количество секунд, в течение которого DMS повторно пытается выполнить неудачные запросы API к кластеру OpenSearch.

UseNewMappingType -> (булево)

Установите это значение в true, чтобы DMS мигрировал документацию, используя тип документации _doc. OpenSearch и кластер Elasticsearch поддерживают только тип документации _doc в версиях 7.x и выше. Значение по умолчанию — false.

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

Настройки конечного узла целевого Amazon Neptune. Дополнительную информацию см. в структуре NeptuneSettings.

ServiceAccessRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли службы, которую вы создали для целевого конечного узла Neptune. Роль должна разрешать действие iam:PassRole. Дополнительную информацию см. в разделе «Создание роли службы IAM для доступа к Amazon Neptune в качестве целевого узла» в руководстве пользователя Database Migration Service.

S3BucketName -> (строка)

Имя ведра Amazon S3, в котором DMS может временно хранить мигрированные данные графа в файлах .csv перед их массовой загрузкой в целевую базу данных Neptune. DMS сопоставляет данные исходного SQL с данными графа перед сохранением их в этих файлах .csv.

S3BucketFolder -> (строка)

Путь к папке, в которой вы хотите, чтобы DMS хранил мигрированные данные графа в ведре S3, указанном в S3BucketName.

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

Количество миллисекунд, которое DMS ожидает, чтобы повторить массовую загрузку мигрированных данных графа в целевую базу данных Neptune перед выдачей ошибки. По умолчанию — 250.

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

Максимальный размер мигрированных данных графа, хранящихся в файле .csv, прежде чем DMS загрузит данные в целевую базу данных Neptune. По умолчанию — 1 048 576 КБ. Если массовая загрузка прошла успешно, DMS очищает ведро, готовое к хранению следующей партии мигрированных данных графа.

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

Количество попыток массовой загрузки мигрированных данных графа в целевую базу данных Neptune, прежде чем DMS выдаст ошибку. По умолчанию — 5.

IamAuthEnabled -> (булево)

Если вы хотите включить авторизацию Identity and Access Management (IAM) для этого конечного узла, установите это значение в true. Затем прикрепите соответствующий документ политики IAM к вашей роли службы, указанной в ServiceAccessRoleArn. По умолчанию значение — false.

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

Настройки конечной точки Amazon Redshift.

AcceptAnyDate -> (boolean)

Этот параметр применяется только к столбцам TIMESTAMP и DATE. Всегда используйте ACCEPTANYDATE с параметром DATEFORMAT. Если формат даты данных не соответствует спецификации DATEFORMAT, Amazon Redshift вставляет значение NULL в этот столбец.

AfterConnectScript -> (string)

BucketFolder -> (string)

Папка S3, где хранятся файлы в формате CSV (.csv) перед загрузкой в целевой кластер Redshift.

В режиме полной загрузки DMS преобразует записи источника в файлы .csv и загружает их в путь BucketFolder/TableID. DMS использует команду Redshift COPY для загрузки файлов .csv в целевую таблицу. Файлы удаляются после завершения операции COPY. Для получения дополнительной информации см. COPY в Руководстве разработчика базы данных Amazon Redshift.

В режиме захвата изменений (CDC) DMS создает таблицу NetChanges и загружает файлы .csv в путь BucketFolder/NetChangesTableID.

BucketName -> (string)

Имя промежуточного ведра S3, используемого для хранения файлов .csv перед загрузкой данных в Redshift.

CaseSensitiveNames -> (boolean)

Если Amazon Redshift настроен для поддержки имен схем, чувствительных к регистру, установите CaseSensitiveNames в true . Значение по умолчанию — false .

CompUpdate -> (boolean)

Если вы установите CompUpdate в true, Amazon Redshift применяет автоматическое сжатие, если таблица пуста. Это применяется даже если столбцы таблицы уже имеют кодировки, отличные от RAW. Если вы установите CompUpdate в false, автоматическое сжатие отключено, и существующие кодировки столбцов не изменятся. Значение по умолчанию — true .

ConnectionTimeout -> (integer)

Значение, устанавливающее время ожидания (в миллисекундах) перед истечением времени ожидания, начиная с момента первоначального подключения.

DatabaseName -> (string)

Имя хранилища данных Amazon Redshift (сервис), с которым вы работаете.

DateFormat -> (string)

Используемый формат даты. Допустимые значения — auto (чувствителен к регистру), строка формата вашей даты в кавычках или NULL. Если этот параметр не задан (NULL), по умолчанию используется формат ‘YYYY-MM-DD’. При использовании auto распознается большинство строк, даже некоторые, которые не поддерживаются при использовании строки формата даты.

Если ваши значения даты и времени используют разные форматы, установите этот параметр в auto.

EmptyAsNull -> (boolean)

Значение, указывающее, следует ли DMS мигрировать пустые поля CHAR и VARCHAR в NULL. Значение true устанавливает пустые поля CHAR и VARCHAR в null. Значение по умолчанию — false.

EncryptionMode -> (string)

Тип шифрования на стороне сервера, который вы хотите использовать для данных. Этот тип шифрования является частью настроек конечной точки или атрибутов дополнительных подключений для Amazon S3. Вы можете выбрать либо SSE_S3 (по умолчанию), либо SSE_KMS.

Примечание

Для операции ModifyEndpoint вы можете изменить существующее значение параметра EncryptionMode с SSE_KMS на SSE_S3. Но вы не можете изменить существующее значение с SSE_S3 на SSE_KMS.

Для использования SSE_S3 создайте роль Identity and Access Management (IAM) с политикой, разрешающей "arn:aws:s3:::*" использовать следующие действия: "s3:PutObject", "s3:ListBucket"

ExplicitIds -> (boolean)

Это настройка действует только для задач миграции полной загрузки. Установите ExplicitIds в true, чтобы таблицы со столбцами IDENTITY перезаписывали свои автоматически сгенерированные значения явными значениями, загруженными из файлов исходных данных, используемых для заполнения таблиц. Значение по умолчанию — false.

FileTransferUploadStreams -> (integer)

Количество параллельных потоков, используемых для загрузки одного файла .csv в ведро S3 с использованием многочастной загрузки S3. Для получения дополнительной информации см. Обзор многочастной загрузки.

FileTransferUploadStreams принимает значение от 1 до 64. По умолчанию значение равно 10.

LoadTimeout -> (integer)

Время ожидания (в миллисекундах) перед истечением времени ожидания операций, выполняемых DMS в кластере Redshift, таких как Redshift COPY, INSERT, DELETE и UPDATE.

MaxFileSize -> (integer)

Password -> (string)

Пароль для пользователя, указанного в свойстве username.

Port -> (integer)

Номер порта для Amazon Redshift. Значение по умолчанию — 5439.

RemoveQuotes -> (boolean)

ReplaceInvalidChars -> (string)

Список символов, которые вы хотите заменить. Используйте с ReplaceChars.

ReplaceChars -> (string)

Значение, указывающее на замену недопустимых символов, указанных в ReplaceInvalidChars, заменяя их указанными символами вместо этого. По умолчанию — "?".

ServerName -> (string)

Имя кластера Amazon Redshift, который вы используете.

ServiceAccessRoleArn -> (string)

Amazon Resource Name (ARN) роли IAM, имеющей доступ к сервису Amazon Redshift. Роль должна разрешать действие iam:PassRole.

ServerSideEncryptionKmsKeyId -> (string)

Идентификатор ключа KMS. Если вы используете SSE_KMS для EncryptionMode, укажите этот идентификатор ключа. Используемый ключ должен иметь прикрепленную политику, которая разрешает разрешения IAM пользователей и позволяет использовать ключ.

TimeFormat -> (string)

Формат времени, который вы хотите использовать. Допустимые значения — auto (чувствителен к регистру), 'timeformat_string', 'epochsecs' или 'epochmillisecs'. По умолчанию — 10. При использовании auto распознается большинство строк, даже некоторые, которые не поддерживаются при использовании строки формата времени.

Если ваши значения даты и времени используют разные форматы, установите этот параметр в auto.

TrimBlanks -> (boolean)

Значение, указывающее на удаление символов trailing пробелов из строки VARCHAR. Этот параметр применяется только к столбцам с типом данных VARCHAR. Выберите true для удаления ненужных пробелов. По умолчанию — false.

TruncateColumns -> (boolean)

Значение, указывающее на обрезку данных в столбцах до соответствующего количества символов, чтобы данные поместились в столбец. Этот параметр применяется только к столбцам с типом данных VARCHAR или CHAR и строкам размером 4 МБ или меньше. Выберите true для обрезки данных. По умолчанию — false.

Username -> (string)

Имя пользователя Amazon Redshift для зарегистрированного пользователя.

WriteBufferSize -> (integer)

Размер (в КБ) буфера записи файла в оперативной памяти, используемого при создании файлов .csv на локальном диске на экземпляре репликации DMS. Значение по умолчанию — 1000 (размер буфера — 1000 КБ).

SecretsManagerAccessRoleArn -> (string)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS в качестве доверенного субъекта и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, предоставляющего доступ к конечной точке Amazon Redshift.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этой настройки и SecretsManagerSecretId. Или вы можете указать значения в виде открытого текста для UserName, Password, ServerName и Port. Вы не можете указать оба. Для получения дополнительной информации о создании этой SecretsManagerSecret и необходимых для доступа SecretsManagerAccessRoleArn и SecretsManagerSecretId, см. Использование секретов для доступа к ресурсам Database Migration Service в Руководстве пользователя Database Migration Service.

SecretsManagerSecretId -> (string)

Полный ARN, частичный ARN или дружественное имя SecretsManagerSecret, содержащего данные подключения к конечной точке Amazon Redshift.

MapBooleanAsBoolean -> (boolean)

При значении true Redshift мигрирует тип boolean как boolean. По умолчанию Redshift мигрирует boolean как varchar(1). Для того чтобы эта настройка вступила в силу, ее необходимо установить на обеих конечных точках, источника и получателя.

PostgreSQLSettings -> (structure)

Настройки конечной точки источника и целевого PostgreSQL. Дополнительную информацию см. в структуре PostgreSQLSettings.

AfterConnectScript -> (строка)

Только для использования с захватом изменений данных (CDC), этот атрибут отключает внешние ключи и пользовательские триггеры DMS для сокращения времени массовой загрузки данных.

Пример: afterConnectScript=SET session_replication_role='replica'

CaptureDdls -> (булево)

Для захвата событий DDL DMS создаёт различные артефакты в базе данных PostgreSQL при запуске задачи. Позже вы можете удалить эти артефакты.

Значение по умолчанию — true.

Если это значение установлено в N, вам не нужно создавать таблицы или триггеры в базе данных источника.

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

Указывает максимальный размер (в КБ) любого файла .csv, используемого для передачи данных в PostgreSQL.

Значение по умолчанию — 32 768 КБ (32 МБ).

Пример: maxFileSize=512

DatabaseName -> (строка)

Имя базы данных для конечной точки.

DdlArtifactsSchema -> (строка)

Схема, в которой создаются операционные артефакты базы данных DDL.

Значение по умолчанию — public.

Пример: ddlArtifactsSchema=xyzddlschema;

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

Устанавливает таймаут клиентского оператора для экземпляра PostgreSQL в секундах. Значение по умолчанию — 60 секунд.

Пример: executeTimeout=100;

FailTasksOnLobTruncation -> (булево)

При установке в true это значение приводит к отказу задачи, если фактический размер столбца LOB больше указанного LobMaxSize.

Значение по умолчанию — false.

Если задача установлена в ограниченный режим LOB, а этот параметр установлен в true, задача завершается сбоем вместо усечения данных LOB.

HeartbeatEnable -> (булево)

Функция удалённого пульса (WAL heartbeat) имитирует фиктивную транзакцию. Это предотвращает сохранение неактивных логических реплицируемых слотов устаревших журналов WAL, что может привести к переполнению хранилища на источнике. Этот пульс сохраняет restart_lsn в движении и предотвращает переполнение хранилища.

Значение по умолчанию — false.

HeartbeatSchema -> (строка)

Устанавливает схему, в которой создаются артефакты удалённого пульса.

Значение по умолчанию — public.

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

Устанавливает частоту удалённого пульса WAL (в минутах).

Значение по умолчанию — 5 минут.

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки. По умолчанию — 5432.

ServerName -> (строка)

Имя хоста базы данных конечной точки.

Для экземпляра Amazon RDS PostgreSQL это выход DescribeDBInstances, в поле `` Endpoint .Address``.

Для экземпляра Aurora PostgreSQL это выход DescribeDBClusters, в поле Endpoint.

Username -> (строка)

Имя пользователя подключения к конечной точке.

SlotName -> (строка)

Устанавливает имя ранее созданного логического реплицируемого слота для загрузки данных о изменениях (CDC) экземпляра источника PostgreSQL.

При использовании параметра CdcStartPosition запроса DMS API этот атрибут также позволяет использовать начальные точки native CDC. DMS проверяет, существует ли указанный логический реплицируемый слот, прежде чем запускать задачу загрузки CDC. Он также проверяет, что задача была создана с корректным значением CdcStartPosition. Если указанный слот не существует или у задачи нет корректного значения CdcStartPosition, DMS выводит ошибку.

Дополнительную информацию о настройке параметра запроса CdcStartPosition см. в руководстве по Database Migration Service Определение начальной точки native CDC . Дополнительную информацию о использовании CdcStartPosition см. в документации CreateReplicationTask , StartReplicationTask и ModifyReplicationTask .

PluginName -> (строка)

Указывает плагин, который будет использоваться для создания реплицируемого слота.

Значение по умолчанию — pglogical.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенное лицо и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна допускать действие iam:PassRole. SecretsManagerSecret имеет значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке PostgreSQL.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указывать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых для доступа SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве по Database Migration Service Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащее данные подключения к конечной точке PostgreSQL.

TrimSpaceInChar -> (булево)

Используйте параметр конечной точки источника TrimSpaceInChar для обрезки данных в типах данных CHAR и NCHAR при миграции. Значение по умолчанию — true.

MapBooleanAsBoolean -> (булево)

При значении true PostgreSQL мигрирует тип boolean как boolean. По умолчанию PostgreSQL мигрирует boolean как varchar(5). Для вступления в силу необходимо установить этот параметр как в источнике, так и в целевой конечной точке.

Значение по умолчанию — false.

MapJsonbAsClob -> (булево)

При значении true DMS мигрирует значения JSONB как CLOB.

Значение по умолчанию — false.

MapLongVarcharAs -> (строка)

Устанавливает тип данных для отображения значений LONG.

Значение по умолчанию — wstring.

DatabaseMode -> (строка)

Определяет поведение по умолчанию обработки репликации для PostgreSQL-совместимых конечных точек, требующих дополнительной настройки, таких как конечные точки Babelfish.

BabelfishDatabaseName -> (строка)

Имя базы данных Babelfish для конечной точки Aurora PostgreSQL.

DisableUnicodeSourceFilter -> (булево)

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

Поддержка Unicode должна быть отключена только при использовании фильтра правил выбора для текстового столбца в базе данных источника, который индексирован.

ServiceAccessRoleArn -> (строка)

ARN роли IAM, которую вы можете использовать для аутентификации соединения с конечной точкой. Убедитесь, что политика разрешений включает действия iam:PassRole и rds-db:connect.

AuthenticationMethod -> (строка)

Этот атрибут позволяет указать метод аутентификации как «iam auth».

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

Настройки конечной точки источника и назначения MySQL. Дополнительную информацию см. в структуре MySQLSettings.

AfterConnectScript -> (строка)

Указывает скрипт, который выполняется сразу после подключения DMS к конечной точке. Задача миграции продолжает выполняться независимо от успешного или неудачного выполнения SQL-запроса.

Для этого параметра укажите сам код скрипта, а не имя файла, содержащего скрипт.

CleanSourceMetadataOnMismatch -> (булево)

Очищает и восстанавливает метаданные таблиц на экземпляре репликации при возникновении несоответствия. Например, в ситуации, когда выполнение alter DDL для таблицы может привести к разной информации о таблице, кэшированной в экземпляре репликации.

DatabaseName -> (строка)

Имя базы данных для конечной точки. Для конечной точки источника или назначения MySQL не указывайте явно базу данных, используя параметр запроса DatabaseName в вызовах API CreateEndpoint или ModifyEndpoint. Указание DatabaseName при создании или изменении конечной точки MySQL реплицирует все таблицы задач в эту единственную базу данных. Для конечных точек MySQL вы указываете базу данных только при указании схемы в правилах сопоставления таблиц задачи DMS.

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

Указывает, как часто проверять двоичный журнал на наличие новых изменений/событий, когда база данных простаивает. По умолчанию — пять секунд.

Пример: eventsPollInterval=5;

В примере DMS проверяет наличие изменений в двоичных журналах каждые пять секунд.

TargetDbType -> (строка)

Указывает, где мигрировать исходные таблицы на целевую систему, либо в одну базу данных, либо в несколько баз данных. Если вы указываете SPECIFIC_DATABASE, укажите имя базы данных, используя параметр DatabaseName объекта Endpoint.

Пример: targetDbType=MULTIPLE_DATABASES

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

Пример: maxFileSize=512

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

Повышает производительность при загрузке данных в базу данных MySQL-совместимого целевого сервера. Указывает, сколько потоков использовать для загрузки данных в базу данных MySQL-совместимого целевого сервера. Установка большого числа потоков может негативно сказаться на производительности базы данных, поскольку для каждого потока требуется отдельное соединение. По умолчанию — один.

Пример: parallelLoadThreads=1

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки.

ServerName -> (строка)

Имя хоста базы данных конечной точки.

Для экземпляра Amazon RDS MySQL это вывод DescribeDBInstances в поле ``Endpoint.Address``.

Для экземпляра Aurora MySQL это вывод DescribeDBClusters в поле Endpoint.

ServerTimezone -> (строка)

Указывает часовой пояс для базы данных MySQL источника.

Пример: serverTimezone=US/Pacific;

Примечание: не заключайте часовые пояса в одинарные кавычки.

Username -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полное имя Amazon Resource Name (ARN) роли IAM, которая указывает DMS в качестве доверенной сущности и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret имеет значение секрета Amazon Web Services Secrets Manager, который позволяет получить доступ к конечной точке MySQL.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в Руководстве пользователя Database Migration Service, раздел «Использование секретов для доступа к ресурсам Database Migration Service».

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или дружественное имя SecretsManagerSecret, содержащего данные подключения к конечной точке MySQL.

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

Устанавливает таймаут клиентского оператора (в секундах) для конечной точки источника MySQL.

ServiceAccessRoleArn -> (строка)

AuthenticationMethod -> (строка)

Этот атрибут позволяет указать метод аутентификации как «iam auth».

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

Настройки конечной точки источника и целевого сервера Oracle. Дополнительную информацию см. в структуре OracleSettings.

AddSupplementalLogging -> (boolean)

Установите этот атрибут, чтобы настроить дополнительное логирование на уровне таблиц для базы данных Oracle. Этот атрибут включает дополнительное логирование PRIMARY KEY для всех таблиц, выбранных для задачи миграции.

Если вы используете этот параметр, вам все равно необходимо включить дополнительное логирование на уровне базы данных.

ArchivedLogDestId -> (integer)

Указывает идентификатор назначения для архивированных журналов переходов. Это значение должно совпадать с числом в столбце dest_id представления v$archived_log. Если вы работаете с дополнительным назначением журналов переходов, используйте параметр AdditionalArchivedLogDestId для указания дополнительного идентификатора назначения. Это улучшает производительность, гарантируя, что нужные журналы будут доступны с самого начала.

AdditionalArchivedLogDestId -> (integer)

Установите этот атрибут со значением ArchivedLogDestId в настройке первичного/резервного сервера. Этот атрибут полезен в случае переключения. В этом случае DMS необходимо знать, откуда получать архивированные журналы переходов для чтения изменений. Эта необходимость возникает, потому что после переключения предыдущий первичный экземпляр стал резервным.

Хотя DMS поддерживает использование параметра Oracle RESETLOGS для открытия базы данных, никогда не используйте RESETLOGS, если это не необходимо. Дополнительную информацию об RESETLOGS см. в разделе RMAN Data Repair Concepts руководства пользователя Oracle Database Backup and Recovery.

ExtraArchivedLogDestIds -> (list)

Указывает идентификаторы одного или нескольких дополнительных назначений для одного или нескольких архивированных журналов переходов. Эти идентификаторы являются значениями столбца dest_id в представлении v$archived_log. Используйте эту настройку вместе с атрибутом дополнительного подключения archivedLogDestId в настройке первичный-одиночный резервный или первичный-множественные резервные.

Эта настройка полезна при переключении, когда вы используете базу данных Oracle Data Guard в качестве источника. В этом случае DMS нуждается в информации о том, откуда получать архивированные журналы переходов для чтения изменений. DMS нуждается в этом, потому что после переключения предыдущий первичный экземпляр стал резервным. Например, в настройке первичный-одиночный резервный сервер вы можете применить следующие настройки.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

В настройке первичный-множественные резервные серверы вы можете применить следующие настройки.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

(integer)

AllowSelectNestedTables -> (boolean)

ParallelAsmReadThreads -> (integer)

Установите этот атрибут, чтобы изменить количество потоков, которые DMS настраивает для выполнения загрузки захвата данных (CDC) с использованием Oracle Automatic Storage Management (ASM). Вы можете указать целое число от 2 (по умолчанию) до 8 (максимум). Используйте этот атрибут вместе с атрибутом readAheadBlocks.

ReadAheadBlocks -> (integer)

Установите этот атрибут, чтобы изменить количество блоков предварительной чтения, которые DMS настраивает для выполнения загрузки захвата данных (CDC) с использованием Oracle Automatic Storage Management (ASM). Вы можете указать целое число от 1000 (по умолчанию) до 200 000 (максимум).

AccessAlternateDirectly -> (boolean)

Установите этот атрибут в false, чтобы использовать двоичный читатель для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это указывает экземпляру DMS не обращаться к журналам переходов через указанный префикс пути замены с использованием прямого доступа к файлам.

UseAlternateFolderForOnline -> (boolean)

Установите этот атрибут в true, чтобы использовать двоичный читатель для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это указывает экземпляру DMS использовать любые указанные замены префиксов для доступа ко всем онлайн-журналам переходов.

OraclePathPrefix -> (string)

Установите этот строковый атрибут в необходимое значение для использования двоичного читателя для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это значение определяет корневой каталог Oracle по умолчанию для доступа к журналам переходов.

UsePathPrefix -> (string)

Установите этот строковый атрибут в необходимое значение для использования двоичного читателя для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Это значение определяет префикс пути, используемый для замены корневого каталога Oracle по умолчанию для доступа к журналам переходов.

ReplacePathPrefix -> (boolean)

Установите этот атрибут в значение true для использования двоичного читателя для захвата данных изменений для Amazon RDS для Oracle в качестве источника. Эта настройка указывает экземпляру DMS заменить корневой каталог Oracle по умолчанию указанным значением usePathPrefix для доступа к журналам переходов.

EnableHomogenousTablespace -> (boolean)

Установите этот атрибут для включения репликации однородного пространства таблиц и создания существующих таблиц или индексов в том же пространстве таблиц на целевом сервере.

DirectPathNoLog -> (boolean)

При установке в true этот атрибут помогает повысить скорость коммита в базе данных Oracle целевого сервера, записывая данные напрямую в таблицы, а не записывая след в журналы базы данных.

ArchivedLogsOnly -> (boolean)

При установке этого поля в True DMS обращается только к архивированным журналам переходов. Если архивированные журналы переходов хранятся только в Oracle Automatic Storage Management (ASM), учетная запись пользователя DMS должна иметь права доступа к ASM.

AsmPassword -> (string)

Пароль Oracle Automatic Storage Management (ASM) для конечной точки источника Oracle. Вы можете установить это значение из значения `` asm_user_password ``. Вы устанавливаете это значение в качестве части значения, разделенного запятыми, которое вы задаете параметру запроса Password при создании конечной точки для доступа к журналам транзакций с использованием двоичного читателя. Дополнительную информацию см. в Конфигурация для захвата данных изменений (CDC) в базе данных Oracle-источнике.

AsmServer -> (string)

Адрес сервера ASM для конечной точки источника Oracle. Вы можете установить это значение из значения asm_server. Вы устанавливаете asm_server в качестве части строки атрибута дополнительного подключения для доступа к серверу Oracle с двоичным читателем, использующим ASM. Дополнительную информацию см. в Конфигурация для захвата данных изменений (CDC) в базе данных Oracle-источнике.

AsmUser -> (string)

Имя пользователя ASM для конечной точки источника Oracle. Вы можете установить это значение из значения asm_user. Вы устанавливаете asm_user в качестве части строки атрибута дополнительного подключения для доступа к серверу Oracle с двоичным читателем, использующим ASM. Дополнительную информацию см. в Конфигурация для захвата данных изменений (CDC) в базе данных Oracle-источнике.

CharLengthSemantics -> (string)

Указывает, в байтах или символах хранится длина столбца символьного типа. Чтобы указать, что длина столбца символьного типа хранится в символах, установите этот атрибут в CHAR. В противном случае длина столбца символьного типа хранится в байтах.

Пример: charLengthSemantics=CHAR;

DatabaseName -> (string)

Имя базы данных для конечной точки.

DirectPathParallelLoad -> (boolean)

При установке в true этот атрибут указывает параллельную загрузку при установке useDirectPathFullLoad в Y. Этот атрибут также применяется только при использовании функции параллельной загрузки DMS. Обратите внимание, что целевая таблица не может иметь никаких ограничений или индексов.

FailTasksOnLobTruncation -> (boolean)

При установке в true этот атрибут заставляет задачу завершиться неудачей, если фактический размер столбца LOB больше, чем указанный LobMaxSize.

Если задача установлена в ограниченный режим LOB, и этот параметр установлен в true, задача завершается неудачей вместо усечения данных LOB.

NumberDatatypeScale -> (integer)

Указывает масштаб числа. Вы можете выбрать масштаб до 38 или выбрать FLOAT. По умолчанию тип данных NUMBER преобразуется в точность 38, масштаб 10.

Пример: numberDataTypeScale=12

Password -> (string)

Пароль подключения к конечной точке.

Port -> (integer)

TCP-порт конечной точки.

ReadTableSpaceName -> (boolean)

При установке в true этот атрибут поддерживает репликацию пространства таблиц.

RetryInterval -> (integer)

Указывает количество секунд, которое система ожидает перед повторной отправкой запроса.

Пример: retryInterval=6;

SecurityDbEncryption -> (string)

Для конечной точки источника Oracle, пароль прозрачного шифрования данных (TDE), необходимый AWM DMS для доступа к зашифрованным с помощью TDE журналам переходов Oracle с использованием двоичного читателя. Также это значение `` TDE_Password ``, которое является частью значения, разделенного запятыми, установленного для параметра запроса Password при создании конечной точки. Настройка SecurityDbEncryptian связана с настройкой SecurityDbEncryptionName. Дополнительную информацию см. в разделе Поддерживаемые методы шифрования для использования Oracle в качестве источника для DMS в руководстве пользователя Database Migration Service.

SecurityDbEncryptionName -> (string)

Для конечной точки источника Oracle, имя ключа, используемого для прозрачного шифрования данных (TDE) столбцов и пространств таблиц в базе данных источника Oracle, зашифрованной с помощью TDE. Значение ключа является значением настройки SecurityDbEncryption. Дополнительную информацию об установке имени ключа SecurityDbEncryptionName см. в разделе информации и примера для установки атрибута дополнительного подключения securityDbEncryptionName в разделе Поддерживаемые методы шифрования для использования Oracle в качестве источника для DMS в руководстве пользователя Database Migration Service.

ServerName -> (string)

Полное доменное имя конечной точки.

Для экземпляра Amazon RDS Oracle это вывод DescribeDBInstances , в поле `` Endpoint .Address``.

SpatialDataOptionToGeoJsonFunctionName -> (string)

Используйте этот атрибут для преобразования SDO_GEOMETRY в формат GEOJSON. По умолчанию DMS вызывает пользовательскую функцию SDO2GEOJSON, если она присутствует и доступна. Или вы можете создать собственную пользовательскую функцию, которая имитирует работу SDOGEOJSON, и установить SpatialDataOptionToGeoJsonFunctionName для вызова ее вместо этого.

StandbyDelayTime -> (integer)

Используйте этот атрибут для указания времени в минутах для задержки синхронизации резервного сервера. Если источником является резервная база данных Oracle Active Data Guard, используйте этот атрибут для указания временного лага между первичной и резервной базами данных.

В DMS вы можете создать задачу Oracle CDC, которая использует экземпляр резервного сервера Active Data Guard в качестве источника для репликации текущих изменений. Это устраняет необходимость подключения к активной базе данных, которая может быть в рабочем режиме.

Имя пользователя -> (строка)

Имя пользователя подключения к конечной точке.

UseBFile -> (булево)

Установите этот атрибут в значение True, чтобы захватывать данные изменений с помощью утилиты Binary Reader. Установите значение UseLogminerReader в False, чтобы установить этот атрибут в True. Для использования Binary Reader с Amazon RDS для Oracle в качестве источника, вы устанавливаете дополнительные атрибуты. Дополнительную информацию об использовании этого параметра с Oracle Automatic Storage Management (ASM) см. в разделе Использование Oracle LogMiner или DMS Binary Reader для CDC .

UseDirectPathFullLoad -> (булево)

Установите этот атрибут в значение True, чтобы DMS использовал полную загрузку по прямому пути. Укажите это значение, чтобы использовать протокол прямого пути в Oracle Call Interface (OCI). Используя этот протокол OCI, вы можете выполнять массовую загрузку таблиц Oracle-целей во время полной загрузки.

UseLogminerReader -> (булево)

Установите этот атрибут в значение True, чтобы захватывать данные изменений с помощью утилиты Oracle LogMiner (по умолчанию). Установите этот атрибут в значение False, если вы хотите получить доступ к журналам перегенерации как к двоичному файлу. При установке значения UseLogminerReader в False, также установите UseBfile в True. Дополнительную информацию об этом параметре и использовании Oracle ASM см. в разделе Использование Oracle LogMiner или DMS Binary Reader для CDC в руководстве пользователя DMS .

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret . Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, позволяющего получить доступ к конечной точке Oracle.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этого SecretsManagerSecret и требуемых для доступа к нему SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащий данные подключения к конечной точке Oracle.

SecretsManagerOracleAsmAccessRoleArn -> (строка)

Требуется только если ваша конечная точка Oracle использует Automatic Storage Management (ASM). Полный ARN роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к SecretsManagerOracleAsmSecret. Данный SecretsManagerOracleAsmSecret содержит секретное значение, позволяющее получить доступ к Oracle ASM конечной точки.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerOracleAsmSecretId. Или вы можете указать значения в открытом виде для AsmUser, AsmPassword и AsmServerName. Вы не можете указать оба. Дополнительную информацию о создании этого SecretsManagerOracleAsmSecret и требуемых для доступа к нему SecretsManagerOracleAsmAccessRoleArn и SecretsManagerOracleAsmSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerOracleAsmSecretId -> (строка)

Требуется только если ваша конечная точка Oracle использует Automatic Storage Management (ASM). Полный ARN, частичный ARN или понятное имя SecretsManagerOracleAsmSecret, содержащий данные подключения к Oracle ASM для конечной точки Oracle.

TrimSpaceInChar -> (булево)

Используйте параметр конечной точки источника TrimSpaceInChar для обрезки данных типов CHAR и NCHAR при миграции. Значение по умолчанию равно true.

ConvertTimestampWithZoneToUTC -> (булево)

При значении True, преобразует метки времени с типом данных timezone в их значение UTC.

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

Временной интервал в минутах для проверки открытых транзакций для задачи только CDC.

Вы можете указать целое число от 0 (по умолчанию) до 240 (максимум).

Примечание

Этот параметр действителен только в версии DMS 3.5.0 и более поздних.

AuthenticationMethod -> (строка)

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

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

Параметры для конечной точки источника и целевой конечной точки SAP ASE. Дополнительную информацию см. в структуре SybaseSettings.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки. По умолчанию 5000.

ServerName -> (строка)

Полное доменное имя конечной точки.

Имя пользователя -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, позволяющего получить доступ к конечной точке SAP ASE.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этого SecretsManagerSecret и требуемых для доступа к нему SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в разделе Использование секретов для доступа к ресурсам Database Migration Service в руководстве пользователя Database Migration Service .

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащий данные подключения к конечной точке SAP SAE.

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

Настройки источника и целевого конечного пункта Microsoft SQL Server. Дополнительную информацию см. в структуре MicrosoftSQLServerSettings.

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

TCP-порт конечной точки.

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

Максимальный размер пакетов (в байтах), используемых для передачи данных с помощью BCP.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

ControlTablesFileGroup -> (строка)

Указывает группу файлов для внутренних таблиц DMS. При запуске задачи репликации все внутренние управляющие таблицы DMS (awsdms_ apply_exception, awsdms_apply, awsdms_changes) создаются для указанной группы файлов.

Password -> (строка)

Пароль подключения к конечной точке.

QuerySingleAlwaysOnNode -> (логическое значение)

Очищает и пересоздает сведения о метаданных таблицы на экземпляре репликации при возникновении несоответствия. Например, выполнение оператора ALTER DDL для таблицы может привести к разным сведениям о таблице, кэшируемой в экземпляре репликации.

ReadBackupOnly -> (логическое значение)

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

SafeguardPolicy -> (строка)

Используйте этот атрибут, чтобы свести к минимуму необходимость доступа к резервному журналу и позволить DMS предотвратить усечение с помощью одного из двух следующих методов.

Начать транзакции в базе данных: Это метод по умолчанию. При использовании этого метода DMS предотвращает усечение журнала транзакций, имитируя транзакцию в базе данных. Пока открыта такая транзакция, изменения, появляющиеся после начала транзакции, не усекаются. Если вам нужна возможность включения Microsoft Replication в вашей базе данных, то вы должны выбрать этот метод.

Исключительно использовать sp_repldone в рамках одной задачи : При использовании этого метода DMS считывает изменения, а затем использует sp_repldone, чтобы пометить транзакции журнала транзакций как готовые к усечению. Хотя этот метод не включает какие-либо транзакционные действия, он может использоваться только при отсутствии работы Microsoft Replication. Кроме того, при использовании этого метода к базе данных одновременно может обращаться только одна задача DMS. Поэтому, если вам нужно запускать параллельные задачи DMS для той же базы данных, используйте метод по умолчанию.

ServerName -> (строка)

Username -> (строка)

Имя пользователя подключения к конечной точке.

UseBcpFullLoad -> (логическое значение)

Используйте этот атрибут для передачи данных для операций полной загрузки с помощью BCP. Если целевая таблица содержит столбец с идентификатором, которого нет в исходной таблице, вам необходимо отключить опцию использования BCP для загрузки таблицы.

UseThirdPartyBackupDevice -> (логическое значение)

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

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, предоставляющего доступ к конечной точке SQL Server.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом тексте для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service — Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или имя в удобочитаемой форме SecretsManagerSecret, содержащий данные подключения к конечной точке SQL Server.

TrimSpaceInChar -> (логическое значение)

Используйте настройку конечной точки источника TrimSpaceInChar для обрезки справа данных типов CHAR и NCHAR во время миграции. Установка значения TrimSpaceInChar не обрезает данные слева. Значение по умолчанию — true.

TlogAccessMode -> (строка)

Указывает режим, используемый для извлечения данных CDC.

ForceLobLookup -> (логическое значение)

Принудительно выполняет поиск LOB в строках LOB.

AuthenticationMethod -> (строка)

Указывает метод аутентификации, используемый с Microsoft SQL Server.

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

Настройки конечной точки источника IBM Db2 LUW. Дополнительную информацию см. в структуре IBMDb2Settings.

DatabaseName -> (строка)

Имя базы данных для конечной точки.

Password -> (строка)

Пароль подключения к конечной точке.

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

TCP-порт конечной точки. Значение по умолчанию — 50000.

ServerName -> (строка)

Полное доменное имя конечной точки.

SetDataCaptureChanges -> (логическое значение)

Включает текущую репликацию (CDC) как логическое значение. Значение по умолчанию — true.

CurrentLsn -> (строка)

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

Максимальное количество байтов на чтение, как числовое значение. Значение по умолчанию — 64 КБ.

Username -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая указывает DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, предоставляющего доступ к конечной точке Db2 LUW.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом тексте для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и необходимых для доступа SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service — Использование секретов для доступа к ресурсам Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или имя в удобочитаемой форме SecretsManagerSecret, содержащий данные подключения к конечной точке Db2 LUW.

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

Время (в миллисекундах) ожидания операции DMS на целевом Db2, выполняемой DMS. Значение по умолчанию — 1200 (20 минут).

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

Размер (в КБ) буфера записи в оперативной памяти, используемого при создании файлов .csv на локальном диске на экземпляре репликации DMS. Значение по умолчанию — 1024 (1 МБ).

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

Указывает максимальный размер (в КБ) файлов .csv, используемых для передачи данных в Db2 LUW.

KeepCsvFiles -> (логическое значение)

Если значение true, DMS сохраняет все файлы .csv на целевом Db2 LUW, которые использовались для репликации данных. DMS использует эти файлы для анализа и устранения неполадок.

Значение по умолчанию — false.

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

Предоставляет информацию, определяющую конечную точку DocumentDB.

Имя пользователя -> (строка)

Имя пользователя, используемое для доступа к конечной точке источника DocumentDB.

Пароль -> (строка)

Пароль для учетной записи пользователя, используемой для доступа к конечной точке источника DocumentDB.

Имя сервера -> (строка)

Имя сервера на конечной точке источника DocumentDB.

Порт -> (целое число)

Значение порта для конечной точки источника DocumentDB.

Имя базы данных -> (строка)

Имя базы данных на конечной точке источника DocumentDB.

Уровень вложенности -> (строка)

Указывает режим документа или таблицы.

Значение по умолчанию — "none". Укажите "none" для использования режима документа. Укажите "one" для использования режима таблицы.

Извлечь идентификатор документа -> (логическое значение)

Указывает идентификатор документа. Используйте это значение, когда NestingLevel установлено в "none".

Значение по умолчанию — "false".

Документы для проверки -> (целое число)

Указывает количество документов для предварительного просмотра, чтобы определить организацию документов. Используйте это значение, когда NestingLevel установлено в "one".

Должно быть положительным значением, большим, чем 0. Значение по умолчанию — 1000.

Идентификатор ключа KMS -> (строка)

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая определяет DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке DocumentDB.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке DocumentDB.

Использовать обновление поиска -> (логическое значение)

Если true, DMS извлекает весь документ из источника DocumentDB во время миграции. Это может привести к сбоям миграции, если ответ сервера превысит пределы пропускной способности. Для извлечения только обновлений и удалений во время миграции установите этот параметр в false.

Реплицировать коллекции фрагментов -> (логическое значение)

Если true, DMS реплицирует данные в коллекции фрагментов. DMS использует это значение только в том случае, если целевая конечная точка представляет собой кластер DocumentDB.

Когда это значение true, обратите внимание на следующее:

Вы должны установить TargetTablePrepMode в nothing.
DMS автоматически устанавливает useUpdateLookup в false.

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

Настройки для целевой конечной точки Redis. Дополнительную информацию см. в структуре RedisSettings.

Имя сервера -> (строка)

Полное доменное имя конечной точки.

Порт -> (целое число)

Порт протокола TCP для конечной точки.

SslSecurityProtocol -> (строка)

Подключение к целевой конечной точке Redis с использованием Transport Layer Security (TLS). Допустимые значения включают plaintext и ssl-encryption. По умолчанию используется ssl-encryption. Вариант ssl-encryption создаёт зашифрованное соединение. Вы можете указать Amazon Resource Name (ARN) для центра сертификации SSL (CA) с помощью параметра SslCaCertificateArn. Если ARN для CA не указан, DMS использует корневой CA Amazon.

Вариант plaintext не обеспечивает шифрование Transport Layer Security (TLS) для трафика между конечной точкой и базой данных.

Тип аутентификации -> (строка)

Тип аутентификации при подключении к целевой конечной точке Redis. Доступные варианты: none, auth-token и auth-role. Вариант auth-token требует предоставления значения AuthPassword. Вариант auth-role требует предоставления значений AuthUserName и AuthPassword.

Имя пользователя аутентификации -> (строка)

Имя пользователя, указанное с опцией auth-role настройки AuthType для целевой конечной точки Redis.

Пароль аутентификации -> (строка)

Пароль, предоставленный с опциями auth-role и auth-token настройки AuthType для целевой конечной точки Redis.

Arn сертификата CA -> (строка)

Amazon Resource Name (ARN) центра сертификации (CA), используемого DMS для подключения к вашей целевой конечной точке Redis.

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

Настройки в формате JSON для конечной точки источника GCP MySQL.

Скрипт после подключения -> (строка)

Для этого параметра укажите сам код скрипта, а не имя файла, содержащего скрипт.

Очистить метаданные источника при несовпадении -> (логическое значение)

Очищает и воссоздаёт информацию о метаданных таблиц на экземпляре репликации при несовпадении. Например, в ситуации, когда выполнение alter DDL для таблицы может привести к разной информации о таблице, кэшированной в экземпляре репликации.

Имя базы данных -> (строка)

Имя базы данных для конечной точки. Для конечной точки источника или цели MySQL не указывайте явно базу данных с помощью параметра запроса DatabaseName в API-вызовах CreateEndpoint или ModifyEndpoint. Указание DatabaseName при создании или изменении конечной точки MySQL реплицирует все таблицы задачи в эту одну базу данных. Для конечных точек MySQL вы указываете базу данных только при указании схемы в правилах сопоставления таблиц задачи DMS.

Интервал опроса событий -> (целое число)

Указывает, как часто проверять двоичный журнал на новые изменения/события, когда база данных неактивна. По умолчанию — пять секунд.

Пример: eventsPollInterval=5;

В примере DMS проверяет изменения в двоичных журналах каждые пять секунд.

Тип целевой базы данных -> (строка)

Указывает, куда мигрировать исходные таблицы на целевой стороне, в одну базу данных или несколько баз данных.

Пример: targetDbType=MULTIPLE_DATABASES

Максимальный размер файла -> (целое число)

Пример: maxFileSize=512

Потоки параллельной загрузки -> (целое число)

Повышает производительность при загрузке данных в целевую базу данных, совместимую с MySQL. Указывает количество потоков, используемых для загрузки данных в целевую базу данных, совместимую с MySQL. Установка большого количества потоков может негативно сказаться на производительности базы данных, так как для каждого потока требуется отдельное соединение. По умолчанию — один.

Пример: parallelLoadThreads=1

Пароль -> (строка)

Пароль подключения к конечной точке.

Порт -> (целое число)

Порт TCP конечной точки.

Имя сервера -> (строка)

Имя хоста MySQL.

Временная зона сервера -> (строка)

Указывает временную зону для исходной базы данных MySQL.

Пример: serverTimezone=US/Pacific;

Примечание: Не заключайте временные зоны в одинарные кавычки.

Имя пользователя -> (строка)

Имя пользователя подключения к конечной точке.

SecretsManagerAccessRoleArn -> (строка)

Полный Amazon Resource Name (ARN) роли IAM, которая определяет DMS как доверенную сущность и предоставляет необходимые разрешения для доступа к значению в SecretsManagerSecret.. Роль должна разрешать действие iam:PassRole. SecretsManagerSecret содержит значение секрета Amazon Web Services Secrets Manager, обеспечивающего доступ к конечной точке MySQL.

Примечание

Вы можете указать один из двух наборов значений для этих разрешений. Вы можете указать значения для этого параметра и SecretsManagerSecretId. Или вы можете указать значения в открытом виде для UserName, Password, ServerName и Port. Вы не можете указать оба. Дополнительную информацию о создании этой SecretsManagerSecret и требуемых для доступа к ней SecretsManagerAccessRoleArn и SecretsManagerSecretId см. в руководстве пользователя Database Migration Service.

SecretsManagerSecretId -> (строка)

Полный ARN, частичный ARN или понятное имя SecretsManagerSecret, содержащего данные подключения к конечной точке MySQL.

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

Настройки целевого конечного пункта Amazon Timestream. Для получения дополнительной информации см. структуру TimestreamSettings.

DatabaseName -> (строка)

Имя базы данных для конечного пункта.

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

Установите это свойство, чтобы указать длительность хранения всех таблиц в оперативной памяти, которые мигрированы в Amazon Timestream из исходной базы данных. Время измеряется в часах. Когда данные Timestream поступают, они сначала хранятся в оперативной памяти в течение указанного периода времени, что обеспечивает быстрый доступ к ним.

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

Установите это свойство, чтобы указать значение по умолчанию для продолжительности магнитного хранения для таблиц Amazon Timestream в днях. Это количество дней, в течение которых записи сохраняются в магнитном хранилище перед удалением. Дополнительную информацию см. в разделе Хранение в руководстве разработчика Amazon Timestream.

CdcInsertsAndUpdates -> (логическое значение)

Установите это свойство в значение true, чтобы указать, что DMS применяет только операции вставки и обновления, а не удаления. Amazon Timestream не позволяет удалять записи, поэтому если это значение равно false, DMS обнуляет соответствующую запись в базе данных Timestream, а не удаляет её.

EnableMagneticStoreWrites -> (логическое значение)

Установите это свойство в значение true, чтобы включить запись в хранилище оперативной памяти. Когда это значение равно false, DMS не записывает записи, которые старше, чем значение, указанное в MagneticDuration, поскольку Amazon Timestream по умолчанию не позволяет запись в хранилище оперативной памяти. Дополнительную информацию см. в разделе Хранение в руководстве разработчика Amazon Timestream.

END_OF_DOCUMENT_MARKER