Spec-Zone.ru › AWS CLI v2

[ aws . elasticache ]

создать-группу-пользователей

Описание

Для версии движка Valkey 7.2 и выше, а также Redis OSS с 6.0 по 7.1: Создаёт группу пользователей. Для получения дополнительной информации см. Использование управления доступом на основе ролей (RBAC)

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

Синтаксис

  create-user-group
--user-group-id <value>
--engine <value>
[--user-ids <value>]
[--tags <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 (строка)

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

--engine (строка)

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

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

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

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Список тегов, которые необходимо добавить к этому ресурсу. Тег — это пара ключ-значение. Ключу тега обязательно должно соответствовать значение тега, хотя допустимо значение null. Доступно только для Valkey и Redis OSS.

(структура)

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

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

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

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

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

--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
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для создания группы пользователей

Следующий create-user-group пример создает новую группу пользователей.

aws elasticache create-user-group \
    --user-group-id myusergroup \
    --engine redis \
    --user-ids default

Вывод:

{
    "UserGroupId": "myusergroup",
    "Status": "creating",
    "Engine": "redis",
    "UserIds": [
        "default"
    ],
    "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