Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

получить-рецепт-изображения

Описание

Получает рецепт изображения.

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

Синтаксис

  get-image-recipe
--image-recipe-arn <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) рецепта изображения, который требуется получить.

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

Вывод

requestId -> (строка)

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

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

Объект рецепта изображения.

arn -> (строка)

Amazon Resource Name (ARN) рецепта изображения.

type -> (строка)

Определяет тип создаваемого изображением рецепта — AMI или контейнерное изображение.

name -> (строка)

Имя рецепта изображения.

description -> (строка)

Описание рецепта изображения.

platform -> (строка)

Платформа рецепта изображения.

owner -> (строка)

Владелец рецепта изображения.

version -> (строка)

Версия рецепта изображения.

components -> (список)

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

(структура)

Подробные сведения о конфигурации компонента.

componentArn -> (строка)

Amazon Resource Name (ARN) компонента.

parameters -> (список)

Группа параметров настроек, которые Image Builder использует для конфигурации компонента для конкретного рецепта.

(структура)

Содержит пару ключ/значение, которая задает параметр компонента с указанным именем.

name -> (строка)

Имя параметра компонента, который нужно задать.

value -> (список)

Задает значение параметра компонента с указанным именем.

(строка)

parentImage -> (строка)

Базовое изображение для пользовательских настроек, указанных в рецепте изображения. Вы можете указать базовое изображение, используя один из следующих вариантов:

  • ID AMI
  • Amazon Resource Name (ARN) изображения Image Builder
  • Параметр хранилища параметров Amazon Web Services Systems Manager (SSM), префикс ssm:, за которым следует имя параметра или ARN.
  • Идентификатор продукта Amazon Web Services Marketplace

blockDeviceMappings -> (список)

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

(структура)

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

deviceName -> (строка)

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

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

Используется для управления настройками, специфичными для Amazon EBS, для этого сопоставления.

encrypted -> (булево)

Используется для настройки шифрования устройства.

deleteOnTermination -> (булево)

Используется для настройки удаления при завершении работы связанного устройства.

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

Используется для настройки IOPS устройства.

kmsKeyId -> (строка)

Используется для настройки KMS-ключа, используемого при шифровании устройства.

snapshotId -> (строка)

Снимок, определяющий содержимое устройства.

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

Используется для переопределения размера тома устройства.

volumeType -> (строка)

Используется для переопределения типа тома устройства.

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

Только для томов GP3 – Пропускная способность в MiB/с, поддерживаемая томом.

virtualName -> (строка)

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

noDevice -> (строка)

Используется для удаления сопоставления из базового изображения.

dateCreated -> (строка)

Дата создания рецепта изображения.

tags -> (словарь)

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

key -> (строка)

value -> (строка)

workingDirectory -> (строка)

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

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

Прежде чем создать новую AMI, Image Builder запускает временные экземпляры Amazon EC2 для сборки и тестирования вашей конфигурации изображения. Настройка экземпляра добавляет слой управления над этими экземплярами. Вы можете определить настройки и добавить скрипты для выполнения при запуске экземпляра из вашей AMI.

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

Содержит настройки агента Systems Manager на вашем экземпляре сборки.

uninstallAfterBuild -> (булево)

Управляет тем, удаляется ли агент Systems Manager из вашего конечного изображения сборки до создания новой AMI. Если это значение установлено в true, агент удаляется из конечного изображения. Если оно установлено в false, агент остается, чтобы он был включен в новую AMI. Значение по умолчанию — false.

userDataOverride -> (строка)

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

Параметр userDataOverride заменяет любые команды, которые Image Builder мог добавить, чтобы гарантировать установку Systems Manager на ваш экземпляр Linux-сборки. Если вы переопределяете пользовательские данные, убедитесь, что вы добавили команды для установки Systems Manager, если он не предварительно установлен в вашем базовом изображении.

Примечание

Пользовательские данные всегда закодированы в base 64. Например, следующие команды закодированы как IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$ :

#!/bin/bash

mkdir -p /var/bb/

touch /var

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

Spec-Zone.ru

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