Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

получить-конфигурацию-инфраструктуры

Описание

Получает конфигурацию инфраструктуры.

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

Синтаксис

  get-infrastructure-configuration
--infrastructure-configuration-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]

Параметры

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

Примеры

Примечание

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

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

Получение подробной информации о конфигурации инфраструктуры

Следующий get-infrastructure-configuration пример показывает детали конфигурации инфраструктуры, указав ее ARN.

aws imagebuilder get-infrastructure-configuration \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "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": "EC2InstanceProfileForImageBuilder",
        "securityGroupIds": [
            "sg-a48c95ef"
        ],
        "subnetId": "subnet-a48c95ef",
        "logging": {
            "s3Logs": {
                "s3BucketName": "bucket-name",
                "s3KeyPrefix": "bucket-path"
            }
        },
        "keyPair": "Name",
        "terminateInstanceOnFailure": false,
        "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
        "dateCreated": "2020-02-19T19:11:51.858Z",
        "tags": {}
    }
}

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

Вывод

requestId -> (строка)

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

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

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

arn -> (строка)

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

name -> (строка)

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

description -> (строка)

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

instanceTypes -> (список)

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

(строка)

instanceProfileName -> (строка)

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

securityGroupIds -> (список)

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

(строка)

subnetId -> (строка)

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

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

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

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

Конфигурация регистрации Amazon S3.

s3BucketName -> (строка)

Название ведра Amazon 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, то вы можете указать один целевой параметр размещения – либо ID хоста, либо ARN группы ресурсов хоста. Если автоматическое размещение включено для вашего хоста, и вы не указываете какой-либо целевой параметр размещения, Amazon EC2 попытается найти доступный хост для ваших экземпляров сборки и тестирования.

hostId -> (строка)

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

hostResourceGroupArn -> (строка)

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

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

Spec-Zone.ru

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