Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

создание-изображения

Описание

Создаёт новое изображение. Этот запрос создаст новое изображение вместе со всеми настроенными выходными ресурсами, определёнными в конфигурации дистрибуции. Вы должны указать ровно один рецепт для своего изображения, используя либо ContainerRecipeArn, либо ImageRecipeArn.

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

Синтаксис

  create-image
[--image-recipe-arn <value>]
[--container-recipe-arn <value>]
[--distribution-configuration-arn <value>]
--infrastructure-configuration-arn <value>
[--image-tests-configuration <value>]
[--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled]
[--tags <value>]
[--client-token <value>]
[--image-scanning-configuration <value>]
[--workflows <value>]
[--execution-role <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]

Параметры

--image-recipe-arn (строка)

Amazon Resource Name (ARN) рецепта изображения, определяющего, как настраиваются, тестируются и оцениваются изображения.

--container-recipe-arn (строка)

Amazon Resource Name (ARN) рецепта контейнера, определяющего, как настраиваются и тестируются контейнеры.

--distribution-configuration-arn (строка)

Amazon Resource Name (ARN) конфигурации дистрибуции, определяющей и настраивающей выходные данные вашей конвейерной линии.

--infrastructure-configuration-arn (строка)

Amazon Resource Name (ARN) конфигурации инфраструктуры, определяющей среду, в которой будет создано и протестировано ваше изображение.

--image-tests-configuration (структура)

Конфигурация тестов изображения.

imageTestsEnabled -> (булево)

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

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

Максимальное время в минутах, в течение которого разрешено выполнение тестов.

Примечание

Свойство таймаута в настоящее время неактивно. Это значение игнорируется.

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

imageTestsEnabled=boolean,timeoutMinutes=integer

Синтаксис JSON:

{
  "imageTestsEnabled": true|false,
  "timeoutMinutes": integer
}

--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled (булево)

Собраны дополнительные сведения об создаваемом изображении, включая версию операционной системы (ОС) и список пакетов. Эта информация используется для повышения общего удобства использования EC2 Image Builder.

--tags (карта)

Теги изображения.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Дополнительную информацию см. в разделе Обеспечение идемпотентности в Справочнике по API Amazon EC2 .

--image-scanning-configuration (структура)

Содержит настройки для сканирования уязвимостей.

imageScanningEnabled -> (булево)

Параметр, указывающий, сохраняет ли Image Builder моментальный снимок результатов сканирования уязвимостей, которые Amazon Inspector выполняет на экземпляре создания при создании нового изображения.

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

Содержит настройки Amazon ECR для сканирования уязвимостей.

repositoryName -> (строка)

Имя репозитория контейнеров, который Amazon Inspector сканирует для выявления уязвимостей в ваших контейнерных образах. Имя включает путь к расположению репозитория. Если вы не предоставите эту информацию, Image Builder создаст репозиторий в вашей учетной записи под именем image-builder-image-scanning-repository для сканирования уязвимостей ваших выходных контейнерных изображений.

containerTags -> (список)

Теги, которые Image Builder применяет к выходному контейнерному образу, который сканирует Amazon Inspector. Теги могут помочь вам идентифицировать и управлять вашими отсканированными изображениями.

(строка)

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

imageScanningEnabled=boolean,ecrConfiguration={repositoryName=string,containerTags=[string,string]}

Синтаксис JSON:

{
  "imageScanningEnabled": true|false,
  "ecrConfiguration": {
    "repositoryName": "string",
    "containerTags": ["string", ...]
  }
}

--workflows (список)

Содержит массив объектов конфигурации рабочего процесса.

(структура)

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

workflowArn -> (строка)

Amazon Resource Name (ARN) ресурса рабочего процесса.

parameters -> (список)

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

(структура)

Содержит пару «ключ-значение», которая устанавливает указанный параметр рабочего процесса.

name -> (строка)

Имя параметра рабочего процесса, которое нужно установить.

value -> (список)

Устанавливает значение указанного параметра рабочего процесса.

(строка)

parallelGroup -> (строка)

Рабочие процессы тестирования определяются в именованных группах выполнения, называемых параллельными группами. Параллельная группа — это именованная группа, содержащая этот рабочий процесс тестирования. Рабочие процессы тестирования в пределах параллельной группы могут выполняться одновременно. Image Builder запускает до пяти рабочих процессов тестирования в группе одновременно и запускает дополнительные рабочие процессы по мере завершения других, пока все рабочие процессы в группе не завершатся. Это поле применимо только для рабочих процессов тестирования.

onFailure -> (строка)

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

Синтаксис JSON:

[
  {
    "workflowArn": "string",
    "parameters": [
      {
        "name": "string",
        "value": ["string", ...]
      }
      ...
    ],
    "parallelGroup": "string",
    "onFailure": "CONTINUE"|"ABORT"
  }
  ...
]

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

Имя или Amazon Resource Name (ARN) для роли IAM, которую вы создаёте, предоставляя Image Builder доступ для выполнения действий с рабочим процессом.

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

Для создания изображения

Следующий create-image пример создаёт изображение.

aws imagebuilder create-image \
    --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}

Дополнительную информацию см. в разделе Настройка и управление конвейером изображений EC2 Image Builder с помощью AWS CLI в руководстве пользователя EC2 Image Builder.

Вывод

requestId -> (строка)

Идентификатор запроса, уникально идентифицирующий этот запрос.

clientToken -> (строка)

Маркер клиента, уникально идентифицирующий запрос.

imageBuildVersionArn -> (строка)

Amazon Resource Name (ARN) изображения, созданного запросом.

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

Spec-Zone.ru

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