Spec-Zone.ru › AWS CLI v2

[ aws . autoscaling ]

describe-launch-configurations

Описание

Получает информацию о конфигурациях запуска в аккаунте и регионе.

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

describe-launch-configurations является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную загрузку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: LaunchConfigurations

Синтаксис

  describe-launch-configurations
[--launch-configuration-names <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--launch-configuration-names (список)

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

Элементы массива: Максимальное количество 50 элементов.

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перекроют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Маркер для указания точки начала постраничной загрузки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

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

Пример 1: Описание указанной конфигурации запуска

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

aws autoscaling describe-launch-configurations \
    --launch-configuration-names my-launch-config

Вывод:

{
    "LaunchConfigurations": [
        {
            "LaunchConfigurationName": "my-launch-config",
            "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
            "ImageId": "ami-0528a5175983e7f28",
            "KeyName": "my-key-pair-uswest2",
            "SecurityGroups": [
                "sg-05eaec502fcdadc2e"
            ],
            "ClassicLinkVPCSecurityGroups": [],
            "UserData": "",
            "InstanceType": "t2.micro",
            "KernelId": "",
            "RamdiskId": "",
            "BlockDeviceMappings": [
                {
                    "DeviceName": "/dev/xvda",
                    "Ebs": {
                        "SnapshotId": "snap-06c1606ba5ca274b1",
                        "VolumeSize": 8,
                        "VolumeType": "gp2",
                        "DeleteOnTermination": true,
                        "Encrypted": false
                    }
                }
            ],
            "InstanceMonitoring": {
                "Enabled": true
            },
            "CreatedTime": "2020-10-28T02:39:22.321Z",
            "EbsOptimized": false,
            "AssociatePublicIpAddress": true,
            "MetadataOptions": {
                "HttpTokens": "required",
                "HttpPutResponseHopLimit": 1,
                "HttpEndpoint": "disabled"
            }
        }
    ]
}

Пример 2: Описание заданного количества конфигураций запуска

Чтобы вернуть определенное количество конфигураций запуска, используйте параметр --max-items.

aws autoscaling describe-launch-configurations \
    --max-items 1

Если вывод включает поле NextToken, существует больше конфигураций запуска. Чтобы получить дополнительные конфигурации запуска, используйте значение этого поля с параметром --starting-token в последующем вызове следующим образом.

aws autoscaling describe-launch-configurations \
    --starting-token Z3M3LMPEXAMPLE

Вывод

LaunchConfigurations -> (список)

Настройки запуска.

(структура)

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

LaunchConfigurationName -> (строка)

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

LaunchConfigurationARN -> (строка)

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

ImageId -> (строка)

Идентификатор Amazon Machine Image (AMI), который используется для запуска экземпляров EC2. Дополнительную информацию см. в разделе «Поиск Linux AMI» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

KeyName -> (строка)

Имя пары ключей.

Дополнительную информацию см. в разделах «Пары ключей Amazon EC2» и «Экземпляры Amazon EC2» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

SecurityGroups -> (список)

Список, содержащий группы безопасности, которые необходимо назначить экземплярам в группе Auto Scaling. Дополнительную информацию см. в разделе «Управление трафиком к вашим ресурсам Amazon Web Services с помощью групп безопасности» в руководстве пользователя Amazon Virtual Private Cloud.

(строка)

ClassicLinkVPCId -> (строка)

Доступно для обратной совместимости.

ClassicLinkVPCSecurityGroups -> (список)

Доступно для обратной совместимости.

(строка)

UserData -> (строка)

Данные пользователя, доступные запущенным экземплярам EC2. Дополнительную информацию см. в разделах «Метаданные экземпляра и данные пользователя (Linux)» и «Метаданные экземпляра и данные пользователя (Windows)». Если вы используете командную строку, для вас выполняется кодирование Base64, и вы можете загрузить текст из файла. В противном случае вы должны предоставить текст в кодировке Base64. Объем данных пользователя ограничен 16 КБ.

InstanceType -> (строка)

Тип экземпляра для экземпляров. Информацию о доступных типах экземпляров см. в разделе «Доступные типы экземпляров» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

KernelId -> (строка)

Идентификатор ядра, связанный с AMI.

RamdiskId -> (строка)

Идентификатор RAM-диска, связанный с AMI.

BlockDeviceMappings -> (список)

Записи отображения блочных устройств, определяющие блочные устройства, которые нужно подключить к экземплярам при запуске. По умолчанию используются блочные устройства, указанные в отображении блочных устройств для AMI. Дополнительную информацию см. в разделе «Отображения блочных устройств» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

(структура)

Описание отображения блочных устройств.

VirtualName -> (строка)

Имя тома хранилища экземпляра (виртуального устройства), которое нужно подключить к экземпляру при запуске. Имя должно иметь вид ephemeral*X*, где X — число, начинающееся с нуля (0), например, ephemeral0 .

DeviceName -> (строка)

Имя устройства, назначенное тому (например, /dev/sdh или xvdh ). Дополнительную информацию см. в разделе «Именование устройств на Linux-экземплярах» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

Примечание

Чтобы определить отображение блочных устройств, установите имя устройства и ровно одну из следующих свойств: Ebs , NoDevice или VirtualName .

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

Информация для подключения тома EBS к экземпляру при запуске.

SnapshotId -> (строка)

Идентификатор снимка тома.

Вы должны указать либо VolumeSize , либо SnapshotId .

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

Размер тома в GiB. Ниже приведены поддерживаемые размеры томов для каждого типа тома:

  • gp2 и gp3 : 1-16 384
  • io1 : 4-16 384
  • st1 и sc1 : 125-16 384
  • standard : 1-1024

Вы должны указать либо SnapshotId , либо VolumeSize . Если вы укажете и SnapshotId , и VolumeSize , размер тома должен быть равен или больше размера снимка.

VolumeType -> (строка)

Тип тома. Дополнительную информацию см. в разделе «Типы томов Amazon EBS» в руководстве пользователя Amazon EBS.

Допустимые значения: standard | io1 | gp2 | st1 | sc1 | gp3

DeleteOnTermination -> (булево)

Указывает, удаляется ли том при завершении работы экземпляра. В Amazon EC2 Auto Scaling значение по умолчанию — true .

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

Количество операций ввода/вывода в секунду (IOPS), которые необходимо предоставить для тома. Для томов gp3 и io1 это представляет собой количество IOPS, предоставляемых для тома. Для томов gp2 это представляет собой базовые показатели производительности тома и скорость, с которой том накапливает кредиты I/O для повышения производительности.

Ниже приведены поддерживаемые значения для каждого типа тома:

  • gp3 : 3000-16000 IOPS
  • io1 : 100-64 000 IOPS

Для томов io1 мы гарантируем 64 000 IOPS только для экземпляров, построенных на платформе Amazon Web Services Nitro System. Другие семейства экземпляров гарантируют производительность до 32 000 IOPS.

Iops поддерживается, когда тип тома — gp3 или io1 и требуется только при типе тома — io1 . (Не используется с standard , gp2 , st1 или sc1 томами.)

Encrypted -> (булево)

Указывает, нужно ли шифровать том. Зашифрованные тома EBS можно подключать только к экземплярам, которые поддерживают шифрование Amazon EBS. Дополнительную информацию см. в разделе «Требования к шифрованию Amazon EBS» в руководстве пользователя Amazon EBS. Если ваш AMI использует зашифрованные тома, вы также можете запустить его только на поддерживаемых типах экземпляров.

Примечание

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

Если вы включили шифрование по умолчанию, создаваемые тома EBS всегда шифруются, либо с помощью управляемого Amazon Web Services KMS-ключа, либо с помощью KMS-ключа, управляемого клиентом, независимо от того, был ли снимок зашифрован.

Дополнительную информацию см. в разделе «Использование ключей Amazon Web Services KMS для шифрования томов Amazon EBS» в руководстве пользователя Amazon EC2 Auto Scaling.

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

Пропускная способность (MiBps) для предоставления тома gp3 .

NoDevice -> (булево)

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

Если NoDevice равно true для системного устройства, экземпляры могут не пройти проверку работоспособности EC2. В этом случае Amazon EC2 Auto Scaling запускает новые экземпляры.

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

Управление тем, запускаются ли экземпляры в этой группе с подробным (true ) или базовым (false ) мониторингом.

Дополнительную информацию см. в разделе «Настройка мониторинга экземпляров Auto Scaling» в руководстве пользователя Amazon EC2 Auto Scaling.

Enabled -> (булево)

Если true , подробный мониторинг включен. В противном случае включен базовый мониторинг.

SpotPrice -> (строка)

Максимальная почасовая стоимость, которая может быть уплачена за любой Spot-экземпляр, запущенный для выполнения запроса. Spot-экземпляры запускаются, когда цена, которую вы указали, превышает текущую цену Spot. Дополнительную информацию см. в разделе «Запрос Spot-экземпляров для отказоустойчивых и гибких приложений» в руководстве пользователя Amazon EC2 Auto Scaling.

IamInstanceProfile -> (строка)

Имя или Amazon Resource Name (ARN) профиля экземпляра, связанного с ролью IAM для экземпляра. Профиль экземпляра содержит роль IAM. Дополнительную информацию см. в разделе «Роль IAM для приложений, выполняемых на экземплярах Amazon EC2» в руководстве пользователя Amazon EC2 Auto Scaling.

CreatedTime -> (метка времени)

Дата и время создания конфигурации запуска.

EbsOptimized -> (булево)

Указывает, оптимизирована ли конфигурация запуска для ввода-вывода EBS (true ) или нет (false ). Дополнительную информацию см. в разделе «Оптимизированные для Amazon EBS экземпляры» в руководстве пользователя Amazon EC2 для Linux-экземпляров.

AssociatePublicIpAddress -> (булево)

Указывает, нужно ли назначить общедоступный IPv4-адрес экземплярам группы. Если экземпляр запускается в подсети по умолчанию, по умолчанию назначается общедоступный IPv4-адрес, если вы не отключили возможность назначения общедоступного IPv4-адреса для подсети. Если экземпляр запускается в подсети, отличной от подсети по умолчанию, по умолчанию общедоступный IPv4-адрес не назначается, если вы не включили возможность назначения общедоступного IPv4-адреса для подсети. Дополнительную информацию см. в разделе «Обеспечение сетевой связи для экземпляров Auto Scaling с использованием Amazon VPC» в руководстве пользователя Amazon EC2 Auto Scaling.

PlacementTenancy -> (строка)

Тип аренды экземпляра, либо default , либо dedicated . Экземпляр с арендой dedicated работает на изолированном оборудовании с арендой для одного арендатора и может запускаться только в VPC.

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

Параметры метаданных экземпляров. Дополнительную информацию см. в разделе «Настройка параметров метаданных экземпляра» в руководстве пользователя Amazon EC2 Auto Scaling.

HttpTokens -> (строка)

Состояние использования токенов для запросов метаданных экземпляра. Если параметр не указан в запросе, состояние по умолчанию — optional .

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

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

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

Желаемый предел переходов HTTP PUT-ответа для запросов метаданных экземпляра. Чем больше число, тем дальше могут распространяться запросы метаданных экземпляра.

По умолчанию: 1

HttpEndpoint -> (строка)

Этот параметр включает или отключает HTTP-точку входа метаданных для ваших экземпляров. Если параметр не указан, состояние по умолчанию — enabled .

Примечание

Если вы укажете значение disabled , вы не сможете получить доступ к метаданным экземпляра.

NextToken -> (строка)

Строка, указывающая, что ответ содержит больше элементов, чем может быть возвращено в одном ответе. Чтобы получить дополнительные элементы, укажите эту строку для значения NextToken при запросе следующего набора элементов. Это значение равно null, когда больше элементов возвращать не нужно.

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

Spec-Zone.ru

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