Spec-Zone.ru › AWS CLI v2

[ aws . snowball ]

update-cluster

Описание

Пока значение ClusterState кластера находится в состоянии AwaitingQuorum, вы можете обновить некоторые данные, связанные с этим кластером. После того, как состояние кластера изменится на другое состояние задания, обычно через 60 минут после создания кластера, данное действие станет недоступным.

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

Синтаксис

  update-cluster
--cluster-id <value>
[--role-arn <value>]
[--description <value>]
[--resources <value>]
[--on-device-service-configuration <value>]
[--address-id <value>]
[--shipping-option <value>]
[--notification <value>]
[--forwarding-address-id <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-id (строка)

Идентификатор кластера, который вы хотите обновить, например, CID123e4567-e89b-12d3-a456-426655440000.

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

Новый Amazon Resource Name (ARN) роли, которую вы хотите связать с этим кластером. Для создания ARN роли используйте действие CreateRole API в службе управления идентификацией и доступом (IAM).

--description (строка)

Обновлённое описание этого кластера.

--resources (структура)

Обновлённые массивы объектов JobResource, которые могут включать обновлённые объекты S3Resource или LambdaResource.

S3Resources -> (список)

Массив объектов S3Resource.

(структура)

Каждый объект S3Resource представляет собой ведро Amazon S3, из которого или в которое будет экспортироваться/импортироваться переносимые данные. Для заданий экспорта этот объект может иметь необязательное значение KeyRange. Длина диапазона определена при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны отсортированы по UTF-8 двоичному порядку.

BucketArn -> (строка)

Amazon Resource Name (ARN) ведра Amazon S3.

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

Для заданий экспорта вы можете указать необязательный KeyRange в определённом ведре Amazon S3. Длина диапазона определена при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны отсортированы по UTF-8 двоичному порядку.

BeginMarker -> (строка)

Ключ, который начинает необязательный диапазон ключей для задания экспорта. Диапазоны включательные и отсортированы по двоичному порядку UTF-8.

EndMarker -> (строка)

Ключ, который заканчивает необязательный диапазон ключей для задания экспорта. Диапазоны включательные и отсортированы по двоичному порядку UTF-8.

TargetOnDeviceServices -> (список)

Указывает службу или службы на устройстве семейства Snow, из которой или в которую будут экспортироваться/импортироваться переносимые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

(структура)

Объект, представляющий службу или службы на устройстве семейства Snow, из которой или в которую будут экспортироваться/импортироваться переносимые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

ServiceName -> (строка)

Указывает имя службы на устройстве семейства Snow, из которой или в которую будут экспортироваться/импортироваться переносимые данные.

TransferOption -> (строка)

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

LambdaResources -> (список)

Функции Lambda на языке Python для этого задания.

(структура)

Идентифицирует

LambdaArn -> (строка)

Amazon Resource Name (ARN), который представляет функцию Lambda, которая будет вызываться действиями PUT объекта в связанном локальном ресурсе Amazon S3.

EventTriggers -> (список)

Массив ARNs для объектов S3Resource, которые будут вызывать объекты LambdaResource, связанные с этим заданием.

(структура)

Контейнер для EventTriggerDefinition$EventResourceARN.

EventResourceARN -> (строка)

Amazon Resource Name (ARN) любого локального ресурса Amazon S3, являющегося триггером события функции Lambda, связанной с этим заданием.

Ec2AmiResources -> (список)

Связанные с этим заданием Amazon Machine Images (AMIs).

(структура)

Объект в формате JSON, содержащий идентификаторы Amazon Machine Image (AMI), включая идентификатор совместимого с Amazon EC2 AMI и идентификатор AMI устройства Snow. У каждой AMI есть эти два идентификатора для упрощения идентификации AMI как в облаке Amazon Web Services, так и на устройстве.

AmiId -> (строка)

Идентификатор AMI в Amazon EC2.

SnowballAmiId -> (строка)

Идентификатор AMI на устройстве Snow.

Синтаксис JSON:

{
  "S3Resources": [
    {
      "BucketArn": "string",
      "KeyRange": {
        "BeginMarker": "string",
        "EndMarker": "string"
      },
      "TargetOnDeviceServices": [
        {
          "ServiceName": "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE",
          "TransferOption": "IMPORT"|"EXPORT"|"LOCAL_USE"
        }
        ...
      ]
    }
    ...
  ],
  "LambdaResources": [
    {
      "LambdaArn": "string",
      "EventTriggers": [
        {
          "EventResourceARN": "string"
        }
        ...
      ]
    }
    ...
  ],
  "Ec2AmiResources": [
    {
      "AmiId": "string",
      "SnowballAmiId": "string"
    }
    ...
  ]
}

--on-device-service-configuration (структура)

Указывает службу или службы на устройстве семейства Snow, из которых или в которые будут экспортироваться/импортироваться переносимые данные. Устройства кластеров семейства Snow Amazon Web Services поддерживают Amazon S3 и NFS (Network File System).

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

Представляет службу NFS (Network File System) на устройстве семейства Snow.

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

Максимальный объём хранения NFS для одного устройства семейства Snow.

StorageUnit -> (строка)

Единица измерения объёма хранения NFS на устройстве.

Допустимые значения: TB.

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

Представляет службу Storage Gateway типа Tape Gateway на устройстве семейства Snow.

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

Максимальное количество виртуальных лент для хранения на одном устройстве семейства Snow. Из-за ограничений физических ресурсов это значение должно быть установлено в 80 для Snowball Edge.

StorageUnit -> (строка)

Единица измерения виртуальных лент на устройстве.

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

Настройка EKS Anywhere на устройстве семейства Snow.

KubernetesVersion -> (строка)

Версия Kubernetes для EKS Anywhere на устройстве семейства Snow.

EKSAnywhereVersion -> (строка)

Необязательная версия EKS Anywhere на устройстве семейства Snow.

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

Настройка совместимого с Amazon S3 хранения на устройствах семейства Snow.

StorageLimit -> (двойное значение)

Если указанное значение ограничения объёма хранения совпадает с ограничением объёма хранения одной из определённых конфигураций, будет использована эта конфигурация. Если указанное значение ограничения объёма хранения не совпадает ни с одной из определённых конфигураций, запрос будет отклонен. Если более чем одна конфигурация имеет то же ограничение объёма хранения, что и указанное, необходимо предоставить другие входные данные.

StorageUnit -> (строка)

Единица измерения объёма хранения. В настоящее время поддерживается только единица TB.

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

Применимо при создании кластера. Указывает количество узлов, необходимых для совместимого с Amazon S3 хранения на устройствах семейства Snow. Если указано, другие входные данные можно опустить.

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

Уровень отказоустойчивости кластера. Это указывает на количество узлов, которые могут выйти из строя, не ухудшая производительности кластера. Эти дополнительные входные данные полезны, когда указанное StorageLimit совпадает более чем с одной конфигурацией службы хранения, совместимой с Amazon S3, на устройствах семейства Snow.

Краткая запись:

NFSOnDeviceService={StorageLimit=integer,StorageUnit=string},TGWOnDeviceService={StorageLimit=integer,StorageUnit=string},EKSOnDeviceService={KubernetesVersion=string,EKSAnywhereVersion=string},S3OnDeviceService={StorageLimit=double,StorageUnit=string,ServiceSize=integer,FaultTolerance=integer}

Синтаксис JSON:

{
  "NFSOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "TGWOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "EKSOnDeviceService": {
    "KubernetesVersion": "string",
    "EKSAnywhereVersion": "string"
  },
  "S3OnDeviceService": {
    "StorageLimit": double,
    "StorageUnit": "TB",
    "ServiceSize": integer,
    "FaultTolerance": integer
  }
}

--address-id (строка)

Идентификатор обновлённого объекта Address.

--shipping-option (строка)

Обновлённое значение параметра доставки для объекта ShippingDetails этого кластера.

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

  • SECOND_DAY
  • NEXT_DAY
  • EXPRESS
  • STANDARD

--notification (структура)

Новый или обновлённый объект Notification.

SnsTopicARN -> (строка)

Новый SNS TopicArn, который вы хотите связать с этим заданием. Вы можете создавать Amazon Resource Names (ARN) для тем, используя действие CreateTopic API Amazon SNS.

Вы можете подписывать адреса электронной почты на тему Amazon SNS с помощью консоли управления Amazon Web Services или с помощью действия Subscribe API Amazon Simple Notification Service (Amazon SNS).

JobStatesToNotify -> (список)

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

(строка)

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

Любое изменение состояния задания вызовет уведомление для этого задания.

DevicePickupSnsTopicARN -> (строка)

Используется для отправки уведомлений SNS лицу, забирающему устройство (определённому при создании задания).

Краткая запись:

SnsTopicARN=string,JobStatesToNotify=string,string,NotifyAll=boolean,DevicePickupSnsTopicARN=string

Синтаксис JSON:

{
  "SnsTopicARN": "string",
  "JobStatesToNotify": ["New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending", ...],
  "NotifyAll": true|false,
  "DevicePickupSnsTopicARN": "string"
}

--forwarding-address-id (строка)

Обновлённый идентификатор адреса переадресации для кластера. Этот параметр не поддерживается в большинстве регионов.

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL команды заданным URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Нет

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

Spec-Zone.ru

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