Spec-Zone.ru › AWS CLI v2

[ aws . memorydb ]

create-cluster

Описание

Создаёт кластер. Все узлы в кластере используют одинаковый протокол-совместимый движок программного обеспечения.

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

Синтаксис

  create-cluster
--cluster-name <value>
--node-type <value>
[--multi-region-cluster-name <value>]
[--parameter-group-name <value>]
[--description <value>]
[--num-shards <value>]
[--num-replicas-per-shard <value>]
[--subnet-group-name <value>]
[--security-group-ids <value>]
[--maintenance-window <value>]
[--port <value>]
[--sns-topic-arn <value>]
[--tls-enabled | --no-tls-enabled]
[--kms-key-id <value>]
[--snapshot-arns <value>]
[--snapshot-name <value>]
[--snapshot-retention-limit <value>]
[--tags <value>]
[--snapshot-window <value>]
--acl-name <value>
[--engine <value>]
[--engine-version <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--data-tiering | --no-data-tiering]
[--network-type <value>]
[--ip-discovery <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]

Параметры

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

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

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

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

--multi-region-cluster-name (строка)

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

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

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

--description (строка)

Необязательное описание кластера.

--num-shards (целое число)

Количество фрагментов, которые будет содержать кластер. По умолчанию значение равно 1.

--num-replicas-per-shard (целое число)

Количество реплик, применяемых к каждому фрагменту. По умолчанию значение равно 1. Максимальное значение — 5.

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

--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 (целое число)

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

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

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

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

Флаг для включения шифрования данных во время передачи в кластере.

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

--tags (список)

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

(структура)

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

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

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

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

Значение тега. Может быть нулевым.

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

Key=string,Value=string ...

Синтаксис JSON:

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

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

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

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

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

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

Имя списка управления доступом (ACL), которое нужно ассоциировать с кластером.

--engine (строка)

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

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

Номер версии движка Redis OSS, который будет использоваться для кластера.

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

При установке в значение true кластер будет автоматически получать незначительные обновления версии движка после запуска.

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

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

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

Указывает тип IP-адреса для кластера. Допустимые значения — ‘ipv4’, ‘ipv6’ или ‘dual_stack’. При установке в ‘ipv4’ кластер будет доступен только по IP-адресам IPv4. При установке в ‘ipv6’ кластер будет доступен только по IP-адресам IPv6. При установке в ‘dual_stack’ кластер будет доступен как по IP-адресам IPv4, так и по IP-адресам IPv6. Если не указано, по умолчанию значение равно ‘ipv4’.

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

  • ipv4
  • ipv6
  • dual_stack

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

Механизм обнаружения IP-адресов для протокола обнаружения кластера. Допустимые значения — ‘ipv4’ или ‘ipv6’. При установке в ‘ipv4’ функции обнаружения кластера, такие как слоты кластера, фрагменты кластера и узлы кластера, возвращают IP-адреса IPv4 для узлов кластера. При установке в ‘ipv6’ функции обнаружения кластера возвращают IP-адреса IPv6 для узлов кластера. Значение должно быть совместимо с параметром NetworkType. Если не указано, по умолчанию значение равно ‘ipv4’.

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

  • ipv4
  • ipv6

--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 для вывода.

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

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Более подробную информацию можно найти в руководстве по началу работы в Руководстве пользователя AWS CLI.

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

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

Следующий пример создает новый кластер.

aws memorydb create-cluster \
    --cluster-name my-new-cluster \
    --node-type db.r6g.large \
    --acl-name my-acl \
    --subnet-group my-sg

Вывод:

{
    "Cluster": {
        "Name": "my-new-cluster",
        "Status": "creating",
        "NumberOfShards": 1,
        "AvailabilityMode": "MultiAZ",
        "ClusterEndpoint": {
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:cluster/my-new-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "sat:10:00-sat:11:00",
        "SnapshotWindow": "07:30-08:30",
        "ACLName": "my-acl",
        "AutoMinorVersionUpgrade": true
    }
}

Для получения дополнительной информации см. Управление кластерами в Руководстве пользователя MemoryDB.

Вывод

Кластер -> (структура)

Недавно созданный кластер.

Имя -> (строка)

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

Описание -> (строка)

Описание кластера

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

Статус кластера. Например, Доступен, Обновляется, Создается.

Ожидаемые обновления -> (структура)

Группа настроек, которые в настоящее время применяются.

Перераспределение -> (структура)

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

Перенос слотов -> (структура)

Статус переноса слотов при онлайн-перераспределении

Процент выполнения -> (двойное)

Процент завершенного переноса слотов.

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

Список ACL, связанных с кластером, которые обновляются

Применяемый ACL -> (строка)

Список ACL, ожидающих применения.

Обновления сервиса -> (список)

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

(структура)

Действие обновления сервиса, которое еще не обработано для соответствующего запроса применения/остановки

Имя обновления сервиса -> (строка)

Уникальный идентификатор обновления сервиса

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

Статус обновления сервиса

Имя кластера MultiRegion -> (строка)

Имя многорегионального кластера, к которому принадлежит этот кластер.

Количество фрагментов -> (целое)

Количество фрагментов в кластере

Фрагменты -> (список)

Список фрагментов, являющихся членами кластера.

(структура)

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

Имя -> (строка)

Имя фрагмента

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

Текущее состояние этой группы репликации: создание, доступно, изменение, удаление.

Слоты -> (строка)

Пространство имен для этого фрагмента.

Узлы -> (список)

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

(структура)

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

Имя -> (строка)

Идентификатор узла. Имя узла — это числовой идентификатор (0001, 0002 и т. д.). Сочетание имени кластера, имени фрагмента и имени узла однозначно идентифицирует каждый узел, используемый в учетной записи Amazon клиента.

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

Статус обновления сервиса на узле

Доступная зона -> (строка)

Доступная зона, в которой находится узел

Время создания -> (метка времени)

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

Конечная точка -> (структура)

Имя хоста для подключения к этому узлу.

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

DNS-имя хоста узла.

Порт -> (целое)

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

Количество узлов -> (целое)

Количество узлов в фрагменте

Режим доступности -> (строка)

Указывает, имеет ли кластер конфигурацию Multi-AZ (multiaz) или нет (singleaz).

Конечная точка кластера -> (структура)

Конфигурационная конечная точка кластера

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

DNS-имя хоста узла.

Порт -> (целое)

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

Тип узла -> (строка)

Тип узла кластера

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

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

Версия движка -> (строка)

Версия движка Redis OSS, используемого кластером

Версия патча движка -> (строка)

Версия патча движка Redis OSS, используемого кластером

Имя группы параметров -> (строка)

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

Статус группы параметров -> (строка)

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

Группы безопасности -> (список)

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

(структура)

Представляет отдельную группу безопасности и ее статус.

Идентификатор группы безопасности -> (строка)

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

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

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

Имя группы подсетей -> (строка)

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

Включено TLS -> (булево)

Флаг, указывающий, включено ли шифрование в пути передачи данных

KmsKeyId -> (строка)

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

ARN -> (строка)

Amazon Resource Name (ARN) кластера.

SnsTopicArn -> (строка)

Amazon Resource Name (ARN) темы уведомлений SNS

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

Тема SNS должна быть в активном состоянии для получения уведомлений

Предел сохранения снимков -> (целое)

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

Интервал технического обслуживания -> (строка)

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

Интервал создания снимков -> (строка)

Ежедневный интервал времени (в UTC), в течение которого MemoryDB начинает создание ежедневного снимка вашего фрагмента. Пример: 05:00-09:00. Если вы не укажете этот параметр, MemoryDB автоматически выберет подходящий интервал времени.

Имя ACL -> (строка)

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

Автоматическое обновление до младшей версии -> (булево)

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

Иерархия данных -> (строка)

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

Тип сети -> (строка)

Тип IP-адресов для кластера. Возвращает «ipv4» для только IPv4, «ipv6» для только IPv6 или «dual-stack», если кластер поддерживает как адреса IPv4, так и IPv6.

Обнаружение IP-адресов -> (строка)

Механизм, используемый кластером для обнаружения IP-адресов. Возвращает «ipv4», когда DNS-конечные точки разрешаются до адресов IPv4, или «ipv6», когда DNS-конечные точки разрешаются до адресов IPv6.

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

Spec-Zone.ru

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