Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

describe-stack-resource

Описание

Возвращает описание указанного ресурса в указанной стеке.

Для удаленных стеков DescribeStackResource возвращает информацию о ресурсах в течение 90 дней после удаления стека.

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

Синтаксис

  describe-stack-resource
--stack-name <value>
--logical-resource-id <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]

Параметры

--stack-name (строка)

Имя или уникальный идентификатор стека, связанный со стеком, которые не всегда взаимозаменяемы:

  • Активные стеки: можно указать либо имя стека, либо его уникальный идентификатор.
  • Удаленные стеки: необходимо указать уникальный идентификатор стека.

--logical-resource-id (строка)

Логическое имя ресурса, как указано в шаблоне.

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Чтобы получить информацию о ресурсе стека

Следующий пример describe-stack-resource отображает подробности для ресурса с именем MyFunction в указанной стеке.

aws cloudformation describe-stack-resource \
    --stack-name MyStack \
    --logical-resource-id MyFunction

Вывод:

{
    "StackResourceDetail": {
        "StackName": "MyStack",
        "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
        "LogicalResourceId": "MyFunction",
        "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
        "ResourceType": "AWS::Lambda::Function",
        "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
        "ResourceStatus": "UPDATE_COMPLETE",
        "Metadata": "{}",
        "DriftInformation": {
            "StackResourceDriftStatus": "IN_SYNC"
        }
    }
}

Вывод

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

Структура StackResourceDetail, содержащая описание указанного ресурса в указанной стеке.

StackName -> (строка)

Имя, связанное со стеком.

StackId -> (строка)

Уникальный идентификатор стека.

LogicalResourceId -> (строка)

Логическое имя ресурса, указанное в шаблоне.

PhysicalResourceId -> (строка)

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

ResourceType -> (строка)

Тип ресурса. Дополнительную информацию см. в справке по типам ресурсов и свойствам Amazon Web Services в руководстве пользователя CloudFormation.

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

Время обновления статуса.

ResourceStatus -> (строка)

Текущий статус ресурса.

ResourceStatusReason -> (строка)

Сообщение об успехе/неудачи, связанное с ресурсом.

Description -> (строка)

Пользовательское описание, связанное с ресурсом.

Metadata -> (строка)

Содержимое атрибута Metadata, объявленного для ресурса. Дополнительную информацию см. в руководстве пользователя CloudFormation в разделе атрибута Metadata.

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

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

StackResourceDriftStatus -> (строка)

Статус фактической конфигурации ресурса по сравнению с ожидаемой конфигурацией

  • DELETED : Ресурс отличается от ожидаемой конфигурации тем, что он был удален.
  • MODIFIED : Ресурс отличается от ожидаемой конфигурации.
  • NOT_CHECKED : CloudFormation не проверил, отличается ли ресурс от ожидаемой конфигурации. Все ресурсы, которые в настоящее время не поддерживают обнаружение отклонений, имеют статус NOT_CHECKED. Дополнительную информацию см. в разделе Поддержка типов ресурсов для импорта и обнаружения отклонений.
  • IN_SYNC : Фактическая конфигурация ресурса соответствует ожидаемой конфигурации.

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

Когда CloudFormation в последний раз проверял, отклонился ли ресурс от ожидаемой конфигурации.

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

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

TypeHierarchy -> (строка)

Объединенный список типов модулей, содержащих ресурс. Типы модулей перечислены, начиная с самого внутреннего вложенного модуля и разделены /.

В следующем примере ресурс был создан из модуля типа AWS::First::Example::MODULE, вложенного во внутренний модуль типа AWS::Second::Example::MODULE.

AWS::First::Example::MODULE/AWS::Second::Example::MODULE

LogicalIdHierarchy -> (строка)

Объединенный список логических идентификаторов модулей, содержащих ресурс. Модули перечислены, начиная с самого внутреннего вложенного модуля, и разделены /.

В следующем примере ресурс был создан из модуля moduleA, вложенного во внутренний модуль moduleB.

moduleA/moduleB

Дополнительную информацию см. в руководстве пользователя CloudFormation в разделе Ссылка на модульные ресурсы в шаблонах CloudFormation.

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

Spec-Zone.ru

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