Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-instance-attribute

Описание

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

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

Синтаксис

  describe-instance-attribute
[--dry-run | --no-dry-run]
--instance-id <value>
--attribute <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, есть ли у вас необходимые разрешения для операции, не отправляя фактический запрос, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке будет DryRunOperation . В противном случае он будет UnauthorizedOperation .

--instance-id (string)

Идентификатор экземпляра.

--attribute (string)

Свойство экземпляра.

Обратите внимание, что свойство enaSupport не поддерживается.

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

  • instanceType
  • kernel
  • ramdisk
  • userData
  • disableApiTermination
  • instanceInitiatedShutdownBehavior
  • rootDeviceName
  • blockDeviceMapping
  • productCodes
  • sourceDestCheck
  • groupSet
  • ebsOptimized
  • sriovNetSupport
  • enaSupport
  • enclaveOptions
  • disableApiStop

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

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если не указано значение или значение input, выводится пример JSON-ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет выведен пример YAML-ввода, который может быть использован с --cli-input-yaml. Если указано значение output, проверяет входные данные команды и возвращает JSON-пример выходных данных для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включает отладку логов.

--endpoint-url (string)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

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

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использование определенного профиля из файла с данными.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отображает версию этого инструмента.

--color (string)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Данные учетных данных не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл CA-сертификатов для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

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

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

Команда:

aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute instanceType

Вывод:

{
    "InstanceId": "i-1234567890abcdef0"
    "InstanceType": {
        "Value": "t1.micro"
    }
}

Для описания атрибута disableApiTermination

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

Команда:

aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute disableApiTermination

Вывод:

{
"InstanceId": "i-1234567890abcdef0"
    "DisableApiTermination": {
        "Value": "false"
    }
}

Для описания отображения блочных устройств для экземпляра

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

Команда:

aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute blockDeviceMapping

Вывод:

{
    "InstanceId": "i-1234567890abcdef0"
    "BlockDeviceMappings": [
        {
            "DeviceName": "/dev/sda1",
            "Ebs": {
                "Status": "attached",
                "DeleteOnTermination": true,
                "VolumeId": "vol-049df61146c4d7901",
                "AttachTime": "2013-05-17T22:42:34.000Z"
            }
        },
        {
            "DeviceName": "/dev/sdf",
            "Ebs": {
                "Status": "attached",
                "DeleteOnTermination": false,
                "VolumeId": "vol-049df61146c4d7901",
                "AttachTime": "2013-09-10T23:07:00.000Z"
            }
        }
    ],
}

Вывод

BlockDeviceMappings -> (список)

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

(структура)

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

DeviceName -> (строка)

Имя устройства (например, /dev/sdh или xvdh).

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

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

AttachTime -> (временная метка)

Временная метка, когда началось подключение.

DeleteOnTermination -> (логическое значение)

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

Status -> (строка)

Состояние подключения.

VolumeId -> (строка)

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

AssociatedResource -> (строка)

ARN задачи Amazon ECS или Fargate, к которой подключен том.

VolumeOwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services, являющейся владельцем тома.

Этот параметр возвращается только для томов, подключенных к задачам Fargate.

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

Провайдер сервисов, управляющий томом EBS.

Managed -> (логическое значение)

Если true , ресурс управляется провайдером сервисов.

Principal -> (строка)

Если managed равно true, то возвращается идентификатор принципала. Принципал — это провайдер сервисов, управляющий ресурсом.

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

Указывает, включена ли защита от завершения работы. Если значение равно true, экземпляр нельзя завершить с помощью консоли Amazon EC2, командной строки или API.

Value -> (логическое значение)

Значение атрибута. Допустимые значения — true или false.

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

Указывает, включена ли расширенная сеть с ENA.

Value -> (логическое значение)

Значение атрибута. Допустимые значения — true или false.

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

Указывает, включен ли экземпляр для Amazon Web Services Nitro Enclaves.

Enabled -> (логическое значение)

Если этот параметр установлен в true, экземпляр включен для Amazon Web Services Nitro Enclaves; в противном случае он не включен для Amazon Web Services Nitro Enclaves.

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

Указывает, оптимизирован ли экземпляр для ввода-вывода Amazon EBS.

Value -> (логическое значение)

Значение атрибута. Допустимые значения — true или false.

InstanceId -> (строка)

Идентификатор экземпляра.

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

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

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

Тип экземпляра.

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

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

Value -> (строка)

Значение атрибута. Регистр имеет значение.

ProductCodes -> (список)

Коды продуктов.

(структура)

Описание кода продукта.

ProductCodeId -> (строка)

Код продукта.

ProductCodeType -> (строка)

Тип кода продукта.

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

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

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

Имя устройства тома корневого устройства (например, /dev/sda1).

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

Указывает, включены ли проверки источника/назначения.

Value -> (логическое значение)

Значение атрибута. Допустимые значения — true или false.

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

Указывает, включена ли расширенная сеть с интерфейсом Intel 82599 Virtual Function.

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

Данные пользователя.

Value -> (строка)

Значение атрибута. Регистр имеет значение.

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

Указывает, включена ли защита от остановки экземпляра.

Value -> (логическое значение)

Значение атрибута. Допустимые значения — true или false.

Groups -> (список)

Безопасные группы, связанные с экземпляром.

(структура)

Описание безопасной группы.

GroupId -> (строка)

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

GroupName -> (строка)

Имя безопасной группы.

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

Spec-Zone.ru

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