Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

Изменить группу пользователей

Описание

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

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

Синтаксис

  modify-user-group
--user-group-id <value>
[--user-ids-to-add <value>]
[--user-ids-to-remove <value>]
[--engine <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]

Параметры

--user-group-id (строка)

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

--user-ids-to-add (список)

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

(строка)

Синтаксис:

"string" "string" ...

--user-ids-to-remove (список)

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

(строка)

Синтаксис:

"string" "string" ...

--engine (строка)

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

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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 в Руководстве пользователя AWS CLI.

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

Чтобы изменить группу пользователей

В следующем modify-user-group примере добавляется пользователь в группу пользователей.

aws elasticache modify-user-group \
    --user-group-id myusergroup \
    --user-ids-to-add user1

Вывод:

{
    "UserGroupId": "myusergroup",
    "Status": "modifying",
    "Engine": "redis",
    "UserIds": [
        "default"
    ],
    "PendingChanges": {
        "UserIdsToAdd": [
            "user1"
        ]
    },
    "ReplicationGroups": [],
    "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup"
}

Дополнительную информацию см. в разделе "Проверка пользователей с помощью управления доступом на основе ролей (RBAC)" в Руководстве пользователя Elasticache.

Вывод

UserGroupId -> (строка)

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

Статус -> (строка)

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

Движок -> (строка)

Доступные значения: valkey или redis.

UserIds -> (список)

Список идентификаторов пользователей, принадлежащих к группе пользователей.

(строка)

MinimumEngineVersion -> (строка)

Минимальная версия движка, необходимая, которая является Redis OSS 6.0

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

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

UserIdsToRemove -> (список)

Список идентификаторов пользователей для удаления.

(строка)

UserIdsToAdd -> (список)

Список идентификаторов пользователей для добавления.

(строка)

ReplicationGroups -> (список)

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

(строка)

ServerlessCaches -> (список)

Указывает, с какими серверными кэшами связана указанная группа пользователей. Доступно только для Valkey, Redis OSS и Serverless Memcached.

(строка)

ARN -> (строка)

Amazon Resource Name (ARN) группы пользователей.

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

Spec-Zone.ru

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