Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

get-image

Описание

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

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

Синтаксис

  get-image
--image-build-version-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-build-version-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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для получения подробностей об изображении

В следующем get-image примере перечисляются данные об изображении путем указания его ARN.

aws imagebuilder get-image \
    --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "image": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1",
        "name": "MyBasicRecipe",
        "version": "2019.12.03/1",
        "platform": "Windows",
        "state": {
            "status": "BUILDING"
        },
        "imageRecipe": {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "description": "This example image recipe creates a Windows 2016 image.",
            "platform": "Windows",
            "version": "2019.12.03",
            "components": [
                {
                    "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
                },
                {
                    "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
                }
            ],
            "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.12.17/1",
            "dateCreated": "2020-02-14T19:46:16.904Z",
            "tags": {}
        },
        "infrastructureConfiguration": {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
            "name": "MyExampleInfrastructure",
            "description": "An example that will retain instances of failed builds",
            "instanceTypes": [
                "m5.large",
                "m5.xlarge"
            ],
            "instanceProfileName": "EC2InstanceProfileForImageFactory",
            "securityGroupIds": [
                "sg-a1b2c3d4"
            ],
            "subnetId": "subnet-a1b2c3d4",
            "logging": {
                "s3Logs": {
                    "s3BucketName": "bucket-name",
                    "s3KeyPrefix": "bucket-path"
                }
            },
            "keyPair": "Sam",
            "terminateInstanceOnFailure": false,
            "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
            "dateCreated": "2020-02-14T21:21:05.098Z",
            "tags": {}
        },
        "imageTestsConfiguration": {
            "imageTestsEnabled": true,
            "timeoutMinutes": 720
        },
        "dateCreated": "2020-02-14T23:14:13.597Z",
        "outputResources": {
            "amis": []
        },
        "tags": {}
    }
}

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

Вывод

requestId -> (строка)

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

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

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

arn -> (строка)

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

Примечание

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

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

type -> (строка)

Указывает, создает ли это изображение AMI или контейнерное изображение.

name -> (строка)

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

version -> (строка)

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

Примечание

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

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

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

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

platform -> (строка)

Платформа операционной системы изображения, например Linux или Windows.

enhancedImageMetadataEnabled -> (булево)

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

osVersion -> (строка)

Версия операционной системы для экземпляров, запущенных из этого изображения. Например, Amazon Linux 2, Ubuntu 18 или Microsoft Windows Server 2019.

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

Состояние изображения.

status -> (строка)

Статус изображения.

reason -> (строка)

Причина статуса изображения.

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

Для изображений, которые распределяют AMI, это рецепт изображения, который Image Builder использовал для создания изображения. Для контейнерных изображений это пусто.

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 -> (строка)

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

  • Идентификатор 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 – Пропускная способность в МБ/с, которую поддерживает том.

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

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

Для контейнерных изображений это рецепт контейнера, который использовал Image Builder для создания изображения. Для изображений, которые распространяют AMI, это пусто.

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) хранилища параметров, начинающийся с ssm:, за которым следует имя параметра или ARN.

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

blockDeviceMappings -> (список)

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

(структура)

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

deviceName -> (строка)

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

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

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

encrypted -> (булево)

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

deleteOnTermination -> (булево)

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

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

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

kmsKeyId -> (строка)

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

snapshotId -> (строка)

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

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

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

volumeType -> (строка)

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

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

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

virtualName -> (строка)

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

noDevice -> (строка)

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

dockerfileTemplateData -> (строка)

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

kmsKeyId -> (строка)

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

encrypted -> (булево)

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

parentImage -> (строка)

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

dateCreated -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

workingDirectory -> (строка)

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

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

Целевой репозиторий для контейнерного изображения.

service -> (строка)

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

repositoryName -> (строка)

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

sourcePipelineName -> (строка)

Имя канала изображения, которое создало это изображение.

sourcePipelineArn -> (строка)

Amazon Resource Name (ARN) канала изображения, которое создало это изображение.

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

Инфраструктура, используемая Image Builder для создания этого образа.

arn -> (строка)

Amazon Resource Name (ARN) конфигурации инфраструктуры.

name -> (строка)

Имя конфигурации инфраструктуры.

description -> (строка)

Описание конфигурации инфраструктуры.

instanceTypes -> (список)

Типы экземпляров конфигурации инфраструктуры.

(строка)

instanceProfileName -> (строка)

Профиль экземпляра конфигурации инфраструктуры.

securityGroupIds -> (список)

Идентификаторы групп безопасности конфигурации инфраструктуры.

(строка)

subnetId -> (строка)

Идентификатор подсети конфигурации инфраструктуры.

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

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

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

Конфигурация ведения журнала Amazon S3.

s3BucketName -> (строка)

Ведро S3, в котором будут храниться журналы.

s3KeyPrefix -> (строка)

Путь Amazon S3 к каталогу, где хранятся журналы.

keyPair -> (строка)

Ключевая пара Amazon EC2 конфигурации инфраструктуры.

terminateInstanceOnFailure -> (булево)

Конфигурация завершения экземпляра при ошибке конфигурации инфраструктуры.

snsTopicArn -> (строка)

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

Примечание

EC2 Image Builder не может отправлять уведомления в темы SNS, которые шифруются с помощью ключей из других учетных записей. Ключ, используемый для шифрования темы SNS, должен находиться в учетной записи, под которой выполняется служба Image Builder.

dateCreated -> (строка)

Дата создания конфигурации инфраструктуры.

dateUpdated -> (строка)

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

resourceTags -> (карта)

Теги, прикрепленные к ресурсу, созданному Image Builder.

key -> (строка)

value -> (строка)

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

Параметры опций метаданных экземпляра для конфигурации инфраструктуры.

httpTokens -> (строка)

Указывает, требуется ли подписанный заголовок токена для запросов получения метаданных экземпляра. Значения влияют на ответ следующим образом:

  • required – При получении учетных данных роли IAM всегда возвращаются учетные данные версии 2.0.
  • optional – Вы можете включить подписанный заголовок токена в свой запрос для получения метаданных экземпляра или оставить его без включения. Если вы включите его, для роли IAM будут возвращены учетные данные версии 2.0. В противном случае возвращаются учетные данные версии 1.0.

Значение по умолчанию — optional.

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

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

tags -> (карта)

Теги конфигурации инфраструктуры.

key -> (строка)

value -> (строка)

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

Настройки размещения экземпляра, определяющие, где будут выполняться экземпляры, запущенные из вашего образа.

availabilityZone -> (строка)

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

tenancy -> (строка)

Тип аренды экземпляра. Экземпляр с типом аренды dedicated работает на оборудовании с одноарендной моделью. Экземпляр с типом аренды host работает на выделенном хосте.

Если тип аренды установлен на host, можно дополнительно указать одну цель размещения — либо идентификатор хоста, либо ARN группы ресурсов хоста. Если автоматическое размещение включено для вашего хоста, и вы не укажете никакую цель размещения, Amazon EC2 попытается найти доступный хост для ваших экземпляров сборки и тестирования.

hostId -> (строка)

Идентификатор выделенного хоста, на котором работают экземпляры сборки и тестирования. Это применимо только если tenancy равен host. Если вы указываете идентификатор хоста, вы не должны указывать ARN группы ресурсов. Если вы указываете оба значения, Image Builder возвращает ошибку.

hostResourceGroupArn -> (строка)

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

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

Конфигурация распределения, которую Image Builder использовал для создания этого образа.

arn -> (строка)

Amazon Resource Name (ARN) конфигурации распределения.

name -> (строка)

Имя конфигурации распределения.

description -> (строка)

Описание конфигурации распределения.

distributions -> (список)

Объекты распределения, применяющие региональные настройки для развертывания образа в целевых регионах.

(структура)

Определяет настройки для конкретного региона.

region -> (строка)

Целевой регион.

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

Настройки AMI; например, разрешения на запуск или метки AMI.

name -> (строка)

Имя выходного AMI.

description -> (строка)

Описание конфигурации распределения AMI. Минимальная и максимальная длина в символах.

targetAccountIds -> (список)

Идентификатор учетной записи, в которую вы хотите распределить образ.

(строка)

amiTags -> (массив)

Метки, которые нужно применить к AMI, распределённым в этом регионе.

key -> (строка)

value -> (строка)

kmsKeyId -> (строка)

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

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

Разрешения на запуск позволяют настроить, какие учетные записи Amazon Web Services могут использовать AMI для запуска экземпляров.

userIds -> (список)

Идентификатор учетной записи Amazon Web Services.

(строка)

userGroups -> (список)

Имя группы.

(строка)

organizationArns -> (список)

ARN для организации Amazon Web Services, с которой вы хотите поделиться своим AMI. Для получения дополнительной информации см. Что такое Организации? .

(строка)

organizationalUnitArns -> (список)

ARN для организационной единицы (OU) Организации, с которой вы хотите поделиться своим AMI. Дополнительную информацию о ключевых понятиях для Организации см. в Организации: терминология и концепции .

(строка)

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

Настройки распределения контейнеров для шифрования, лицензирования и совместного использования в определённом регионе.

description -> (строка)

Описание конфигурации распределения контейнеров.

containerTags -> (список)

Метки, прикреплённые к конфигурации распределения контейнеров.

(строка)

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

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

service -> (строка)

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

repositoryName -> (строка)

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

licenseConfigurationArns -> (список)

Конфигурация License Manager для ассоциации с AMI в указанном регионе.

(строка)

launchTemplateConfigurations -> (список)

Группа настроек launchTemplateConfiguration, применяемых к распределению образа для указанных учетных записей.

(структура)

Идентифицирует запуск шаблона Amazon EC2 для конкретной учетной записи.

launchTemplateId -> (строка)

Идентифицирует запуск шаблона Amazon EC2.

accountId -> (строка)

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

setDefaultVersion -> (булево)

Устанавливает указанный шаблон запуска Amazon EC2 в качестве стандартного шаблона запуска для указанной учетной записи.

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

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

roleName -> (строка)

Имя роли, предоставляющей разрешение на импорт/экспорт виртуальных машин для экспорта образов в ваш ведро S3.

diskImageFormat -> (строка)

Экспортируйте обновлённый образ в один из следующих поддерживаемых форматов образов дисков:

  • Virtual Hard Disk (VHD) – Совместимо с продуктами виртуализации Citrix Xen и Microsoft Hyper-V.
  • Stream-optimized ESX Virtual Machine Disk (VMDK) – Совместимо с VMware ESX и VMware vSphere версий 4, 5 и 6.
  • Raw – Формат Raw.

s3Bucket -> (строка)

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

s3Prefix -> (строка)

Путь Amazon S3 для ведра, в котором хранятся выходные образы дисков для вашей виртуальной машины.

fastLaunchConfigurations -> (список)

Конфигурации Windows для более быстрого запуска для распределения AMI.

(структура)

Определение и настройка более быстрого запуска для выходных AMI Windows.

enabled -> (булево)

Булево значение, представляющее текущее состояние более быстрого запуска для AMI Windows. Установите значение true, чтобы начать использовать быстрый запуск для Windows, или false, чтобы прекратить его использование.

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

Настройки конфигурации для управления количеством снимков, созданных из предварительно подготовленных экземпляров для AMI Windows при включенном быстром запуске.

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

Количество предварительно подготовленных снимков, которые нужно сохранить для AMI Windows с включенным быстрым запуском.

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

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

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

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

launchTemplateId -> (строка)

Идентификатор шаблона запуска для более быстрого запуска AMI Windows.

launchTemplateName -> (строка)

Имя шаблона запуска для более быстрого запуска AMI Windows.

launchTemplateVersion -> (строка)

Версия шаблона запуска для более быстрого запуска AMI Windows.

accountId -> (строка)

Идентификатор учётной записи владельца AMI Windows с включенным быстрым запуском.

ssmParameterConfigurations -> (список)

Содержит настройки для обновления параметров Amazon Web Services Systems Manager (SSM) Parameter Store с выходными ID AMI из сборки по целевому региону.

(структура)

Настройка для одного параметра в Amazon Web Services Systems Manager (SSM) Parameter Store в заданном регионе.

amiAccountId -> (строка)

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

parameterName -> (строка)

Это имя параметра в целевом регионе или учётной записи. Распределение образа создаёт параметр, если он ещё не существует. В противном случае оно обновляет параметр.

dataType -> (строка)

Тип данных определяет тип значения, содержащегося в параметре. Рекомендуется использовать тип данных aws:ec2:image.

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

Максимальная продолжительность в минутах для этой конфигурации распределения.

dateCreated -> (строка)

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

dateUpdated -> (строка)

Дата последнего обновления этой конфигурации распределения.

tags -> (массив)

Метки конфигурации распределения.

key -> (строка)

value -> (строка)

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

Тесты образа, которые выполнялись при создании этого образа Image Builder.

imageTestsEnabled -> (булево)

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

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

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

Примечание

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

dateCreated -> (строка)

Дата, когда Image Builder создал этот образ.

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

Выходные ресурсы, созданные Image Builder для этого образа.

amis -> (список)

Amazon EC2 AMI, созданные этим образом.

(структура)

Подробности Amazon EC2 AMI.

region -> (строка)

Регион Amazon Web Services Amazon EC2 AMI.

image -> (строка)

Идентификатор AMI Amazon EC2 AMI.

name -> (строка)

Имя Amazon EC2 AMI.

description -> (строка)

Описание Amazon EC2 AMI. Минимальная и максимальная длина в символах.

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

Статус образа и причина этого статуса.

status -> (строка)

Статус образа.

reason -> (строка)

Причина статуса образа.

accountId -> (строка)

Идентификатор учётной записи владельца AMI.

containers -> (список)

Образы контейнеров, сгенерированные и сохранённые в выходном репозитории.

(структура)

Контейнер encapsulates среду выполнения приложения.

region -> (строка)

Контейнеры и образы контейнеров зависят от региона. Это контекст региона для контейнера.

imageUris -> (список)

Список URIs для контейнеров, созданных в контекстном регионе.

(строка)

tags -> (массив)

Метки, применяемые к этому образу.

key -> (строка)

value -> (строка)

buildType -> (строка)

Указывает тип сборки, который создал этот образ. Сборка может быть инициирована следующими способами:

  • USER_INITIATED – Запрос на ручную сборку.
  • SCHEDULED – Сборка, инициированная выражением cron в конвейере Image Builder или из EventBridge.
  • IMPORT – Импорт виртуальной машины создал образ, который используется в качестве базового образа для рецепта.
  • IMPORT_ISO – Импорт образа ISO создал образ.

imageSource -> (строка)

Источник базового образа, который Image Builder использовал для создания этого образа.

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

Содержит информацию о текущем состоянии сканирования для этого образа.

status -> (строка)

Текущее состояние сканирования уязвимостей для образа.

reason -> (строка)

Причина статуса сканирования образа.

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

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

imageScanningEnabled -> (boolean)

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

ecrConfiguration -> (structure)

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

repositoryName -> (string)

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

containerTags -> (list)

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

(string)

deprecationTime -> (timestamp)

Время, когда происходит устаревание ресурса образа. Это может быть прошедшая или будущая дата.

lifecycleExecutionId -> (string)

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

executionRole -> (string)

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

workflows -> (list)

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

(structure)

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

workflowArn -> (string)

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

parameters -> (list)

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

(structure)

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

name -> (string)

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

value -> (list)

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

(string)

parallelGroup -> (string)

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

onFailure -> (string)

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

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

Spec-Zone.ru

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