[ aws . cloudformation ]
describe-stack-set
Описание
Возвращает описание указанного набора стеков.
См. также: Документация API AWS
Синтаксис
describe-stack-set
--stack-set-name <value>
[--call-as <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-set-name (строка)
--call-as (строка)
[Разрешения, управляемые сервисом] Указывает, действуете ли вы как администратор учетной записи в учетной записи управления организацией или как делегированный администратор в учетной записи участника.
По умолчанию, SELF задается. Используйте SELF для наборов стеков с разрешениями, управляемыми самостоятельно.
- Если вы вошли в учетную запись управления, укажите
SELF. - Если вы вошли в учетную запись делегированного администратора, укажите
DELEGATED_ADMIN. Ваша учетная запись Amazon Web Services должна быть зарегистрирована как делегированный администратор в учетной записи управления. Дополнительную информацию см. в руководстве пользователя CloudFormation в разделе "Регистрация делегированного администратора".
Возможные значения:
SELFDELEGATED_ADMIN
--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
- 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.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы получить информацию о наборе стеков
Следующий пример describe-stack-set` отображает детали указанного набора стеков.
aws cloudformation describe-stack-set \
--stack-set-name my-stack-set
Вывод:
{
"StackSet": {
"StackSetName": "my-stack-set",
"StackSetId": "my-stack-set:296a3360-xmpl-40af-be78-9341e95bf743",
"Description": "Create an Amazon SNS topic",
"Status": "ACTIVE",
"TemplateBody": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: An AWS SNS topic\nResources:\n topic:\n Type: AWS::SNS::Topic",
"Parameters": [],
"Capabilities": [],
"Tags": [],
"StackSetARN": "arn:aws:cloudformation:us-west-2:123456789012:stackset/enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
"AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole",
"ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole"
}
}
Вывод
StackSet -> (структура)
Указанный набор стеков.
StackSetName -> (строка)
StackSetId -> (строка)
Описание -> (строка)
Статус -> (строка)
TemplateBody -> (строка)
Параметры -> (список)
Список входных параметров для набора стеков.
(структура)
Тип данных параметра.
ParameterKey -> (строка)
ParameterValue -> (строка)
UsePreviousValue -> (булево)
true, не указывайте значение параметра.ResolvedValue -> (строка)
Возможности -> (список)
Возможности, разрешенные в наборе стеков. Некоторые шаблоны наборов стеков могут содержать ресурсы, которые могут повлиять на разрешения в вашей учетной записи Amazon Web Services, например, создавая новых пользователей Identity and Access Management (IAM). Дополнительную информацию см. в разделе Признание ресурсов IAM в шаблонах CloudFormation.
(строка)
Теги -> (список)
Список тегов, содержащих информацию о наборе стеков. Можно указать максимальное количество 50 тегов.
(структура)
Тип тега позволяет указать пару ключ-значение, которая может использоваться для хранения информации о стеке CloudFormation.
Ключ -> (строка)
aws:.Значение -> (строка)
StackSetARN -> (строка)
AdministrationRoleARN -> (строка)
Amazon Resource Name (ARN) роли IAM, используемой для создания или обновления набора стеков.
Используйте настраиваемые роли администратора, чтобы контролировать, какие пользователи или группы могут управлять конкретными наборами стеков в одной учетной записи администратора. Дополнительную информацию см. в разделе Предварительные требования к использованию CloudFormation StackSets в руководстве пользователя CloudFormation.
ExecutionRoleName -> (строка)
Имя роли выполнения IAM, используемой для создания или обновления набора стеков.
Используйте настраиваемые роли выполнения, чтобы контролировать, какие ресурсы стеков пользователи и группы могут включать в свои наборы стеков.
StackSetDriftDetectionDetails -> (структура)
Подробная информация о статусе дрейфа набора стеков.
Для наборов стеков содержит информацию о последней завершенной операции обнаружения дрейфа, выполненной над набором стеков. Информация об операциях обнаружения дрейфа, которые в настоящее время выполняются, не включается.
DriftStatus -> (строка)
Статус фактической конфигурации набора стеков по сравнению с ожидаемой конфигурацией шаблона и параметров. Набор стеков считается подверженным дрейфу, если один или несколько его экземпляров стека отклонились от ожидаемой конфигурации шаблона и параметров.
-
DRIFTED: Один или несколько экземпляров стеков, принадлежащих набору стеков, отличаются от ожидаемого шаблона и конфигурации параметров. Экземпляр стека считается подверженным дрейфу, если один или несколько ресурсов в соответствующем стеке подвержены дрейфу. -
NOT_CHECKED: CloudFormation не проверял набор стеков на дрейф. -
IN_SYNC: Все экземпляры стеков, принадлежащие набору стеков, соответствуют ожидаемому шаблону и конфигурации параметров.
DriftDetectionStatus -> (строка)
Статус операции обнаружения дрейфа набора стеков.
-
COMPLETED: Операция обнаружения дрейфа завершилась без сбоев на каких-либо экземплярах стеков. -
FAILED: Операция обнаружения дрейфа превысила заданную допустимую погрешность. -
PARTIAL_SUCCESS: Операция обнаружения дрейфа завершилась без превышения допустимой погрешности для операции. -
IN_PROGRESS: Операция обнаружения дрейфа в настоящее время выполняется. -
STOPPED: Пользователь отменил операцию обнаружения дрейфа.
LastDriftCheckTimestamp -> (отметка времени)
NULL для любого набора стеков, для которого еще не проводилось обнаружение дрейфа.TotalStackInstancesCount -> (целое число)
Общее количество экземпляров стеков, принадлежащих этому набору стеков.
Общее количество экземпляров стеков равно сумме:
- Экземпляры стеков, соответствующие конфигурации набора стеков.
- Экземпляры стеков, которые отклонились от конфигурации набора стеков.
- Экземпляры стеков, где операция обнаружения дрейфа завершилась сбоем.
- Экземпляры стеков, которые в настоящее время проверяются на дрейф.
DriftedStackInstancesCount -> (целое число)
InSyncStackInstancesCount -> (целое число)
InProgressStackInstancesCount -> (целое число)
FailedStackInstancesCount -> (целое число)
AutoDeployment -> (структура)
[Права управления службой] Описывает, автоматически ли StackSets развертывает в учетных записях Organizations, добавленных к целевой организации или организационной единице (OU).
Enabled -> (булево)
true, StackSets автоматически развертывает дополнительные экземпляры стеков в учетных записях Organizations, добавленных к целевой организации или организационной единице (OU) в указанных регионах. Если учетная запись удаляется из целевой организации или OU, StackSets удаляет экземпляры стеков из учетной записи в указанных регионах.RetainStacksOnAccountRemoval -> (булево)
true, ресурсы стека сохраняются при удалении учетной записи из целевой организации или OU. Если установлено значение false, ресурсы стека удаляются. Указывается только если Enabled установлено значение True.PermissionModel -> (строка)
Описывает, как создаются роли IAM, необходимые для операций с набором стеков.
- С разрешениями
self-managed, вы должны создать роли администратора и выполнения, необходимые для развертывания в целевых учетных записях. Дополнительную информацию см. в разделе Предоставление прав самостоятельного управления. - С разрешениями
service-managed, StackSets автоматически создает роли IAM, необходимые для развертывания в учетных записях, управляемых Organizations. Дополнительную информацию см. в разделе Активация доверенного доступа для наборов стеков с Organizations.
OrganizationalUnitIds -> (список)
[Права управления службой] Идентификатор корня организации или идентификаторы организационных единиц (OU), которые вы указали для DeploymentTargets.
(строка)
ManagedExecution -> (структура)
Описывает, выполняет ли StackSets неконфликтующие операции одновременно и помещает в очередь конфликтующие операции.
Active -> (булево)
При значении true, StackSets выполняет неконфликтующие операции одновременно и помещает в очередь конфликтующие операции. После завершения конфликтующих операций StackSets запускает операции из очереди в порядке запроса.
Примечание
Если уже выполняются или находятся в очереди операции, StackSets помещает в очередь все входящие операции, даже если они неконфликтующие.
Вы не можете изменить конфигурацию выполнения набора стеков, пока для этого набора стеков выполняются или находятся в очереди операции.
При значении false (по умолчанию) StackSets выполняет одну операцию за раз в порядке запроса.
Regions -> (список)
Возвращает список всех регионов Amazon Web Services, в которых у данного StackSet развернуты экземпляры стеков. Список регионов Amazon Web Services возвращается без определенного порядка.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.