Spec-Zone.ru › AWS CLI v2

[ aws . resiliencehub ]

describe-app-version-resource

Описание

Описывает ресурс приложения Resilience Hub.

Примечание

Этот API принимает только один из следующих параметров для описания ресурса:

  • resourceName
  • logicalResourceId
  • physicalResourceId (Вместе с physicalResourceId , вы также можете указать awsAccountId и awsRegion )

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

Синтаксис

  describe-app-version-resource
--app-arn <value>
--app-version <value>
[--aws-account-id <value>]
[--aws-region <value>]
[--logical-resource-id <value>]
[--physical-resource-id <value>]
[--resource-name <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 (строка)

Amazon Resource Name (ARN) приложения Resilience Hub. Формат этого ARN: arn:partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference (Имена ресурсов Amazon (ARN)).

--app-version (строка)

Версия приложения Resilience Hub.

--aws-account-id (строка)

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

--aws-region (строка)

Регион Amazon Web Services, который владеет физическим ресурсом.

--logical-resource-id (структура)

Логический идентификатор ресурса.

eksSourceName -> (строка)

Имя кластера и пространства имен Amazon Elastic Kubernetes Service, к которому принадлежит этот ресурс.

Примечание

Этот параметр принимает значения в формате «eks-cluster/namespace».

identifier -> (строка)

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

logicalStackName -> (строка)

Имя стека CloudFormation, к которому принадлежит этот ресурс.

resourceGroupName -> (строка)

Имя группы ресурсов, к которой принадлежит этот ресурс.

terraformSourceName -> (строка)

Имя файла состояния Terraform в S3, к которому принадлежит этот ресурс.

Сокращенный синтаксис:

eksSourceName=string,identifier=string,logicalStackName=string,resourceGroupName=string,terraformSourceName=string

Синтаксис JSON:

{
  "eksSourceName": "string",
  "identifier": "string",
  "logicalStackName": "string",
  "resourceGroupName": "string",
  "terraformSourceName": "string"
}

--physical-resource-id (строка)

Физический идентификатор ресурса.

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

Имя ресурса.

--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
  • 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 (булево)

Отключить вывод AWS CLI.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

appArn -> (строка)

Идентификатор ресурса (ARN) приложения Resilience Hub. Формат этого ARN: arn:partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference, раздел Amazon Resource Names (ARNs).

appVersion -> (строка)

Версия приложения Resilience Hub.

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

Определяет физический ресурс. Физический ресурс — это ресурс, существующий в вашем аккаунте. Его можно идентифицировать с помощью идентификатора ресурса Amazon Resource Name (ARN) или собственного идентификатора Resilience Hub.

additionalInfo -> (словарь)

Дополнительные параметры конфигурации для приложения Resilience Hub. Если вы хотите настроить параметры конфигурации приложения через консоль Resilience Hub, а не через вызов API, см. Настройка параметров конфигурации приложения.

Примечание

В настоящее время этот параметр принимает сопоставление пар «ключ-значение» (в строковом формате) только для одного региона резервного копирования и одного связанного аккаунта.

Ключ: "failover-regions"

Значение: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

key -> (строка)

value -> (список)

(строка)

appComponents -> (список)

Компоненты приложения, относящиеся к данному ресурсу.

(структура)

Определяет компонент приложения.

additionalInfo -> (словарь)

Дополнительные параметры конфигурации для приложения Resilience Hub. Если вы хотите настроить параметры конфигурации приложения через консоль Resilience Hub, а не через вызов API, см. Настройка параметров конфигурации приложения.

Примечание

В настоящее время этот параметр принимает сопоставление пар «ключ-значение» (в строковом формате) только для одного региона резервного копирования и одного связанного аккаунта.

Ключ: "failover-regions"

Значение: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

key -> (строка)

value -> (список)

(строка)

id -> (строка)

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

name -> (строка)

Название компонента приложения.

type -> (строка)

Тип компонента приложения.

excluded -> (логическое значение)

Указывает, включен или исключен ресурс из оценки.

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

Логический идентификатор ресурса.

eksSourceName -> (строка)

Имя кластера и пространства имен Amazon Elastic Kubernetes Service, к которому относится данный ресурс.

Примечание

Этот параметр принимает значения в формате «eks-cluster/namespace».

identifier -> (строка)

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

logicalStackName -> (строка)

Имя стека CloudFormation, к которому относится этот ресурс.

resourceGroupName -> (строка)

Имя группы ресурсов, к которой относится данный ресурс.

terraformSourceName -> (строка)

Имя файла состояния Terraform в S3, к которому относится данный ресурс.

parentResourceName -> (строка)

Имя родительского ресурса.

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

Идентификатор физического ресурса.

awsAccountId -> (строка)

Аккаунт Amazon Web Services, владеющий физическим ресурсом.

awsRegion -> (строка)

Регион Amazon Web Services, в котором расположен физический ресурс.

identifier -> (строка)

Идентификатор физического ресурса.

type -> (строка)

Указывает тип идентификатора физического ресурса.

Arn

Идентификатор ресурса — это Amazon Resource Name (ARN), и он может идентифицировать следующий список ресурсов:

  • AWS::ECS::Service

  • AWS::EFS::FileSystem

  • AWS::ElasticLoadBalancingV2::LoadBalancer

  • AWS::Lambda::Function

  • AWS::SNS::Topic

    Native

Идентификатор ресурса — это собственный идентификатор Resilience Hub, и он может идентифицировать следующий список ресурсов:

  • AWS::ApiGateway::RestApi
  • AWS::ApiGatewayV2::Api
  • AWS::AutoScaling::AutoScalingGroup
  • AWS::DocDB::DBCluster
  • AWS::DocDB::DBGlobalCluster
  • AWS::DocDB::DBInstance
  • AWS::DynamoDB::GlobalTable
  • AWS::DynamoDB::Table
  • AWS::EC2::EC2Fleet
  • AWS::EC2::Instance
  • AWS::EC2::NatGateway
  • AWS::EC2::Volume
  • AWS::ElasticLoadBalancing::LoadBalancer
  • AWS::RDS::DBCluster
  • AWS::RDS::DBInstance
  • AWS::RDS::GlobalCluster
  • AWS::Route53::RecordSet
  • AWS::S3::Bucket
  • AWS::SQS::Queue

resourceName -> (строка)

Имя ресурса.

resourceType -> (строка)

Тип ресурса.

sourceType -> (строка)

Тип источника входных данных.

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

Spec-Zone.ru

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