Spec-Zone.ru › AWS CLI v2

[ aws . wellarchitected ]

create-workload

Описание

Создайте новую рабочую нагрузку.

Владелец рабочей нагрузки может поделиться ею с другими учетными записями Amazon Web Services, пользователями, организацией и подразделениями организации (OU) в той же области Amazon Web Services. Только владелец рабочей нагрузки может её удалить.

Дополнительную информацию см. в разделе Определение рабочей нагрузки в руководстве пользователя инструмента Well-Architected Tool.

Предупреждение

При создании рабочей нагрузки необходимо указать AwsRegions , NonAwsRegions или оба параметра.

Также необходимо указать ReviewOwner , даже если в следующем разделе параметр указан как необязательный.

При создании рабочей нагрузки с помощью шаблона обзора вам потребуются следующие разрешения IAM:

  • wellarchitected:GetReviewTemplate
  • wellarchitected:GetReviewTemplateAnswer
  • wellarchitected:ListReviewTemplateAnswers
  • wellarchitected:GetReviewTemplateLensReview

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

Синтаксис

  create-workload
--workload-name <value>
--description <value>
--environment <value>
[--account-ids <value>]
[--aws-regions <value>]
[--non-aws-regions <value>]
[--pillar-priorities <value>]
[--architectural-design <value>]
[--review-owner <value>]
[--industry-type <value>]
[--industry <value>]
--lenses <value>
[--notes <value>]
[--client-request-token <value>]
[--tags <value>]
[--discovery-config <value>]
[--applications <value>]
[--profile-arns <value>]
[--review-template-arns <value>]
[--jira-configuration <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]

Параметры

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

Имя рабочей нагрузки.

Имя должно быть уникальным в пределах учетной записи в области Amazon Web Services. Пробелы и регистр при проверке уникальности игнорируются.

--description (строка)

Описание рабочей нагрузки.

--environment (строка)

Окружение рабочей нагрузки.

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

  • PRODUCTION
  • PREPRODUCTION

--account-ids (список)

Список идентификаторов учетных записей Amazon Web Services, связанных с рабочей нагрузкой.

(строка)

Идентификатор учетной записи Amazon Web Services.

Синтаксис:

"string" "string" ...

--aws-regions (список)

Список областей Amazon Web Services, связанных с рабочей нагрузкой, например, us-east-2 или ca-central-1.

(строка)

Область Amazon Web Services, например, us-west-2 или ap-northeast-1.

Синтаксис:

"string" "string" ...

--non-aws-regions (список)

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

(строка)

Синтаксис:

"string" "string" ...

--pillar-priorities (список)

Приоритеты столпов, которые используются для упорядочивания элементов в плане улучшений. Каждый столп представлен своим PillarReviewSummary$PillarId.

(строка)

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

Столб определяется своим PillarReviewSummary$PillarId.

Синтаксис:

"string" "string" ...

--architectural-design (строка)

URL архитектурного проекта для рабочей нагрузки.

--review-owner (строка)

Владелец обзора рабочей нагрузки. Имя, адрес электронной почты или идентификатор основной группы или лица, владеющего процессом обзора рабочей нагрузки.

--industry-type (строка)

Тип отрасли для рабочей нагрузки.

Если указано, должно быть одним из следующих:

  • Agriculture
  • Automobile
  • Defense
  • Design and Engineering
  • Digital Advertising
  • Education
  • Environmental Protection
  • Financial Services
  • Gaming
  • General Public Services
  • Healthcare
  • Hospitality
  • InfoTech
  • Justice and Public Safety
  • Life Sciences
  • Manufacturing
  • Media & Entertainment
  • Mining & Resources
  • Oil & Gas
  • Power & Utilities
  • Professional Services
  • Real Estate & Construction
  • Retail & Wholesale
  • Social Protection
  • Telecommunications
  • Travel, Transportation & Logistics
  • Other

--industry (строка)

Отрасль для рабочей нагрузки.

--lenses (список)

Список линз, связанных с рабочей нагрузкой. Каждая линза идентифицируется своим LensSummary$LensAlias.

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

(строка)

Псевдоним линзы.

Для официальных линз Amazon Web Services это либо псевдоним линзы, например, serverless, либо ARN линзы, например, arn:aws:wellarchitected:us-east-1::lens/serverless. Обратите внимание, что некоторые операции (такие как ExportLens и CreateLensShare) недоступны для официальных линз Amazon Web Services.

Для пользовательских линз это ARN линзы, например, arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Каждая линза идентифицируется своим LensSummary$LensAlias.

Синтаксис:

"string" "string" ...

--notes (строка)

Заметки, связанные с рабочей нагрузкой.

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

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

Уникальная строка, чувствительная к регистру, используемая для обеспечения идемпотентности этого запроса (выполняется только один раз).

Не следует повторно использовать один и тот же токен для других запросов. Если вы повторяете запрос с тем же токеном запроса клиента и теми же параметрами после успешного завершения исходного запроса, возвращается результат исходного запроса.

Предупреждение

Этот токен указан как обязательный, но если вы его не укажете, Amazon Web Services SDK автоматически сгенерирует его для вас. Если вы не используете Amazon Web Services SDK или командную строку, вы должны предоставить этот токен, или запрос завершится ошибкой.

--tags (массив)

Теги, которые необходимо связать с рабочей нагрузкой.

ключ -> (строка)

значение -> (строка)

Сокращенная запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--discovery-config (структура)

Параметры конфигурации обнаружения Well-Architected, связанные с рабочей нагрузкой.

TrustedAdvisorIntegrationStatus -> (строка)

Статус интеграции обнаружения по отношению к Trusted Advisor для рабочей нагрузки.

WorkloadResourceDefinition -> (список)

Режим для идентификации ресурсов, связанных с рабочей нагрузкой.

Можно указать WORKLOAD_METADATA , APP_REGISTRY или оба.

(строка)

Сокращенная запись:

TrustedAdvisorIntegrationStatus=string,WorkloadResourceDefinition=string,string

Синтаксис JSON:

{
  "TrustedAdvisorIntegrationStatus": "ENABLED"|"DISABLED",
  "WorkloadResourceDefinition": ["WORKLOAD_METADATA"|"APP_REGISTRY", ...]
}

--applications (список)

Список ARN приложений AppRegistry, связанных с рабочей нагрузкой.

(строка)

Синтаксис:

"string" "string" ...

--profile-arns (список)

Список ARN профилей, связанных с рабочей нагрузкой.

(строка)

Синтаксис:

"string" "string" ...

--review-template-arns (список)

Список ARN шаблонов обзора для связывания с рабочей нагрузкой.

(строка)

Синтаксис:

"string" "string" ...

--jira-configuration (структура)

Настройки конфигурации Jira при создании рабочей нагрузки.

IssueManagementStatus -> (строка)

Статус управления задачами Jira на уровне рабочей нагрузки.

IssueManagementType -> (строка)

Тип управления задачами Jira на уровне рабочей нагрузки.

JiraProjectKey -> (строка)

Ключ проекта Jira для синхронизации рабочих нагрузок.

Сокращенная запись:

IssueManagementStatus=string,IssueManagementType=string,JiraProjectKey=string

Синтаксис JSON:

{
  "IssueManagementStatus": "ENABLED"|"DISABLED"|"INHERIT",
  "IssueManagementType": "AUTO"|"MANUAL",
  "JiraProjectKey": "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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить кли-паджинатор для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

WorkloadId -> (string)

Идентификатор, присвоенный рабочему набору. Этот идентификатор уникален в пределах региона Amazon Web Services.

WorkloadArn -> (string)

ARN для рабочего набора.

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

Spec-Zone.ru

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