Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

update-image-pipeline

Описание

Обновляет конвейер создания изображений. Конвейеры создания изображений позволяют автоматизировать создание и распределение изображений. Вы должны указать ровно один рецепт для своего изображения, используя либо containerRecipeArn, либо imageRecipeArn.

Примечание

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

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

Синтаксис

  update-image-pipeline
--image-pipeline-arn <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>]
[--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-pipeline-arn (строка)

Amazon Resource Name (ARN) конвейера создания изображений, который вы хотите обновить.

--description (строка)

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

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

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

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

Amazon Resource Name (ARN) конвейера контейнеров для обновления.

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

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

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

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

--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. Включено по умолчанию.

--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 создаёт новое изображение только тогда, когда существуют новые версии базового изображения или компонентов в вашем рецепте, соответствующие фильтру.

Примечание

Для синтаксиса семантических версий см. Создать компонент.
  • 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

--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
  • text
  • таблица
  • 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 (булево)

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

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

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

Примеры

Примечание

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

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

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

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

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

Содержание update-image-pipeline.json:

{
    "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
    "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": 120
    },
    "schedule": {
        "scheduleExpression": "cron(0 0 * * MON)",
        "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    },
    "status": "DISABLED"
}

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

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

Вывод

requestId -> (строка)

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

clientToken -> (строка)

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

imagePipelineArn -> (строка)

Идентификатор ресурса Amazon (ARN) конвейера изображений, обновленного этим запросом.

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

Spec-Zone.ru

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