Spec-Zone.ru › AWS CLI v2

[ aws . dax ]

create-cluster

Описание

Создаёт кластер DAX. Все узлы в кластере работают с одинаковым программным обеспечением кэширования DAX.

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

Синтаксис

  create-cluster
--cluster-name <value>
--node-type <value>
[--description <value>]
--replication-factor <value>
[--availability-zones <value>]
[--subnet-group-name <value>]
[--security-group-ids <value>]
[--preferred-maintenance-window <value>]
[--notification-topic-arn <value>]
--iam-role-arn <value>
[--parameter-group-name <value>]
[--tags <value>]
[--sse-specification <value>]
[--cluster-endpoint-encryption-type <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 (строка)

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

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

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

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

--description (строка)

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

--replication-factor (целое число)

Количество узлов в кластере DAX. Реплицирующий коэффициент 1 создаст кластер из одного узла без каких-либо дополнительных узлов для чтения. Для повышения отказоустойчивости можно создать кластер из нескольких узлов с одним или несколькими дополнительными узлами для чтения. Для этого установите ReplicationFactor значение от 3 (один основной и два дополнительных узла для чтения) до 10 (один основной и девять дополнительных узлов для чтения). Если указан параметр If the AvailabilityZones, его длина должна соответствовать параметру ReplicationFactor.

Примечание

AWS рекомендует иметь как минимум два дополнительных узла для чтения на кластер.

--availability-zones (список)

Availability Zones (AZ) в которых будут находиться узлы кластера после создания или обновления кластера. Если предоставлен, длина этого списка должна соответствовать параметру ReplicationFactor. Если этот параметр опущен, DAX распределит узлы по Availability Zones для обеспечения максимальной доступности.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

Кластеры DAX могут работать только в среде Amazon VPC. Все подсети, которые вы указываете в группе подсетей, должны существовать в одной и той же VPC.

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

Список идентификаторов групп безопасности, которые будут назначены каждому узлу в кластере DAX. (Каждый идентификатор группы безопасности генерируется системой.)

Если этот параметр не указан, DAX назначит каждой ноде стандартную группу безопасности VPC.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

Примечание

Если вы не укажете предпочтительное время обслуживания при создании или изменении кластера кэша, DAX назначит 60-минутное окно обслуживания в случайный день недели.

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

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

Примечание

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

--iam-role-arn (строка)

Действительный Amazon Resource Name (ARN), который идентифицирует роль IAM. Во время выполнения DAX будет принимать на себя эту роль и использовать разрешения роли для доступа к DynamoDB от вашего имени.

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

Группа параметров, которая должна быть связана с кластером DAX.

--tags (список)

Набор тегов, которые необходимо прикрепить к кластеру DAX.

(структура)

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

Названия и значения тегов, назначенные AWS, автоматически получают префикс aws:, который пользователь назначить не может. Названия тегов, назначенные AWS, не учитываются в лимите тегов 50. Названия тегов, назначенные пользователем, имеют префикс user:.

Вы не можете применить тег с обратной датой.

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

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

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

Значение тега. Значения тегов чувствительны к регистру и могут быть null.

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

Key=string,Value=string ...

Синтаксис JSON:

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

--sse-specification (структура)

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

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

Указывает, включено ли шифрование на серверной стороне (true) или выключено (false) в кластере.

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

Enabled=boolean

Синтаксис JSON:

{
  "Enabled": true|false
}

--cluster-endpoint-encryption-type (строка)

Тип шифрования, который должен поддерживать конечная точка кластера. Значения:

  • NONE для отсутствия шифрования
  • TLS для Transport Layer Security

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

  • NONE
  • TLS

--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.

Примеры

Примечание

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

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

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

Следующий create-cluster пример создаёт кластер DAX с указанными параметрами.

aws dax create-cluster \
    --cluster-name daxcluster \
    --node-type dax.r4.large \
    --replication-factor 3 \
    --iam-role-arn roleARN  \
    --sse-specification Enabled=true

Вывод:

{
    "Cluster": {
        "ClusterName": "daxcluster",
        "ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
        "TotalNodes": 3,
        "ActiveNodes": 0,
        "NodeType": "dax.r4.large",
        "Status": "creating",
        "ClusterDiscoveryEndpoint": {
            "Port": 8111
        },
        "PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
        "SubnetGroup": "default",
        "SecurityGroups": [
            {
                "SecurityGroupIdentifier": "sg-1af6e36e",
                "Status": "active"
            }
        ],
        "IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
        "ParameterGroup": {
            "ParameterGroupName": "default.dax1.0",
            "ParameterApplyStatus": "in-sync",
            "NodeIdsToReboot": []
        },
        "SSEDescription": {
            "Status": "ENABLED"
        }
    }
}

Для получения дополнительной информации см. Шаг 3: Создание кластера DAX в руководстве разработчика Amazon DynamoDB.

Вывод

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

Описание созданного кластера DAX.

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

Название кластера DAX.

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

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

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

Уникальный Amazon Resource Name (ARN) кластера.

ОбщееКоличествоУзлов -> (целое число)

Общее количество узлов в кластере.

АктивныеУзлы -> (целое число)

Количество активных узлов в кластере (то есть, способных обрабатывать запросы).

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

Тип узла в кластере. (Все узлы в кластере DAX имеют одинаковый тип.)

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

Текущий статус кластера.

ТочкаДоступаКластера -> (структура)

Точка доступа к этому кластеру DAX, состоящая из имени DNS, номера порта и URL-адреса. Приложения должны использовать URL-адрес для настройки клиента DAX для поиска кластера.

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

Имя хоста DNS точки доступа.

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

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

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

URL-адрес, который приложения должны использовать для подключения к точке доступа. По умолчанию используются порты 8111 для протокола «dax» и 9111 для протокола «daxs».

УзлыДляУдаления -> (список)

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

(строка)

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

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

(структура)

Представляет отдельный узел в кластере DAX.

ИдентификаторУзла -> (строка)

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

ТочкаДоступа -> (структура)

Точка доступа к узлу, состоящая из имени DNS и номера порта. Клиентские приложения могут напрямую подключаться к точке доступа узла, если это необходимо (в качестве альтернативы, позволяя программному обеспечению клиента DAX интеллектуально маршрутизировать запросы и ответы к узлам в кластере DAX).

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

Имя хоста DNS точки доступа.

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

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

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

URL-адрес, который приложения должны использовать для подключения к точке доступа. По умолчанию используются порты 8111 для протокола «dax» и 9111 для протокола «daxs».

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

Дата и время (в формате эпохи UNIX) запуска узла.

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

Доступная зона (AZ), в которой был развернут узел.

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

Текущий статус узла. Например: available .

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

Статус группы параметров, связанной с этим узлом. Например, in-sync .

ПредпочтительныйПериодТехническогоОбслуживания -> (строка)

Интервал времени, когда будет выполняться техническое обслуживание программного обеспечения кластера DAX. Например: sun:01:00-sun:09:00 . Техническое обслуживание кластера обычно занимает меньше 30 минут и выполняется автоматически в течение этого интервала.

НастройкаУведомлений -> (структура)

Описание темы уведомлений и её статуса. Темы уведомлений используются для публикации событий DAX подписчикам с помощью Amazon Simple Notification Service (SNS).

ArnТемы -> (строка)

Amazon Resource Name (ARN), идентифицирующий тему.

СтатусТемы -> (строка)

Текущее состояние темы. Значение «активный» означает, что уведомления будут отправлены в тему. Значение «неактивный» означает, что уведомления не будут отправлены в тему.

ГруппаПодсетей -> (строка)

Группа подсетей, где работает кластер DAX.

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

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

(структура)

Отдельная группа безопасности VPC и её статус.

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

Уникальный идентификатор этой группы безопасности.

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

Статус этой группы безопасности.

ArnРолиIam -> (строка)

Действительный Amazon Resource Name (ARN), идентифицирующий роль IAM. Во время выполнения DAX будет принимать эту роль и использовать разрешения роли для доступа к DynamoDB от вашего имени.

ГруппаПараметров -> (структура)

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

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

Имя группы параметров.

СтатусПримененияПараметров -> (строка)

Статус обновлений параметров.

ИдентификаторыУзловДляПерезагрузки -> (список)

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

(строка)

ОписаниеSSЕ -> (структура)

Описание статуса шифрования на стороне сервера для указанного кластера DAX.

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

Текущее состояние шифрования на стороне сервера:

  • ENABLING - Шифрование на стороне сервера включено.
  • ENABLED - Шифрование на стороне сервера включено.
  • DISABLING - Шифрование на стороне сервера отключается.
  • DISABLED - Шифрование на стороне сервера отключено.

ТипШифрованияТочкиДоступаКластера -> (строка)

Тип шифрования, поддерживаемый точкой доступа кластера. Значения:

  • NONE для отсутствия шифрования TLS для шифрования Transport Layer Security

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

Spec-Zone.ru

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