Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-stack-resources

Описание

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

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

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

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

Синтаксис

  list-stack-resources
--stack-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

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

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

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

Токен для указания начала постраничной выдачи. Это NextToken из предыдущего усечённого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя 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
  • text
  • таблица
  • 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.

Для отображения списка ресурсов в стопке

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

aws cloudformation list-stack-resources \
    --stack-name my-stack

Вывод:

{
    "StackResourceSummaries": [
        {
            "LogicalResourceId": "bucket",
            "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
            "ResourceType": "AWS::S3::Bucket",
            "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "function",
            "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
            "ResourceType": "AWS::Lambda::Function",
            "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
            "ResourceStatus": "UPDATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "functionRole",
            "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
            "ResourceType": "AWS::IAM::Role",
            "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        }
    ]
}

Вывод

StackResourceSummaries -> (список)

Список StackResourceSummary структур.

(структура)

Содержит общую информацию об указанном ресурсе стопки.

LogicalResourceId -> (строка)

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

PhysicalResourceId -> (строка)

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

ResourceType -> (строка)

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

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

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

ResourceStatus -> (строка)

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

ResourceStatusReason -> (строка)

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

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

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

StackResourceDriftStatus -> (строка)

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

  • DELETED: Ресурс отличается от ожидаемой конфигурации тем, что был удалён.
  • MODIFIED: Ресурс отличается от ожидаемой конфигурации.
  • NOT_CHECKED: CloudFormation не проверил, отличается ли ресурс от ожидаемой конфигурации. Все ресурсы, которые в настоящее время не поддерживают обнаружение отклонений, имеют статус NOT_CHECKED. Дополнительную информацию см. в разделе Поддержка типов ресурсов для импорта и обнаружения отклонений . Если вы выполнили операцию ContinueUpdateRollback для стопки, все ресурсы, включённые в ResourcesToSkip, также будут иметь статус NOT_CHECKED. Дополнительную информацию о пропускании ресурсов во время операций отката см. в разделе Продолжение отката обновления в Руководстве пользователя CloudFormation.
  • 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.

NextToken -> (строка)

Если вывод превышает 1 МБ, строка, идентифицирующая следующую страницу ресурсов стопки. Если дополнительных страниц нет, это значение равно null.

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

Spec-Zone.ru

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