Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

modify-replication-instance

Описание

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

Некоторые настройки применяются в рамках окна обслуживания.

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

Синтаксис

  modify-replication-instance
--replication-instance-arn <value>
[--allocated-storage <value>]
[--apply-immediately | --no-apply-immediately]
[--replication-instance-class <value>]
[--vpc-security-group-ids <value>]
[--preferred-maintenance-window <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--replication-instance-identifier <value>]
[--network-type <value>]
[--kerberos-authentication-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]

Параметры

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

Amazon Resource Name (ARN) экземпляра репликации.

--allocated-storage (целое число)

Объем хранилища (в гигабайтах), выделяемый для экземпляра репликации.

--apply-immediately | --no-apply-immediately (логическое значение)

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

--replication-instance-class (строка)

Вычислительная и оперативная мощность экземпляра репликации, определённая для указанного класса экземпляра репликации. Например, для указания класса экземпляра dms.c4.large, установите этот параметр на "dms.c4.large" .

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

--vpc-security-group-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--preferred-maintenance-window (строка)

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

По умолчанию: Используется существующая настройка

Формат: ddd:hh24:mi-ddd:hh24:mi

Допустимые дни: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Ограничения: Должно быть не менее 30 минут

--multi-az | --no-multi-az (логическое значение)

Указывает, является ли экземпляр репликации многозонной установкой (Multi-AZ). Вы не можете установить параметр AvailabilityZone, если параметр Multi-AZ установлен на true.

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

Номер версии движка экземпляра репликации.

При изменении основной версии движка экземпляра также установите AllowMajorVersionUpgrade на true.

--allow-major-version-upgrade | --no-allow-major-version-upgrade (логическое значение)

Указывает, что обновления до основной версии разрешены. Изменение этого параметра не приводит к перерыву в работе, и изменение применяется асинхронно в кратчайшие сроки.

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

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)

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

Перерыв в работе происходит, если применимы следующие факторы:

  • Этот параметр установлен на true во время окна обслуживания.
  • Доступна более новая младшая версия.
  • DMS включил автоматическое обновление для данной версии движка.

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

Идентификатор экземпляра репликации. Этот параметр сохраняется как строка в нижнем регистре.

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

Тип протокола IP-адреса, используемого экземпляром репликации, например, только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адреса. IPv6 только пока не поддерживается.

--kerberos-authentication-settings (структура)

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

KeyCacheSecretId -> (строка)

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

KeyCacheSecretIamArn -> (строка)

Указывает Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Web Services DMS доступ к секрету, содержащему файл кэша ключей для аутентификации Kerberos.

Krb5FileContents -> (строка)

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

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

KeyCacheSecretId=string,KeyCacheSecretIamArn=string,Krb5FileContents=string

Синтаксис JSON:

{
  "KeyCacheSecretId": "string",
  "KeyCacheSecretIamArn": "string",
  "Krb5FileContents": "string"
}

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

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

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

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

Включить отладку.

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

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

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

--no-sign-request (логическое значение)

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

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

Файл с корневым сертификатом для использования при проверке сертификатов 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.

Для изменения экземпляра репликации

Следующий modify-replication-instance пример изменяет экземпляр репликации, чтобы он использовал многозонную (Multi-AZ) настройку.

aws dms modify-replication-instance \
     --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
     --multi-az

Вывод:

{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "available",
        "AllocatedStorage": 5,
        "InstanceCreateTime": 1590011235.952,

        ...output omitted...

        "PendingModifiedValues": {
            "MultiAZ": true
        },
        "MultiAZ": false,
        "EngineVersion": "3.3.2",
        "AutoMinorVersionUpgrade": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",

        ...output omitted...

    }
}

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

Вывод

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

Измененный экземпляр репликации.

ReplicationInstanceIdentifier -> (строка)

Идентификатор экземпляра репликации — обязательный параметр. Этот параметр хранится в виде строчной строки.

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

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

Пример: myrepinstance

ReplicationInstanceClass -> (строка)

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

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

ReplicationInstanceStatus -> (строка)

Статус экземпляра репликации. Возможные возвращаемые значения включают:

  • "available"
  • "creating"
  • "deleted"
  • "deleting"
  • "failed"
  • "modifying"
  • "upgrading"
  • "rebooting"
  • "resetting-master-credentials"
  • "storage-full"
  • "incompatible-credentials"
  • "incompatible-network"
  • "maintenance"

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

Объем памяти (в гигабайтах), выделенный для экземпляра репликации.

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

Время создания экземпляра репликации.

VpcSecurityGroups -> (список)

Группа безопасности VPC для экземпляра.

(структура)

Описание состояния группы безопасности, связанной с виртуальной частной областью (VPC), в которой размещаются экземпляры репликации и БД.

VpcSecurityGroupId -> (строка)

Идентификатор группы безопасности VPC.

Status -> (строка)

Состояние группы безопасности VPC.

AvailabilityZone -> (строка)

Зона доступности для экземпляра.

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

Группа подсетей для экземпляра репликации.

ReplicationSubnetGroupIdentifier -> (строка)

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

ReplicationSubnetGroupDescription -> (строка)

Описание группы подсетей репликации.

VpcId -> (строка)

Идентификатор VPC.

SubnetGroupStatus -> (строка)

Состояние группы подсетей.

Subnets -> (список)

Подсети, которые находятся в группе подсетей.

(структура)

В ответ на запрос операции DescribeReplicationSubnetGroups этот объект идентифицирует подсеть по ее заданной зоне доступности, идентификатору подсети и статусу.

SubnetIdentifier -> (строка)

Идентификатор подсети.

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

Зона доступности подсети.

Name -> (строка)

Имя зоны доступности.

SubnetStatus -> (строка)

Состояние подсети.

SupportedNetworkTypes -> (список)

Протокол адресации IP, поддерживаемый группой подсетей. Используется экземпляром репликации со значениями, такими как только IPv4 или Dual-stack, который поддерживает как адресацию IPv4, так и IPv6. IPv6 только пока не поддерживается.

(строка)

PreferredMaintenanceWindow -> (строка)

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

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

Запланированные значения модификации.

ReplicationInstanceClass -> (строка)

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

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

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

Объем памяти (в гигабайтах), выделенный для экземпляра репликации.

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

Указывает, является ли экземпляр репликации развертыванием Multi-AZ. Вы не можете установить параметр AvailabilityZone, если параметр Multi-AZ установлен на true.

EngineVersion -> (строка)

Номер версии движка экземпляра репликации.

NetworkType -> (строка)

Тип протокола IP-адреса, используемого экземпляром репликации, например, только IPv4 или Dual-stack, который поддерживает как адресацию IPv4, так и IPv6. IPv6 только пока не поддерживается.

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

Указывает, является ли экземпляр репликации развертыванием Multi-AZ. Вы не можете установить параметр AvailabilityZone, если параметр Multi-AZ установлен на true.

EngineVersion -> (строка)

Номер версии движка экземпляра репликации.

Если номер версии движка не указан при создании экземпляра репликации, используется последняя доступная версия движка.

При модификации основной версии движка экземпляра также установите AllowMajorVersionUpgrade на true.

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

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

KmsKeyId -> (строка)

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

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

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

ReplicationInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра репликации.

ReplicationInstancePublicIpAddress -> (строка)

Общедоступный IP-адрес экземпляра репликации.

ReplicationInstancePrivateIpAddress -> (строка)

Приватный IP-адрес экземпляра репликации.

ReplicationInstancePublicIpAddresses -> (список)

Один или несколько общедоступных IP-адресов для экземпляра репликации.

(строка)

ReplicationInstancePrivateIpAddresses -> (список)

Один или несколько приватных IP-адресов для экземпляра репликации.

(строка)

ReplicationInstanceIpv6Addresses -> (список)

Один или несколько адресов IPv6 для экземпляра репликации.

(строка)

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

Указывает параметры доступности для экземпляра репликации. Значение true представляет экземпляр с общедоступным IP-адресом. Значение false представляет экземпляр с приватным IP-адресом. Значение по умолчанию - true.

SecondaryAvailabilityZone -> (строка)

Зона доступности резервного экземпляра репликации в развертывании Multi-AZ.

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

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

DnsNameServers -> (строка)

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

NetworkType -> (строка)

Тип протокола IP-адреса, используемого экземпляром репликации, например, только IPv4 или Dual-stack, который поддерживает как адресацию IPv4, так и IPv6. IPv6 только пока не поддерживается.

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

Указывает параметры, необходимые для аутентификации Kerberos при репликации экземпляра.

KeyCacheSecretId -> (строка)

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

KeyCacheSecretIamArn -> (строка)

Указывает Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Web Services DMS доступ к секрету, содержащему файл кэша ключей для аутентификации Kerberos.

Krb5FileContents -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API