Spec-Zone.ru › AWS CLI v2

[ aws . snowball ]

create-cluster

Описание

Создаёт пустой кластер. Каждый кластер поддерживает пять узлов. Вы используете действие CreateJob отдельно для создания заданий для каждого из этих узлов. Кластер не отправляется, пока не будут созданы задания для этих пяти узлов.

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

Синтаксис

  create-cluster
--job-type <value>
[--resources <value>]
[--on-device-service-configuration <value>]
[--description <value>]
--address-id <value>
[--kms-key-arn <value>]
[--role-arn <value>]
--snowball-type <value>
--shipping-option <value>
[--notification <value>]
[--forwarding-address-id <value>]
[--tax-documents <value>]
[--remote-management <value>]
[--initial-cluster-size <value>]
[--force-create-jobs | --no-force-create-jobs]
[--long-term-pricing-ids <value>]
[--snowball-capacity-preference <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]

Параметры

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

Тип задачи для данного кластера. В настоящее время единственный поддерживаемый тип задачи для кластеров — LOCAL_USE.

Дополнительную информацию см. в разделе «https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html» (Типы устройств семейства Snow и ёмкость) в руководстве пользователя Snowcone или в разделе «https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html» (Типы устройств семейства Snow и ёмкость) в руководстве разработчика Snowcone.

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

  • IMPORT
  • EXPORT
  • LOCAL_USE

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

Ресурсы, связанные с задачей кластера. Эти ресурсы включают в себя Amazon S3-баки и необязательные функции Lambda, написанные на языке Python.

S3Resources -> (список)

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

(структура)

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

BucketArn -> (строка)

Идентификатор ресурса Amazon (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 (ARN), представляющий функцию Lambda, которая должна быть запущена действиями PUT object на связанном локальном ресурсе Amazon S3.

EventTriggers -> (список)

Массив ARN для объектов S3Resource, которые запускают объекты LambdaResource, связанные с этой задачей.

(структура)

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

EventResourceARN -> (строка)

Идентификатор ресурса Amazon (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, из которого или в который будут экспортироваться/импортироваться данные. Кластеры устройств Amazon Web Services Snow Family поддерживают 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
  }
}

--description (строка)

Необязательное описание данного кластера, например, Environmental Data Cluster-01.

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

Идентификатор адреса, куда требуется доставить кластер.

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

Значение KmsKeyARN, которое вы хотите связать с этим кластером. Значения KmsKeyARN создаются с помощью действия API CreateKey в службе управления ключами (KMS).

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

Значение RoleARN, которое вы хотите связать с этим кластером. Значения RoleArn создаются с помощью действия API CreateRole в службе управления удостоверениями и доступом (IAM).

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

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

Примечание

Для задач кластеров Amazon Web Services Snow Family в настоящее время поддерживается только тип устройства EDGE.

Дополнительную информацию см. в разделе «https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html» (Типы устройств семейства Snow и ёмкость) в руководстве пользователя Snowcone или в разделе «https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html» (Типы устройств семейства Snow и ёмкость) в руководстве разработчика Snowcone.

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

  • STANDARD
  • EDGE
  • EDGE_C
  • EDGE_CG
  • EDGE_S
  • SNC1_HDD
  • SNC1_SSD
  • V3_5C
  • V3_5S
  • RACK_5U_C

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

Скорость доставки для каждого узла в этом кластере. Эта скорость не определяет, как быстро вы получите каждое устройство Snowball Edge, а скорее отражает скорость перемещения каждого устройства к месту назначения в процессе доставки. Скорости доставки по регионам следующие:

  • В Австралии доступна экспресс-доставка. Обычно устройства Snow, доставленные экспресс-доставкой, доставляются в течение дня.
  • В Европейском союзе (ЕС) доступна экспресс-доставка. Обычно устройства Snow, доставленные экспресс-доставкой, доставляются в течение дня. Кроме того, большинство стран ЕС имеют доступ к стандартной доставке, которая обычно занимает менее недели в одну сторону.
  • В Индии устройства Snow доставляются в течение одного-семи дней.
  • В Соединённых Штатах Америки (США) доступна доставка в течение одного и двух дней.
  • В Австралии доступна экспресс-доставка. Обычно устройства, доставленные экспресс-доставкой, доставляются в течение дня.
  • В Европейском союзе (ЕС) доступна экспресс-доставка. Обычно устройства Snow, доставленные экспресс-доставкой, доставляются в течение дня. Кроме того, большинство стран ЕС имеют доступ к стандартной доставке, которая обычно занимает менее недели в одну сторону.
  • В Индии устройства Snow доставляются в течение одного-семи дней.
  • В США доступна доставка в течение одного и двух дней.

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

  • SECOND_DAY
  • NEXT_DAY
  • EXPRESS
  • STANDARD

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

Настройки уведомлений Amazon Simple Notification Service (Amazon SNS) для этого кластера.

SnsTopicARN -> (строка)

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

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

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 (строка)

Идентификатор адреса переадресации для кластера. Это поле не поддерживается в большинстве регионов.

--tax-documents (структура)

Документы, необходимые для уплаты налогов в вашем регионе Amazon Web Services.

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

Документы, необходимые для уплаты налогов в регионе Amazon Web Services в Индии.

GSTIN -> (строка)

Документы, необходимые для уплаты налога на товары и услуги (GST) в регионе Amazon Web Services в Индии.

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

IND={GSTIN=string}

Синтаксис JSON:

{
  "IND": {
    "GSTIN": "string"
  }
}

--remote-management (строка)

Позволяет безопасно управлять и администрировать устройства Snow в кластере удаленно извне вашей внутренней сети. Если установлено значение INSTALLED_AUTOSTART, удаленное управление будет автоматически доступно при поступлении устройства в ваш офис. В противном случае, необходимо использовать Snowball Client для управления устройством.

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

  • INSTALLED_ONLY
  • INSTALLED_AUTOSTART
  • NOT_INSTALLED

--initial-cluster-size (целое число)

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

--force-create-jobs | --no-force-create-jobs (логическое значение)

Принудительное создание кластера, когда пользователь пытается переопределить или недоопределить размер кластера. Кластер переопределён или недоопределён, если начальный размер кластера больше (переопределён) или меньше (недоопределён), чем требуется для удовлетворения требований к ёмкости, указанных с помощью OnDeviceServiceConfiguration.

--long-term-pricing-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--snowball-capacity-preference (строка)

Если ваша задача создается в одном из регионов США, у вас есть возможность указать желаемый размер устройства Snow для этой задачи. Во всех других регионах Snowball поставляются с ёмкостью хранилища 80 ТБ.

Дополнительную информацию см. в разделе «https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html» (Устройства семейства Snow и ёмкость) в Руководстве пользователя Snowcone или «https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html» (Устройства семейства Snow и ёмкость) в Руководстве пользователя Snowcone.

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

  • T50
  • T80
  • T100
  • T42
  • T98
  • T8
  • T14
  • T32
  • NoPreference
  • T240
  • T13

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

Вывод

ClusterId -> (строка)

Автоматически сгенерированный идентификатор кластера.

JobListEntries -> (список)

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

(структура)

Каждый объект JobListEntry содержит состояние задачи, идентификатор задачи и значение, указывающее, является ли задача частью задачи (в случае задачи экспорта).

JobId -> (строка)

Автоматически сгенерированный идентификатор задачи, например JID123e4567-e89b-12d3-a456-426655440000.

JobState -> (строка)

Текущее состояние этой задачи.

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

Значение, указывающее, что эта задача является основной задачей. Основная задача представляет успешный запрос на создание задачи экспорта. Основные задачи не связаны с никакими Snowball. Вместо этого каждая основная задача будет иметь как минимум одну часть задачи, а каждая часть задачи связана с Snowball. Может потребоваться некоторое время, прежде чем будут перечислены части задачи, связанные с конкретной основной задачей, потому что они создаются после создания основной задачи.

JobType -> (строка)

Тип задачи.

SnowballType -> (строка)

Тип устройства, используемого с этой задачей.

CreationDate -> (метка времени)

Дата создания этой задачи.

Description -> (строка)

Необязательное описание этой задачи, например Important Photos 2016-08-11.

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

Spec-Zone.ru

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