Spec-Zone.ru › AWS CLI v2

[ aws . resiliencehub ]

create-app

Описание

Создаёт приложение Resilience Hub. Приложение Resilience Hub — это набор ресурсов Amazon Web Services, структурированных для предотвращения и восстановления сбоев приложений Amazon Web Services. Для описания приложения Resilience Hub необходимо указать имя приложения, ресурсы из одного или нескольких стеков CloudFormation, группы ресурсов, файлы состояния Terraform, приложения AppRegistry и соответствующую политику устойчивости. Кроме того, вы можете добавить ресурсы, расположенные на кластерах Amazon Elastic Kubernetes Service (Amazon EKS), в качестве дополнительных ресурсов. Более подробную информацию о количестве поддерживаемых ресурсов на приложение см. в разделе квоты сервиса .

После создания приложения Resilience Hub необходимо опубликовать его, чтобы можно было выполнить оценку устойчивости. Затем вы можете использовать рекомендации по оценке для повышения устойчивости, выполнив ещё одну оценку, сравнив результаты и итеративно повторяя этот процесс, пока не достигнете целевых значений времени восстановления (RTO) и целевого момента восстановления (RPO).

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

Синтаксис

  create-app
[--assessment-schedule <value>]
[--aws-application-arn <value>]
[--client-token <value>]
[--description <value>]
[--event-subscriptions <value>]
--name <value>
[--permission-model <value>]
[--policy-arn <value>]
[--tags <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]

Параметры

--assessment-schedule (строка)

Расписание выполнения оценки с значениями ‘Ежедневно’ или ‘Выключено’.

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

  • Disabled
  • Daily

--aws-application-arn (строка)

Идентификатор ресурса (ARN) группы ресурсов Resource Groups, интегрированной с приложением AppRegistry. Более подробную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе Amazon Resource Names (ARNs).

--client-token (строка)

Используется для маркера идемпотентности. Клиентский токен — это уникальная, регистрозависимая строка до 64 ASCII символов. Не следует повторно использовать один и тот же клиентский токен для других запросов API.

--description (строка)

Необязательное описание приложения.

--event-subscriptions (список)

Список событий, на которые вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий Обнаружено отклонение и Плановое завершение оценки с ошибкой.

(структура)

Указывает событие, на которое вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий Обнаружено отклонение и Плановое завершение оценки с ошибкой.

eventType -> (строка)

Тип события, на которое вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий Обнаружено отклонение (DriftDetected ) и Плановое завершение оценки с ошибкой (ScheduledAssessmentFailure ).

name -> (строка)

Уникальное имя для идентификации подписки на события.

snsTopicArn -> (строка)

Идентификатор ресурса (ARN) темы Amazon Simple Notification Service. Формат этого ARN: arn:partition:sns:region:account:topic-name . Более подробную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе Amazon Resource Names (ARNs).

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

eventType=string,name=string,snsTopicArn=string ...

Синтаксис JSON:

[
  {
    "eventType": "ScheduledAssessmentFailure"|"DriftDetected",
    "name": "string",
    "snsTopicArn": "string"
  }
  ...
]

--name (строка)

Имя приложения.

--permission-model (структура)

Определяет роли и учетные данные, которые Resilience Hub будет использовать при создании приложения, импорте его ресурсов и выполнении оценки.

crossAccountRoleArns -> (список)

Определяет список идентификаторов ресурсов (ARN) ролей, которые будут использоваться в других учётных записях. Эти ARN используются для запросов при импорте ресурсов и оценке вашего приложения.

Примечание

  • Эти ARN требуются только тогда, когда ваши ресурсы находятся в других учётных записях и у вас есть другое имя роли в этих учётных записях. В противном случае, будет использоваться имя вызывающей роли в других учётных записях.
  • Эти роли должны иметь политику доверия с правом iam:AssumeRole для вызывающей роли в основной учётной записи.

(строка)

invokerRoleName -> (строка)

Существующее имя роли Amazon Web Services IAM в основной учётной записи Amazon Web Services, которое будет принять на себя Принцип службы Resilience Hub, чтобы получить чтение-только доступ к ресурсам вашего приложения во время выполнения оценки.

Если ваша роль IAM включает путь, вы должны включить путь в параметре invokerRoleName. Например, если ARN вашей роли IAM — arn:aws:iam:123456789012:role/my-path/role-name, вы должны передать my-path/role-name.

Примечание

  • У вас должна быть iam:passRole разрешение для этой роли при создании или обновлении приложения.
  • В настоящее время invokerRoleName принимает только [A-Za-z0-9_+=,.@-] символов.

type -> (строка)

Определяет, как Resilience Hub сканирует ваши ресурсы. Он может сканировать ресурсы, используя существующую роль в вашей учётной записи Amazon Web Services, или используя учетные данные текущего пользователя IAM.

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

crossAccountRoleArns=string,string,invokerRoleName=string,type=string

Синтаксис JSON:

{
  "crossAccountRoleArns": ["string", ...],
  "invokerRoleName": "string",
  "type": "LegacyIAMUser"|"RoleBased"
}

--policy-arn (строка)

Идентификатор ресурса (ARN) политики устойчивости. Формат этого ARN: arn:partition :resiliencehub:region :account :resiliency-policy/policy-id . Более подробную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе Amazon Resource Names (ARNs).

--tags (массив)

Теги, назначенные ресурсу. Тег — это метка, которую вы назначаете ресурсу Amazon Web Services. Каждый тег состоит из пары ключ/значение.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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
  • текст
  • таблица
  • 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.

Вывод

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

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

appArn -> (строка)

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

assessmentSchedule -> (строка)

Расписание выполнения оценки с значениями «Ежедневно» или «Отключено».

awsApplicationArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы Resource Groups, интегрированной с приложением AppRegistry. Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе Amazon Resource Names (ARNs).

complianceStatus -> (строка)

Текущее состояние соответствия политике устойчивости.

creationTime -> (временная метка)

Дата и время создания приложения.

description -> (строка)

Необязательное описание приложения.

driftStatus -> (строка)

Указывает, были ли обнаружены отклонения в соответствии (дрефы) при выполнении оценки для вашего приложения.

eventSubscriptions -> (список)

Список событий, на которые вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий «Обнаружено отклонение» и «Ошибка запланированной оценки».

(структура)

Указывает событие, на которое вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий «Обнаружено отклонение» и «Ошибка запланированной оценки».

eventType -> (строка)

Тип события, на который вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий «Обнаружено отклонение» (DriftDetected ) и «Ошибка запланированной оценки» (ScheduledAssessmentFailure ).

name -> (строка)

Уникальное имя для идентификации подписки на события.

snsTopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon Simple Notification Service. Формат этого ARN: arn:partition:sns:region:account:topic-name . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference в разделе Amazon Resource Names (ARNs).

lastAppComplianceEvaluationTime -> (временная метка)

Дата и время последней оценки соответствия.

lastDriftEvaluationTime -> (временная метка)

Указывает последнее время оценки отклонения.

lastResiliencyScoreEvaluationTime -> (временная метка)

Дата и время последней оценки показателя устойчивости.

name -> (строка)

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

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

Определяет роли и учетные данные, которые Resilience Hub будет использовать при создании приложения, импорте его ресурсов и выполнении оценки.

crossAccountRoleArns -> (список)

Определяет список идентификаторов ресурсов Amazon (ARN) ролей, которые будут использоваться в других учетных записях. Эти ARN используются для запросов при импорте ресурсов и оценке вашего приложения.

Примечание

  • Эти ARN необходимы только в том случае, если ваши ресурсы находятся в других учетных записях и у вас разные имена ролей в этих учетных записях. В противном случае будет использовано имя роли вызывающего.
  • У этих ролей политика доверия должна включать разрешение iam:AssumeRole для роли вызывающего в основной учетной записи.

(строка)

invokerRoleName -> (строка)

Существующее имя роли Amazon Web Services IAM в основной учетной записи Amazon Web Services, которое будет использоваться принципом службы Resilience Hub для получения только для чтения доступа к ресурсам вашего приложения при выполнении оценки.

Если ваша роль IAM включает путь, вы должны указать путь в параметре invokerRoleName. Например, если ARN вашей роли IAM равен arn:aws:iam:123456789012:role/my-path/role-name, вы должны передать my-path/role-name.

Примечание

  • Для этой роли требуется разрешение iam:passRole при создании или обновлении приложения.
  • В настоящее время invokerRoleName принимает только [A-Za-z0-9_+=,.@-] символы.

type -> (строка)

Определяет, как Resilience Hub сканирует ваши ресурсы. Он может сканировать ресурсы, используя существующую роль в вашей учетной записи Amazon Web Services, или используя учетные данные текущего пользователя IAM.

policyArn -> (строка)

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

resiliencyScore -> (двойное)

Текущий показатель устойчивости приложения.

rpoInSecs -> (целое число)

Целевой показатель восстановления (RPO) в секундах.

rtoInSecs -> (целое число)

Целевой показатель времени восстановления (RTO) в секундах.

status -> (строка)

Состояние приложения.

tags -> (карта)

Теги, назначенные ресурсу. Тег — это метка, которую вы назначаете ресурсу Amazon Web Services. Каждый тег состоит из пары «ключ/значение».

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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