Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

create-image-pipeline

Описание

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

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

Синтаксис

  create-image-pipeline
--name <value>
[--description <value>]
[--image-recipe-arn <value>]
[--container-recipe-arn <value>]
--infrastructure-configuration-arn <value>
[--distribution-configuration-arn <value>]
[--image-tests-configuration <value>]
[--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled]
[--schedule <value>]
[--status <value>]
[--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]

Параметры

--name (строка)

Имя конвейерной линии изображений.

--description (строка)

Описание конвейерной линии изображений.

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

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

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

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

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

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

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

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

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

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

imageTestsEnabled -> (булево)

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

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

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

Примечание

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

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

imageTestsEnabled=boolean,timeoutMinutes=integer

Синтаксис JSON:

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

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

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

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

Расписание конвейерной линии изображений.

scheduleExpression -> (строка)

Выражение cron определяет, как часто EC2 Image Builder оценивает ваш pipelineExecutionStartCondition.

Дополнительную информацию о формате выражения cron в Image Builder см. в статье Использование выражений cron в EC2 Image Builder.

timezone -> (строка)

Временная зона, применяемая к выражению планирования. Например, «Etc/UTC», «America/Los_Angeles» в формате временной зоны IANA. Если не указано, по умолчанию используется UTC.

pipelineExecutionStartCondition -> (строка)

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

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

Примечание

Для семантического синтаксиса версий см. CreateComponent.
  • EXPRESSION_MATCH_ONLY – Это условие строит новое изображение каждый раз, когда выражение CRON соответствует текущему времени.

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

scheduleExpression=string,timezone=string,pipelineExecutionStartCondition=string

Синтаксис JSON:

{
  "scheduleExpression": "string",
  "timezone": "string",
  "pipelineExecutionStartCondition": "EXPRESSION_MATCH_ONLY"|"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
}

--status (строка)

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

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

  • DISABLED
  • ENABLED

--tags (массив)

Теги конвейерной линии изображений.

key -> (строка)

value -> (строка)

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

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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

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

Следующий create-image-pipeline пример создаёт конвейер создания изображений с использованием JSON-файла.

aws imagebuilder create-image-pipeline \
    --cli-input-json file://create-image-pipeline.json

Содержимое create-image-pipeline.json:

{
    "name": "MyWindows2016Pipeline",
    "description": "Builds Windows 2016 Images",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
    "imageTestsConfiguration": {
        "imageTestsEnabled": true,
        "timeoutMinutes": 60
    },
    "schedule": {
        "scheduleExpression": "cron(0 0 * * SUN)",
        "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    },
    "status": "ENABLED"
}

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}

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

Вывод

requestId -> (строка)

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

clientToken -> (строка)

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

imagePipelineArn -> (строка)

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

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

Spec-Zone.ru

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