Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

тест-миграция

Описание

Асинхронный API для проверки соединения между исходной и целевой группой репликации.

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

Синтаксис

  test-migration
--replication-group-id <value>
--customer-node-endpoint-list <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-group-id (строка)

Идентификатор группы репликации, в которую будут мигрированы данные.

--customer-node-endpoint-list (список)

Список конечных точек, с которых должны быть мигрированы данные. Список должен содержать только один элемент.

(структура)

Конечная точка, с которой должны быть мигрированы данные.

Адрес -> (строка)

Адрес узловой конечной точки

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

Порт узловой конечной точки

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

Address=string,Port=integer ...

Синтаксис JSON:

[
  {
    "Address": "string",
    "Port": integer
  }
  ...
]

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

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

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

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

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

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

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

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

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

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

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

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

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

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

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

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

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

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

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

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

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

  • base64
  • raw-in-base64-out

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

Отключить выводом вывод кли пайпера.

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

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

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

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

Вывод

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

Содержит все атрибуты конкретной группы репликации Valkey или Redis OSS.

ReplicationGroupId -> (строка)

Идентификатор группы репликации.

Description -> (строка)

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

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

Имя глобального хранилища данных и роль этой группы репликации в глобальном хранилище данных.

GlobalReplicationGroupId -> (строка)

Имя глобального хранилища данных

GlobalReplicationGroupMemberRole -> (строка)

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

Status -> (строка)

Текущее состояние этой группы репликации - creating , available , modifying , deleting , create-failed , snapshotting .

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

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

PrimaryClusterId -> (строка)

Идентификатор первичного кластера, который применяется немедленно (если --apply-immediately был указан) или в течение следующего окна обслуживания.

AutomaticFailoverStatus -> (строка)

Указывает состояние автоматического переключения для данной группы репликации Valkey или Redis OSS.

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

Состояние операции онлайн-перераспределения.

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

Представляет прогресс операции онлайн-перераспределения.

ProgressPercentage -> (двойное)

Процент завершенной миграции слота.

AuthTokenStatus -> (строка)

Статус маркера аутентификации

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

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

UserGroupIdsToAdd -> (список)

Идентификатор группы пользователей для добавления.

(строка)

UserGroupIdsToRemove -> (список)

Идентификатор группы пользователей для удаления.

(строка)

LogDeliveryConfigurations -> (список)

Настройки доставки логов, которые изменяются

(структура)

Настройки доставки логов, которые изменяются

LogType -> (строка)

Относится к медленным логам или логам движка.

DestinationType -> (строка)

Возвращает тип назначения, либо CloudWatch Logs, либо Kinesis Data Firehose.

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

Подробные данные о назначении CloudWatch Logs или Kinesis Data Firehose.

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

Подробные данные о назначении CloudWatch Logs.

LogGroup -> (строка)

Имя группы логов CloudWatch Logs.

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

Подробные данные о назначении Kinesis Data Firehose.

DeliveryStream -> (строка)

Имя потока доставки Kinesis Data Firehose.

LogFormat -> (строка)

Возвращает формат лога, либо JSON, либо TEXT

TransitEncryptionEnabled -> (булево)

Флаг, который включает шифрование в процессе передачи, когда установлен в значение true.

TransitEncryptionMode -> (строка)

Настройка, которая позволяет мигрировать клиентов на использование шифрования в процессе передачи без простоев.

ClusterMode -> (строка)

Включено или Выключено. Чтобы изменить режим кластера с Выключено на Включено, необходимо сначала установить режим кластера в Совместимый. Режим Совместимый позволяет клиентам Valkey или Redis OSS подключаться, используя как включенный, так и выключенный режим кластера. После миграции всех клиентов Valkey или Redis OSS на использование включенного режима кластера, можно завершить конфигурацию режима кластера и установить режим кластера в Включено.

MemberClusters -> (список)

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

(строка)

NodeGroups -> (список)

Список групп узлов в этой группе репликации. Для групп репликации Valkey или Redis OSS (с выключенным режимом кластера) это список с одним элементом. Для групп репликации Valkey или Redis OSS (с включенным режимом кластера) список содержит запись для каждой группы узлов (фрагмента).

(структура)

Представляет собой набор узлов кэша в группе репликации. Один узел в группе узлов является узлом чтения/записи (первичным). Все остальные узлы являются узлами чтения (репликами).

NodeGroupId -> (строка)

Идентификатор группы узлов (фрагмента). Группа репликации Valkey или Redis OSS (с выключенным режимом кластера) содержит только 1 группу узлов; следовательно, идентификатор группы узлов - 0001. Группа репликации Valkey или Redis OSS (с включенным режимом кластера) содержит от 1 до 90 групп узлов с номерами от 0001 до 0090. Пользователь может дополнительно указать идентификатор группы узлов.

Status -> (строка)

Текущее состояние этой группы репликации - creating , available , modifying , deleting .

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

Адрес первичного узла в этой группе узлов (фрагменте).

Address -> (строка)

DNS имя хоста узла кэша.

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

Номер порта, на котором работает движок кэша.

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

Адрес узлов-реплик в этой группе узлов (фрагменте). Это значение является только для чтения.

Address -> (строка)

DNS имя хоста узла кэша.

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

Номер порта, на котором работает движок кэша.

Slots -> (строка)

Пространство имен для этой группы узлов (фрагмента).

NodeGroupMembers -> (список)

Список, содержащий информацию об отдельных узлах в группе узлов (фрагменте).

(структура)

Представляет один узел в группе узлов (фрагменте).

CacheClusterId -> (строка)

Идентификатор кластера, к которому принадлежит узел.

CacheNodeId -> (строка)

Идентификатор узла в его кластере. Идентификатор узла является числовым идентификатором (0001, 0002 и т. д.).

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

Информация, необходимая клиентским программам для подключения к узлу для операций чтения. Адрес чтения применим только для кластеров Valkey или Redis OSS (с выключенным режимом кластера).

Address -> (строка)

DNS имя хоста узла кэша.

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

Номер порта, на котором работает движок кэша.

PreferredAvailabilityZone -> (строка)

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

PreferredOutpostArn -> (строка)

ARN аутпоста для члена группы узлов.

CurrentRole -> (строка)

Роль, которая в настоящее время назначена узлу - primary или replica. Этот член применим только для групп репликации Valkey или Redis OSS (с выключенным режимом кластера).

SnapshottingClusterId -> (строка)

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

AutomaticFailover -> (строка)

Указывает состояние автоматического переключения для данной группы репликации Valkey или Redis OSS.

MultiAZ -> (строка)

Флаг, указывающий, включен ли Multi-AZ для повышения отказоустойчивости. Дополнительную информацию см. в Minimizing Downtime: Multi-AZ

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

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

Address -> (строка)

DNS имя хоста узла кэша.

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

Номер порта, на котором работает движок кэша.

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

Количество дней, в течение которых ElastiCache сохраняет автоматические снимки кластера перед их удалением. Например, если вы установите SnapshotRetentionLimit в значение 5, снимок, сделанный сегодня, сохраняется в течение 5 дней перед удалением.

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

Если значение SnapshotRetentionLimit установлено в ноль (0), резервные копии отключены.

SnapshotWindow -> (строка)

Ежедневный интервал времени (в UTC), в течение которого ElastiCache начинает создание ежедневного снимка вашей группы узлов (фрагмента).

Пример: 05:00-09:00

Если вы не укажете этот параметр, ElastiCache автоматически выберет подходящий интервал времени.

Примечание

Этот параметр действителен только если параметр Engine имеет значение redis .

ClusterEnabled -> (булево)

Флаг, указывающий, включена ли группа репликации в кластер; т.е., могут ли ее данные быть распределены по нескольким фрагментам (API/CLI: группы узлов).

Допустимые значения: true | false

CacheNodeType -> (строка)

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

AuthTokenEnabled -> (булево)

Флаг, который включает использование AuthToken (пароль) при выполнении команд Valkey или Redis OSS.

По умолчанию: false

AuthTokenLastModifiedDate -> (временная метка)

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

TransitEncryptionEnabled -> (булево)

Флаг, который включает шифрование в процессе передачи, когда установлен в значение true .

Требуется: Доступно только при создании группы репликации в Amazon VPC с использованием версии Redis OSS 3.2.6 , 4.x или более поздней.

По умолчанию: false

AtRestEncryptionEnabled -> (булево)

Флаг, который включает шифрование в состоянии покоя, когда установлен в значение true .

Вы не можете изменить значение AtRestEncryptionEnabled после создания кластера. Чтобы включить шифрование в состоянии покоя в кластере, необходимо установить AtRestEncryptionEnabled в значение true при создании кластера.

Требуется: Доступно только при создании группы репликации в Amazon VPC с использованием версии Redis OSS 3.2.6 , 4.x или более поздней.

По умолчанию: false

MemberClustersOutpostArns -> (список)

ARN аутпостов для членских кластеров группы репликации.

(строка)

KmsKeyId -> (строка)

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

ARN -> (строка)

ARN (Amazon Resource Name) группы репликации.

UserGroupIds -> (список)

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

(строка)

LogDeliveryConfigurations -> (список)

Возвращает пункт назначения, формат и тип журналов.

(структура)

Возвращает пункт назначения, формат и тип журналов.

LogType -> (строка)

Относится к slow-log или engine-log.

DestinationType -> (строка)

Возвращает тип пункта назначения, либо cloudwatch-logs, либо kinesis-firehose.

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

Подробная информация о пункте назначения CloudWatch Logs или Kinesis Data Firehose.

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

Подробная информация о пункте назначения CloudWatch Logs.

LogGroup -> (строка)

Имя группы журналов CloudWatch Logs.

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

Подробная информация о пункте назначения Kinesis Data Firehose.

DeliveryStream -> (строка)

Имя потока доставки Kinesis Data Firehose.

LogFormat -> (строка)

Возвращает формат журнала, либо JSON, либо TEXT.

Status -> (строка)

Возвращает статус конфигурации доставки журналов. Значения могут быть одним из enabling | disabling | modifying | active | error

Message -> (строка)

Возвращает сообщение об ошибке для конфигурации доставки журналов.

ReplicationGroupCreateTime -> (временная метка)

Дата и время создания кластера.

DataTiering -> (строка)

Включает типы хранения данных. Типы хранения данных поддерживаются только для групп репликации, использующих тип узлов r6gd. Этот параметр должен быть установлен в значение true при использовании узлов r6gd. Дополнительные сведения см. в разделе Типы хранения данных.

AutoMinorVersionUpgrade -> (булево)

Если вы используете Valkey 7.2 и выше, или движок Redis OSS версии 6.0 и выше, установите этот параметр в значение "да", если вы хотите принять участие в следующем автоматическом обновлении малой версии. Этот параметр отключен для предыдущих версий.

NetworkType -> (строка)

Должно быть либо ipv4 | ipv6 | dual_stack. IPv6 поддерживается для рабочих нагрузок, использующих Valkey 7.2 и выше, движок Redis OSS версии 6.2 до 7.1 или движок Memcached версии 1.6.6 и выше на всех экземплярах, построенных на системе Nitro.

IpDiscovery -> (строка)

Тип сети, который вы выбираете при изменении кластера, либо ipv4 | ipv6. IPv6 поддерживается для рабочих нагрузок, использующих Valkey 7.2 и выше, движок Redis OSS версии 6.2 до 7.1 или движок Memcached версии 1.6.6 и выше на всех экземплярах, построенных на системе Nitro.

TransitEncryptionMode -> (строка)

Настройка, которая позволяет вам мигрировать клиентов на использование шифрования в процессе передачи без простоя.

ClusterMode -> (строка)

Включено или Выключено. Чтобы изменить режим кластера с Выключено на Включено, сначала необходимо установить режим кластера в Совместимый. Режим Совместимый позволяет вашим клиентам Valkey или Redis OSS подключаться, используя как включенный, так и выключенный режим кластера. После миграции всех клиентов Valkey или Redis OSS на использование включенного режима кластера, вы можете завершить настройку режима кластера и установить его в значение Включено.

Engine -> (строка)

Движок, используемый в группе репликации. Доступные варианты: redis, memcached или valkey.

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

Spec-Zone.ru

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