Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

создать-группу-репликации

Описание

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

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

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

Кластер Valkey или Redis OSS, режим кластера включен, состоит из 1 до 90 фрагментов (API/CLI: группы узлов). Каждый фрагмент имеет первичный узел и до 5 реплик только для чтения. Конфигурация может варьироваться от 90 фрагментов и 0 реплик до 15 фрагментов и 5 реплик, что является максимальным количеством разрешенных реплик.

Предел узлов или фрагментов можно увеличить до максимума 500 на кластер, если версия движка Valkey или Redis OSS составляет 5.0.6 или выше. Например, вы можете настроить кластер из 500 узлов, который варьируется от 83 фрагментов (один первичный и 5 реплик на фрагмент) до 500 фрагментов (один первичный и без реплик). Убедитесь, что достаточно доступных IP-адресов для увеличения. Распространенные трудности включают в себя слишком узкий диапазон CIDR подсетей в группе подсетей или совместное использование подсетей и интенсивное использование другими кластерами. Более подробную информацию см. в разделе Создание группы подсетей . Для версий ниже 5.0.6 предел составляет 250 на кластер.

Чтобы запросить увеличение предела, см. Пределы Amazon Service и выберите тип предела Кол-во узлов на кластер на тип экземпляра .

После успешного создания группы репликации Valkey или Redis OSS (режим кластера отключен) можно добавить один или несколько реплик чтения, до общего количества 5 реплик чтения. Если необходимо увеличить или уменьшить количество групп узлов (панель управления: фрагментов), можно использовать масштабирование. Дополнительную информацию см. в руководстве пользователя ElastiCache в разделе Масштабирование самостоятельно созданных кластеров.

Примечание

Данная операция действительна только для Valkey и Redis OSS.

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

Синтаксис

  create-replication-group
--replication-group-id <value>
--replication-group-description <value>
[--global-replication-group-id <value>]
[--primary-cluster-id <value>]
[--automatic-failover-enabled | --no-automatic-failover-enabled]
[--multi-az-enabled | --no-multi-az-enabled]
[--num-cache-clusters <value>]
[--preferred-cache-cluster-azs <value>]
[--num-node-groups <value>]
[--replicas-per-node-group <value>]
[--node-group-configuration <value>]
[--cache-node-type <value>]
[--engine <value>]
[--engine-version <value>]
[--cache-parameter-group-name <value>]
[--cache-subnet-group-name <value>]
[--cache-security-group-names <value>]
[--security-group-ids <value>]
[--tags <value>]
[--snapshot-arns <value>]
[--snapshot-name <value>]
[--preferred-maintenance-window <value>]
[--port <value>]
[--notification-topic-arn <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--snapshot-retention-limit <value>]
[--snapshot-window <value>]
[--auth-token <value>]
[--transit-encryption-enabled | --no-transit-encryption-enabled]
[--at-rest-encryption-enabled | --no-at-rest-encryption-enabled]
[--kms-key-id <value>]
[--user-group-ids <value>]
[--log-delivery-configurations <value>]
[--data-tiering-enabled | --no-data-tiering-enabled]
[--network-type <value>]
[--ip-discovery <value>]
[--transit-encryption-mode <value>]
[--cluster-mode <value>]
[--serverless-cache-snapshot-name <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 (строка)

Идентификатор группы репликации. Этот параметр хранится в виде строчной строки.

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

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

--replication-group-description (строка)

Пользовательское описание группы репликации.

--global-replication-group-id (строка)

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

--primary-cluster-id (строка)

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

Этот параметр не требуется, если указан параметр NumCacheClusters , NumNodeGroups или ReplicasPerNodeGroup.

--automatic-failover-enabled | --no-automatic-failover-enabled (логическое значение)

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

AutomaticFailoverEnabled должен быть включен для групп репликации Valkey или Redis OSS (включен режим кластера).

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

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

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

--num-cache-clusters (целое число)

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

Этот параметр не используется, если имеется более одной группы узлов (фрагмента). Вместо этого следует использовать ReplicasPerNodeGroup.

Если AutomaticFailoverEnabled равен true , значение этого параметра должно быть не менее 2. Если AutomaticFailoverEnabled равен false , можно опустить этот параметр (он будет по умолчанию равен 1), или явно задать его значение от 2 до 6.

Максимально допустимое значение для NumCacheClusters составляет 6 (1 первичный плюс 5 реплик).

--preferred-cache-cluster-azs (список)

Список зон доступности EC2, в которых создаются кластеры группы репликации. Порядок зон доступности в списке соответствует порядку распределения кластеров. Первичный кластер создаётся в первой зоне доступности в списке.

Этот параметр не используется, если имеется более одной группы узлов (фрагмента). Вместо этого следует использовать NodeGroupConfiguration.

Примечание

Если вы создаёте группу репликации в Amazon VPC (рекомендуется), вы можете разместить кластеры только в зонах доступности, связанных с подсетями в выбранной группе подсетей.

Количество указанных зон доступности должно быть равно значению NumCacheClusters.

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

(строка)

Синтаксис:

"string" "string" ...

--num-node-groups (целое число)

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

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

--replicas-per-node-group (целое число)

Необязательный параметр, который указывает количество узлов-реплик в каждой группе узлов (фрагменте). Допустимые значения: от 0 до 5.

--node-group-configuration (список)

Список параметров конфигурации группы узлов (фрагмента). Каждая конфигурация группы узлов (фрагмента) содержит следующие члены: PrimaryAvailabilityZone , ReplicaAvailabilityZones , ReplicaCount и Slots .

Если вы создаёте группу репликации Valkey или Redis OSS (режим кластера выключен) или Valkey или Redis OSS (режим кластера включён), вы можете использовать этот параметр для индивидуальной настройки каждой группы узлов (фрагмента) или опустить этот параметр. Однако он требуется при инициализации кластера Valkey или Redis OSS (режим кластера включён) из файла S3 rdb. Вы должны настроить каждую группу узлов (фрагмент) с помощью этого параметра, поскольку вам необходимо указать слоты для каждой группы узлов.

(структура)

Параметры конфигурации группы узлов (фрагмента). Каждая конфигурация группы узлов (фрагмента) содержит следующие параметры: Slots , PrimaryAvailabilityZone , ReplicaAvailabilityZones , ReplicaCount .

NodeGroupId -> (строка)

Либо 4-значный идентификатор, предоставленный ElastiCache, либо идентификатор, предоставленный пользователем, для группы узлов, к которой относятся эти значения конфигурации.

Slots -> (строка)

Строка, определяющая пространство имён для конкретной группы узлов. Пространства имён варьируются от 0 до 16 383. Строка имеет формат startkey-endkey .

Пример: "0-3999"

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

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

PrimaryAvailabilityZone -> (строка)

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

ReplicaAvailabilityZones -> (список)

Список зон доступности, которые будут использоваться для реплик чтения. Количество зон доступности в этом списке должно соответствовать значению ReplicaCount или ReplicasPerNodeGroup, если не указано.

(строка)

PrimaryOutpostArn -> (строка)

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

ReplicaOutpostArns -> (список)

ARN аутпоста узлов-реплик.

(строка)

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

NodeGroupId=string,Slots=string,ReplicaCount=integer,PrimaryAvailabilityZone=string,ReplicaAvailabilityZones=string,string,PrimaryOutpostArn=string,ReplicaOutpostArns=string,string ...

Синтаксис JSON:

[
  {
    "NodeGroupId": "string",
    "Slots": "string",
    "ReplicaCount": integer,
    "PrimaryAvailabilityZone": "string",
    "ReplicaAvailabilityZones": ["string", ...],
    "PrimaryOutpostArn": "string",
    "ReplicaOutpostArns": ["string", ...]
  }
  ...
]

--cache-node-type (строка)

Вычислительная и объёмная ёмкость узлов в группе узлов (фрагменте).

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

  • Универсальные:

    • Текущее поколение: Типы узлов M7g : cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , cache.m7g.16xlarge

    Примечание

    Доступность в регионах см. в разделе Поддерживаемые типы узлов

    Типы узлов M6g (доступны только для версии движка Redis OSS 5.0.6 и выше и для версии движка Memcached 1.5.16 и выше): cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge Типы узлов M5: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge Типы узлов M4: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge Типы узлов T4g (доступны только для версии движка Redis OSS 5.0.6 и выше и для версии движка Memcached 1.5.16 и выше): cache.t4g.micro , cache.t4g.small , cache.t4g.medium Типы узлов T3: cache.t3.micro , cache.t3.small , cache.t3.medium Типы узлов T2: cache.t2.micro , cache.t2.small , cache.t2.medium

    • Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов T1: cache.t1.micro Типы узлов M1: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge Типы узлов M3: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge

  • Оптимизированные для вычислений:

    • Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов C1: cache.c1.xlarge

  • Оптимизированные для памяти:

    • Текущее поколение: Типы узлов R7g : cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , cache.r7g.16xlarge

    Примечание

    Доступность в регионах см. в разделе Поддерживаемые типы узлов

    Типы узлов R6g (доступны только для версии движка Redis OSS 5.0.6 и выше и для версии движка Memcached 1.5.16 и выше): cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge Типы узлов R5: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge Типы узлов R4: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge

    • Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов M2: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge Типы узлов R3: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Дополнительная информация о типах узлов
  • Все типы экземпляров текущего поколения создаются по умолчанию в Amazon VPC.
  • Файлы с придатком только для добавления (AOF) Valkey или Redis OSS не поддерживаются для экземпляров T1 или T2.
  • Multi-AZ с автоматическим переключением Valkey или Redis OSS не поддерживается на экземплярах T1.
  • Переменные конфигурации appendonly и appendfsync не поддерживаются для Valkey или для Redis OSS версии 2.8.22 и выше.

--engine (строка)

Имя используемого кеш-движка для кластеров в этой группе репликации. Значение должно быть установлено на valkey или redis .

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

Номер версии кеш-движка, который будет использоваться для кластеров в этой группе репликации. Чтобы просмотреть поддерживаемые версии кеш-движка, используйте операцию DescribeCacheEngineVersions.

Важно: Вы можете выполнить обновление до более новой версии движка (см. Выбор кеш-движка и версии ) в руководстве пользователя ElastiCache, но вы не можете выполнить понижение до более ранней версии движка. Если вы хотите использовать более раннюю версию движка, вы должны удалить существующий кластер или группу репликации и создать её заново с более ранней версией движка.

--cache-parameter-group-name (строка)

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

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

  • Для создания группы репликации Valkey или Redis OSS (режим кластера отключен), используйте CacheParameterGroupName=default.redis3.2 .
  • Для создания группы репликации Valkey или Redis OSS (режим кластера включен), используйте CacheParameterGroupName=default.redis3.2.cluster.on .

--cache-subnet-group-name (строка)

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

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

Если вы собираетесь запускать свой кластер в Amazon VPC, вам необходимо создать группу подсетей перед началом создания кластера. Дополнительную информацию см. в разделе Подсети и группы подсетей .

--cache-security-group-names (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

Одна или несколько групп безопасности Amazon VPC, связанных с этой группой репликации.

Используйте этот параметр только при создании группы репликации в Amazon Virtual Private Cloud (Amazon VPC).

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Список тегов, которые необходимо добавить к этому ресурсу. Теги представляют собой разделенные запятыми пары ключ-значение (например, Key=``myKey`` , Value=``myKeyValue`` . Вы можете включать несколько тегов, как показано ниже: Key=``myKey`` , Value=``myKeyValue`` Key=``mySecondKey`` , Value=``mySecondKeyValue`` . Теги в группах репликации будут реплицированы на все узлы.

(структура)

Тег, который можно добавить к кластеру или группе репликации ElastiCache. Теги состоят из пары ключ/значение. Вы можете использовать теги для категоризации и отслеживания всех ваших ресурсов ElastiCache, за исключением глобальной группы репликации. При добавлении или удалении тегов в группах репликации эти действия будут реплицированы на все узлы в группе репликации. Разрешен тег со значением null.

Key -> (строка)

Ключ тега. Не может быть null.

Value -> (строка)

Значение тега. Может быть null.

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

Key=string,Value=string ...

JSON-синтаксис:

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

--snapshot-arns (список)

Список Amazon Resource Names (ARN), уникально идентифицирующих файлы моментальных снимков Valkey или Redis OSS RDB, хранящиеся в Amazon S3. Файлы моментальных снимков используются для заполнения новой группы репликации. Имя объекта Amazon S3 в ARN не может содержать запятые. Новая группа репликации будет иметь количество групп узлов (консоль: фрагменты), указанное параметром NumNodeGroups или количество групп узлов, настроенных параметром NodeGroupConfiguration, независимо от количества указанных здесь ARN.

Пример ARN Amazon S3: arn:aws:s3:::my_bucket/snapshot1.rdb

(строка)

Синтаксис:

"string" "string" ...

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

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

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

Указывает диапазон времени в течение недели, в который выполняется техническое обслуживание кластера. Он задается как диапазон в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат времени UTC). Минимальный период окна технического обслуживания составляет 60 минут.

Допустимые значения для ddd :

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Пример: sun:23:00-mon:01:30

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

Номер порта, на котором каждый член группы репликации принимает подключения.

--notification-topic-arn (строка)

Amazon Resource Name (ARN) темы Amazon Simple Notification Service (SNS), в которую отправляются уведомления.

Примечание

Владелец темы Amazon SNS должен совпадать с владельцем кластера.

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

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

--snapshot-retention-limit (целое число)

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

По умолчанию: 0 (т. е. автоматические резервные копии для этого кластера отключены).

--snapshot-window (строка)

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

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

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

--auth-token (строка)

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

AuthToken может быть указан только в группах репликации, где TransitEncryptionEnabled является true .

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

Для соответствия HIPAA необходимо указать TransitEncryptionEnabled как true , AuthToken и CacheSubnetGroup .

Ограничения паролей:

  • Должны содержать только печатаемые символы ASCII.
  • Длина должна быть не менее 16 и не более 128 символов.
  • Допустимые печатаемые специальные символы: !, &, #, $, ^, <, > и -. Другие печатаемые специальные символы не могут быть использованы в марке AUTH.

Дополнительную информацию см. в AUTH password на http://redis.io/commands/AUTH.

--transit-encryption-enabled | --no-transit-encryption-enabled (логическое значение)

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

Этот параметр действителен только в том случае, если параметр Engine имеет значение redis , параметр EngineVersion имеет значение 3.2.6 , 4.x или более поздней версии, и кластер создается в Amazon VPC.

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

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

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

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

Для соответствия HIPAA необходимо указать TransitEncryptionEnabled как true , AuthToken и CacheSubnetGroup .

--at-rest-encryption-enabled | --no-at-rest-encryption-enabled (логическое значение)

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

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

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

По умолчанию: true при использовании Valkey, false при использовании Redis OSS

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

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

--user-group-ids (список)

Группа пользователей, которую следует связать с группой репликации.

(строка)

Синтаксис:

"string" "string" ...

--log-delivery-configurations (список)

Указывает место назначения, формат и тип логов.

(структура)

Указывает место назначения, формат и тип логов.

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

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

Укажите, включена ли доставка логов. По умолчанию true .

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

LogType=string,DestinationType=string,DestinationDetails={CloudWatchLogsDetails={LogGroup=string},KinesisFirehoseDetails={DeliveryStream=string}},LogFormat=string,Enabled=boolean ...

JSON-синтаксис:

[
  {
    "LogType": "slow-log"|"engine-log",
    "DestinationType": "cloudwatch-logs"|"kinesis-firehose",
    "DestinationDetails": {
      "CloudWatchLogsDetails": {
        "LogGroup": "string"
      },
      "KinesisFirehoseDetails": {
        "DeliveryStream": "string"
      }
    },
    "LogFormat": "text"|"json",
    "Enabled": true|false
  }
  ...
]

--data-tiering-enabled | --no-data-tiering-enabled (логическое значение)

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

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

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

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

  • ipv4
  • ipv6
  • dual_stack

--ip-discovery (строка)

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

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

  • ipv4
  • ipv6

--transit-encryption-mode (строка)

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

При установке значения TransitEncryptionEnabled на true, вы можете установить значение TransitEncryptionMode на preferred в том же запросе, чтобы разрешить одновременное использование зашифрованных и незашифрованных подключений. После миграции всех клиентов Valkey или Redis OSS на использование зашифрованных подключений, вы можете изменить значение на required, чтобы разрешить только зашифрованные подключения.

Установка значения TransitEncryptionMode на required — двухэтапный процесс, требующий предварительной установки значения TransitEncryptionMode на preferred, после чего можно установить значение TransitEncryptionMode на required.

Этот процесс не вызовет замену группы репликации.

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

  • preferred
  • required

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

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

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

  • enabled
  • disabled
  • compatible

--serverless-cache-snapshot-name (строка)

Имя снимка, используемого для создания группы репликации. Доступно только для Valkey и Redis OSS.

--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-replication-group создаёт группу репликации Redis (с выключенным режимом кластера) или Redis (с включённым режимом кластера). Эта операция действительна только для Redis.

aws elasticache create-replication-group \
    --replication-group-id "mygroup" \
    --replication-group-description "my group" \
    --engine "redis" \
    --cache-node-type "cache.m5.large"

Вывод:

{
    "ReplicationGroup": {
        "ReplicationGroupId": "mygroup",
        "Description": "my group",
        "Status": "creating",
        "PendingModifiedValues": {},
        "MemberClusters": [
            "mygroup-001"
        ],
        "AutomaticFailover": "disabled",
        "SnapshotRetentionLimit": 0,
        "SnapshotWindow": "06:00-07:00",
        "ClusterEnabled": false,
        "CacheNodeType": "cache.m5.large",
        "TransitEncryptionEnabled": false,
        "AtRestEncryptionEnabled": false
    }
}

Дополнительную информацию см. в разделе Создание группы репликации Redis в Руководстве пользователя Elasticache.

Вывод

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 -> (строка)

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

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 -> (строка)

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

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 -> (строка)

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

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