Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

get-container-recipe

Описание

Возвращает рецепт контейнера.

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

Синтаксис

  get-container-recipe
--container-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]

Параметры

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

Вывод

requestId -> (строка)

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

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

Объект рецепта контейнера, который возвращается.

arn -> (строка)

Amazon Resource Name (ARN) рецепта контейнера.

Примечание

Семантическая версия включена в каждый Amazon Resource Name (ARN) объекта на уровне, применимом к этому объекту следующим образом:

  • ARN без версии и ARN по имени не включают конкретные значения ни в одном из узлов. Узлы либо полностью опускаются, либо указываются как подстановки, например: x.x.x.
  • ARN версии содержат только первые три узла: <major>.<minor>.<patch>
  • ARN версии сборки содержат все четыре узла и указывают на конкретную сборку для конкретной версии объекта.

containerType -> (строка)

Указывает тип контейнера, такой как Docker.

name -> (строка)

Название рецепта контейнера.

description -> (строка)

Описание рецепта контейнера.

platform -> (строка)

Системная платформа для контейнера, такая как Windows или Linux.

owner -> (строка)

Владелец рецепта контейнера.

version -> (строка)

Семантическая версия рецепта контейнера.

Примечание

Семантическая версия имеет четыре узла: <major>.<minor>.<patch>/<build>. Вы можете назначить значения для первых трех и можете фильтровать по всем из них.

Назначение: Для первых трех узлов вы можете назначить любое положительное целое значение, включая ноль, с верхним пределом 2^30-1, или 1073741823 для каждого узла. Image Builder автоматически присваивает номер сборки четвертому узлу.

Шаблоны: Вы можете использовать любой числовой шаблон, который соответствует требованиям к назначению узлов, которые вы можете назначить. Например, вы можете выбрать шаблон версии программного обеспечения, такой как 1.0.0, или дату, такую как 2021.01.01.

Фильтрация: Благодаря семантическому версионированию у вас есть гибкость в использовании подстановочных знаков (x) для указания последних версий или узлов при выборе базового образа или компонентов для вашего рецепта. Когда вы используете подстановку в любом узле, все узлы справа от первого подстановочного знака также должны быть подстановками.

components -> (список)

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

(структура)

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

componentArn -> (строка)

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

parameters -> (список)

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

(структура)

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

name -> (строка)

Имя параметра компонента, который нужно установить.

value -> (список)

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

(строка)

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

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

image -> (строка)

Базовый образ для экземпляра сборки и тестирования контейнера. Это может содержать идентификатор AMI или может указывать параметр Amazon Web Services Systems Manager (SSM) Parameter Store, префикс которого ssm:, за которым следует имя параметра или ARN.

Если не указано, Image Builder использует подходящий оптимизированный под ECS AMI в качестве базового образа.

blockDeviceMappings -> (список)

Определяет устройства блочного устройства для подключения для создания экземпляра из этого Image Builder AMI.

(структура)

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

deviceName -> (строка)

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

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

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

encrypted -> (булево)

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

deleteOnTermination -> (булево)

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

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

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

kmsKeyId -> (строка)

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

snapshotId -> (строка)

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

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

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

volumeType -> (строка)

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

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

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

virtualName -> (строка)

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

noDevice -> (строка)

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

dockerfileTemplateData -> (строка)

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

kmsKeyId -> (строка)

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

encrypted -> (булево)

Флаг, указывающий, зашифрован ли целевой контейнер.

parentImage -> (строка)

Базовый образ для настроек, указанных в рецепте контейнера. Это может содержать ARN ресурса изображения Image Builder или URI изображения контейнера, например amazonlinux:latest.

dateCreated -> (строка)

Дата создания этого рецепта контейнера.

tags -> (карта)

Теги, прикрепленные к рецепту контейнера.

key -> (строка)

value -> (строка)

workingDirectory -> (строка)

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

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

Репозиторий назначения для изображения контейнера.

service -> (строка)

Указывает сервис, в котором было зарегистрировано это изображение.

repositoryName -> (строка)

Имя репозитория контейнеров, где хранится выходное изображение контейнера. Это имя предваряется расположением репозитория. Например, <repository location url>/repository_name.

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

Spec-Zone.ru

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