[ aws . resiliencehub ]
describe-app-version-шаблон
Описание
Описывает подробную информацию об приложении Resilience Hub.
См. также: Документацию API AWS
Синтаксис
describe-app-version-template
--app-arn <value>
--app-version <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]
Параметры
--app-arn (строка)
partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference по именам ресурсов Amazon (ARN).--app-version (строка)
--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-auto-prompt (булево)
Автоматически запрашивать входные параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы входных параметров CLI.
Вывод
appArn -> (строка)
partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе «Идентификаторы ресурсов Amazon (ARN)».appTemplateBody -> (строка)
Строка JSON, содержащая информацию о структуре вашего приложения. Дополнительную информацию о шаблоне appTemplateBody см. в примере шаблона в разделе Примеры.
Строка JSON appTemplateBody имеет следующую структуру:
-
**
resources** Список логических ресурсов, которые должны быть включены в приложение Resilience Hub. Тип: Массив
Примечание
Каждый элемент массива resources содержит следующие поля:
-
*
logicalResourceId* Логический идентификатор ресурса. Тип: Объект. Каждый объектlogicalResourceIdсодержит следующие поля:-
identifierИдентификатор ресурса. Тип: Строка -
logicalStackNameИмя стека CloudFormation, к которому принадлежит этот ресурс. Тип: Строка -
resourceGroupNameИмя группы ресурсов, к которой принадлежит этот ресурс. Тип: Строка -
terraformSourceNameИмя файла состояния Terraform S3, к которому принадлежит этот ресурс. Тип: Строка -
eksSourceNameИмя кластера и пространства имен Amazon Elastic Kubernetes Service, к которому принадлежит этот ресурс.
Примечание
Этот параметр принимает значения в формате «eks-cluster/namespace».
Тип: Строка
-
-
*
type* Тип ресурса. Тип: строка -
*
name* Имя ресурса. Тип: Строка -
additionalInfoДополнительные параметры конфигурации для приложения Resilience Hub. Если вы хотите настроитьadditionalInfoчерез консоль Resilience Hub, а не используя API-вызов, см. Настройка параметров конфигурации приложения.
Примечание
В настоящее время этот параметр принимает сопоставление ключ-значение (в формате строки) только одной зоны отказоустойчивости и одного связанного аккаунта. Ключ:"failover-regions" Значение: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
**
appComponents** Список компонентов приложения, к которому принадлежит этот ресурс. Если компонент приложения не входит в состав приложения Resilience Hub, он будет добавлен. Тип: Массив. Каждый элемент массиваappComponentsсодержит следующие поля:-
nameИмя компонента приложения. Тип: Строка -
typeТип компонента приложения. Дополнительную информацию о типах компонентов приложения см. в разделе Группировка ресурсов в компоненте приложения. Тип: Строка -
resourceNamesСписок включенных ресурсов, назначенных компоненту приложения. Тип: Массив строк -
additionalInfoДополнительные параметры конфигурации для приложения Resilience Hub. Если вы хотите настроитьadditionalInfoчерез консоль Resilience Hub, а не используя API-вызов, см. Настройка параметров конфигурации приложения.
Примечание
В настоящее время этот параметр принимает сопоставление ключ-значение (в формате строки) только одной зоны отказоустойчивости и одного связанного аккаунта. Ключ:
"failover-regions"Значение:"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" -
-
**
excludedResources** Список логических идентификаторов ресурсов, которые нужно исключить из приложения. Тип: Массив
Примечание
Каждый элемент массива excludedResources содержит следующие поля:
-
*
logicalResourceIds* Логический идентификатор ресурса. Тип: Объект
Примечание
Можно настроить только одно из следующих полей:
logicalStackNameresourceGroupNameterraformSourceNameeksSourceName
Каждый объект logicalResourceIds содержит следующие поля:
-
identifierИдентификатор ресурса. Тип: Строка -
logicalStackNameИмя стека CloudFormation, к которому принадлежит этот ресурс. Тип: Строка -
resourceGroupNameИмя группы ресурсов, к которой принадлежит этот ресурс. Тип: Строка -
terraformSourceNameИмя файла состояния Terraform S3, к которому принадлежит этот ресурс. Тип: Строка -
eksSourceNameИмя кластера и пространства имен Amazon Elastic Kubernetes Service, к которому принадлежит этот ресурс.
Примечание
Тип: Строка
-
**
version** Версия приложения Resilience Hub. -
additionalInfoДополнительные параметры конфигурации для приложения Resilience Hub. Если вы хотите настроитьadditionalInfoчерез консоль Resilience Hub, а не используя API-вызов, см. Настройка параметров конфигурации приложения.
Примечание
В настоящее время этот параметр принимает сопоставление ключ-значение (в формате строки) только одной зоны отказоустойчивости и одного связанного аккаунта. Ключ:"failover-regions" Значение: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
appVersion -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.