Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

describe-stack-instance

Описание

Возвращает экземпляр стека, связанный с указанным набором стеков, учётной записью Amazon Web Services и регионом Amazon Web Services.

Для получения списка экземпляров стеков, связанных со специфическим набором стеков, используйте ListStackInstances.

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

Синтаксис

  describe-stack-instance
--stack-set-name <value>
--stack-instance-account <value>
--stack-instance-region <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 (строка)

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

--stack-instance-account (строка)

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

--stack-instance-region (строка)

Название региона, связанного с этим экземпляром стека.

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

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

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

Следующая команда описывает экземпляр указанного набора стеков в указанной учётной записи и регионе. Набор стеков находится в текущем регионе и учётной записи, а экземпляр находится в регионе us-west-2 в учётной записи 123456789012:

aws cloudformation describe-stack-instance \
    --stack-set-name my-stack-set \
    --stack-instance-account 123456789012 \
    --stack-instance-region us-west-2

Вывод:

{
    "StackInstance": {
        "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743",
        "Region": "us-west-2",
        "Account": "123456789012",
        "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/4287f9a0-e615-xmpl-894a-12b31d3117be",
        "ParameterOverrides": [],
        "Status": "OUTDATED",
        "StatusReason": "ResourceLogicalId:ConfigBucket, ResourceType:AWS::S3::Bucket, ResourceStatusReason:You have attempted to create more buckets than allowed (Service: Amazon S3; Status Code: 400; Error Code: TooManyBuckets; Request ID: F7F21CXMPL580224; S3 Extended Request ID: egd/Fdt89BXMPLyiqbMNljVk55Yqqvi3NYW2nKLUVWhUGEhNfCmZdyj967lhriaG/dWMobSO40o=)."
    }
}

Вывод

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

Экземпляр стека, соответствующий заданным параметрам запроса.

StackSetId -> (строка)

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

Регион -> (строка)

Название региона Amazon Web Services, с которым связан экземпляр стека.

Аккаунт -> (строка)

[Права самообслуживания] Имя учетной записи Amazon Web Services, с которой связан экземпляр стека.

StackId -> (строка)

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

ParameterOverrides -> (список)

Список параметров из шаблона набора стеков, значения которых были переопределены в этом экземпляре стека.

(структура)

Тип данных параметра.

ParameterKey -> (строка)

Ключ, связанный с параметром. Если вы не укажете ключ и значение для конкретного параметра, CloudFormation использует значение по умолчанию, указанное в вашем шаблоне.

ParameterValue -> (строка)

Входное значение, связанное с параметром.

UsePreviousValue -> (булево)

При обновлении стека использовать существующее значение параметра, которое используется стеком для данного ключа параметра. Если вы укажите true, не указывайте значение параметра.

ResolvedValue -> (строка)

Только для чтения. Значение, соответствующее ключу параметра Systems Manager. Этот параметр возвращается только для типов параметров Systems Manager в шаблоне. Дополнительную информацию см. в разделе Указание существующих ресурсов во время выполнения с типами параметров, предоставляемыми CloudFormation, в руководстве пользователя CloudFormation.

Статус -> (строка)

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

  • INOPERABLE : Операция DeleteStackInstances завершилась неудачно и оставила стек в неустойчивом состоянии. Стеки в этом состоянии исключаются из дальнейших операций UpdateStackSet. Возможно, потребуется выполнить операцию DeleteStackInstances с RetainStacks, установленным в true, для удаления экземпляра стека, а затем удалить сам стек вручную. INOPERABLE может быть возвращено здесь, если причиной является неудачный импорт. Если это связано с неудачным импортом, операцию можно повторить после исправления проблем. Чтобы узнать, связано ли это с неудачным импортом, см. член DetailedStatus в члене StackInstanceSummary, который является коллегой этого члена Status.
  • OUTDATED : Стек в данный момент не соответствует набору стеков, так как:
    • Ассоциированный стек завершился неудачно во время операции CreateStackSet или UpdateStackSet.
    • Стек был частью операции CreateStackSet или UpdateStackSet, которая завершилась неудачно или была остановлена до создания или обновления стека.
  • CURRENT : Стек в настоящее время соответствует набору стеков.

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

Подробный статус экземпляра стека.

DetailedStatus -> (строка)

  • CANCELLED : Операция в указанной учетной записи и регионе была отменена. Это либо из-за того, что пользователь остановил операцию с набором стеков, либо из-за превышения допустимого количества сбоев для операции с набором стеков.
  • FAILED : Операция в указанной учетной записи и регионе завершилась неудачно. Если операция с набором стеков завершается неудачно в достаточном количестве учетных записей в регионе, это может привести к превышению допустимого количества сбоев для операции с набором стеков в целом.
  • FAILED_IMPORT : Импорт экземпляра стека в указанной учетной записи и регионе завершился неудачно и оставил стек в неустойчивом состоянии. После устранения проблем, вызвавших ошибку, операцию импорта можно повторить. Если достаточно операций с набором стеков завершаются неудачно в достаточном количестве учетных записей в регионе, это может привести к превышению допустимого количества сбоев для операции с набором стеков в целом.
  • INOPERABLE : Операция DeleteStackInstances завершилась неудачно и оставила стек в неустойчивом состоянии. Стеки в этом состоянии исключаются из дальнейших операций UpdateStackSet. Возможно, потребуется выполнить операцию DeleteStackInstances с RetainStacks, установленным в true, для удаления экземпляра стека, а затем удалить сам стек вручную.
  • PENDING : Операция в указанной учетной записи и регионе еще не началась.
  • RUNNING : Операция в указанной учетной записи и регионе в настоящее время выполняется.
  • SKIPPED_SUSPENDED_ACCOUNT : Операция в указанной учетной записи и регионе была пропущена, так как учетная запись была приостановлена на момент выполнения операции.
  • SUCCEEDED : Операция в указанной учетной записи и регионе выполнена успешно.

StatusReason -> (строка)

Объяснение конкредного кода состояния, назначенного этому экземпляру стека.

OrganizationalUnitId -> (строка)

[Права службы] Корневой идентификатор организации или идентификаторы организационных единиц (OU), которые вы указали для DeploymentTargets.

DriftStatus -> (строка)

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

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

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

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

LastOperationId -> (строка)

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

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

Spec-Zone.ru

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