Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-stack-sets

Описание

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

  • [Права самообслуживания] Если вы установите параметр CallAs в значение SELF, находясь под авторизацией в своей учетной записи Amazon Web Services, ListStackSets вернёт все наборы стеков самообслуживания в вашей учетной записи Amazon Web Services.
  • [Права управляемых сервисом] Если вы установите параметр CallAs в значение SELF, находясь под авторизацией в учетной записи управления организацией, ListStackSets вернёт все наборы стеков в учетной записи управления.
  • [Права управляемых сервисом] Если вы установите параметр CallAs в значение DELEGATED_ADMIN, находясь под авторизацией в своей учетной записи-члене, ListStackSets вернёт все наборы стеков с правами, управляемыми сервисом, в учетной записи управления.

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

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

Синтаксис

  list-stack-sets
[--status <value>]
[--call-as <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]

Параметры

--status (строка)

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

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

  • ACTIVE
  • DELETED

--call-as (строка)

[Права управляемых сервисом] Указывает, действуете ли вы как администратор учетной записи в учетной записи управления или как делегированный администратор в учетной записи-члене.

По умолчанию задаётся SELF. Используйте SELF для наборов стеков с правами самообслуживания.

  • Если вы авторизованы в учетной записи управления, укажите SELF.
  • Если вы авторизованы в учетной записи делегированного администратора, укажите DELEGATED_ADMIN. Ваша учетная запись Amazon Web Services должна быть зарегистрирована как делегированный администратор в учетной записи управления. Дополнительную информацию см. в разделе Зарегистрировать делегированного администратора в Руководстве пользователя CloudFormation.

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

  • SELF
  • DELEGATED_ADMIN

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использование определенного профиля из вашего файла учетных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

Следующий list-stack-sets пример отображает список наборов стеков в текущем регионе и учетной записи.

aws cloudformation list-stack-sets

Вывод:

{
    "Summaries": [
        {
            "StackSetName": "enable-config",
            "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
            "Description": "Enable AWS Config",
            "Status": "ACTIVE"
        }
    ]
}

Вывод

Сводки -> (список)

Список структур StackSetSummary, содержащих информацию о наборах стеков пользователя.

(структура)

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

StackSetName -> (строка)

Имя набора стеков.

StackSetId -> (строка)

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

Описание -> (строка)

Описание набора стеков, которое вы указываете при создании или обновлении набора стеков.

Состояние -> (строка)

Состояние набора стеков.

Автоматическое развертывание -> (структура)

[Права, управляемые службой] Описывает, разворачивает ли StackSets автоматически в учетные записи Организаций, добавленные в целевой организационной единице (ОЕ).

Включено -> (булево)

Если установлено в значение true, StackSets автоматически разворачивает дополнительные экземпляры стеков в учетных записях Организаций, добавленных в целевую организацию или организационную единицу (ОЕ) в указанных регионах. Если учетная запись удаляется из целевой организации или ОЕ, StackSets удаляет экземпляры стеков из учетной записи в указанных регионах.

Сохранять стеки при удалении учетной записи -> (булево)

Если установлено в значение true, ресурсы стека сохраняются при удалении учетной записи из целевой организации или ОЕ. Если установлено в значение false, ресурсы стека удаляются. Указывается только если Enabled установлено в значение True.

Модель разрешений -> (строка)

Описывает, как создаются роли IAM, необходимые для операций с набором стеков.

  • С разрешениями self-managed, вы должны создать администраторские и исполнительные роли, необходимые для развертывания в целевых учетных записях. Дополнительную информацию см. в статье Назначение прав самообслуживания.
  • С разрешениями service-managed, StackSets автоматически создает роли IAM, необходимые для развертывания в учетных записях, управляемых Организациями. Дополнительную информацию см. в статье Активация доверенного доступа для наборов стеков с Организациями.

Состояние отклонения -> (строка)

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

  • DRIFTED: Один или несколько экземпляров стеков, принадлежащих набору стеков, отличаются от ожидаемой конфигурации шаблона и параметров. Экземпляр стека считается отклонившимся, если один или несколько ресурсов в связанном стеке отклонились.
  • NOT_CHECKED: CloudFormation не проверял набор стеков на отклонение.
  • IN_SYNC: Все экземпляры стеков, принадлежащие набору стеков, соответствуют ожидаемой конфигурации шаблона и параметров.
  • UNKNOWN: Это значение зарезервировано для будущих применений.

Последняя метка проверки отклонения -> (метка времени)

Самое последнее время, когда CloudFormation выполнил операцию обнаружения отклонения для набора стеков. Это значение будет NULL для любого набора стеков, для которого обнаружение отклонения еще не выполнено.

Управляемое выполнение -> (структура)

Описывает, выполняет ли StackSets неконфликтующие операции одновременно и ставит в очередь конфликтующие операции.

Активно -> (булево)

Когда true, StackSets выполняет неконфликтующие операции одновременно и ставит в очередь конфликтующие операции. После завершения конфликтующих операций StackSets запускает операции в очереди в порядке запроса.

Примечание

Если уже выполняются или находятся в очереди операции, StackSets ставит в очередь все входящие операции, даже если они не конфликтуют.

Вы не можете изменить конфигурацию выполнения набора стеков, пока для этого набора стеков выполняются или находятся в очереди операции.

Когда false (по умолчанию), StackSets выполняет по одной операции за раз в порядке запроса.

NextToken -> (строка)

Если запрос не возвращает все оставшиеся результаты, NextToken устанавливается в значение токена. Чтобы получить следующий набор результатов, вызовите ListStackInstances снова и присвойте этот токен параметру NextToken объекта запроса. Если запрос возвращает все результаты, NextToken устанавливается в значение null.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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