Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

import-component

Описание

Импортирует компонент и преобразует его данные в документ компонента.

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

Синтаксис

  import-component
--name <value>
--semantic-version <value>
[--description <value>]
[--change-description <value>]
--type <value>
--format <value>
--platform <value>
[--data <value>]
[--uri <value>]
[--kms-key-id <value>]
[--tags <value>]
[--client-token <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 (строка)

Название компонента.

--semantic-version (строка)

Семантическая версия компонента. Эта версия следует синтаксису семантической версии.

Примечание

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

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

--description (строка)

Описание компонента. Описывает содержимое компонента.

--change-description (строка)

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

--type (строка)

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

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

  • BUILD
  • TEST

--format (строка)

Формат ресурса, который вы хотите импортировать как компонент.

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

  • SHELL

--platform (строка)

Платформа компонента.

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

  • Windows
  • Linux
  • macOS

--data (строка)

Данные компонента. Используется для указания данных в строке. Можно использовать либо data, либо uri для указания данных внутри компонента.

--uri (строка)

URI компонента. Должен быть URL Amazon S3, и у запрашивающего должна быть разрешена возможность доступа к ведру Amazon S3. Если вы используете Amazon S3, вы можете указать содержимое компонента до вашего квотного лимита сервиса. Можно использовать либо data, либо uri для указания данных внутри компонента.

--kms-key-id (строка)

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

--tags (массив)

Теги компонента.

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Дополнительную информацию см. в разделе Обеспечение идемпотентности в Справочнике по API Amazon EC2.

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

Для импорта компонента

Следующий import-component пример импортирует существующий скрипт с помощью файла JSON.

aws imagebuilder import-component \
    --cli-input-json file://import-component.json

Содержимое import-component.json:

{
    "name": "MyImportedComponent",
    "semanticVersion": "1.0.0",
    "description": "An example of how to import a component",
    "changeDescription": "First commit message.",
    "format": "SHELL",
    "platform": "Windows",
    "type": "BUILD",
    "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"
}

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
}

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

Вывод

requestId -> (строка)

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

clientToken -> (строка)

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

componentBuildVersionArn -> (строка)

Amazon Resource Name (ARN) импортированного компонента.

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

Spec-Zone.ru

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