Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

создание-шаблона-правила-утверждения

Описание

Создает шаблон правил утверждения, который затем можно связать с одним или несколькими репозиториями в вашей учетной записи Amazon Web Services. Привязывая шаблон к репозиторию, CodeCommit создает правило утверждения, соответствующее условиям шаблона для всех запросов на добавление, удовлетворяющих условиям шаблона. Дополнительную информацию см. в разделе associateApprovalRuleTemplateWithRepository.

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

Синтаксис

  create-approval-rule-template
--approval-rule-template-name <value>
--approval-rule-template-content <value>
[--approval-rule-template-description <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]

Параметры

--approval-rule-template-name (строка)

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

--approval-rule-template-content (строка)

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

Примечание

При создании содержимого шаблона правила утверждения вы можете указать утверждающих лиц в группе утверждения двумя способами:

  • CodeCommitApprovers : Этот вариант требует только учетной записи Amazon Web Services и ресурса. Он может использоваться как для пользователей IAM, так и для пользователей с федеративным доступом, имя которых соответствует указанному имени ресурса. Это очень мощный вариант, который обеспечивает большую гибкость. Например, если вы укажете учетную запись Amazon Web Services 123456789012 и Mary_Major, все следующие будут считаться утверждениями от этого пользователя:
    • Пользователь IAM в учетной записи (arn:aws:iam::123456789012 :user/Mary_Major )
    • Пользователь с федеративным доступом, идентифицированный в IAM как Mary_Major (arn:aws:sts::123456789012 :federated-user/Mary_Major )

Этот вариант не распознает активную сессию кого-либо, принимающего роль CodeCommitReview с именем сессии роли Mary_Major (arn:aws:sts::123456789012 :assumed-role/CodeCommitReview/Mary_Major ), если вы не включите символ подстановки (*Mary_Major).

  • Полный квалифицированный ARN : Этот вариант позволяет указать полное квалифицированное имя ресурса Amazon (ARN) пользователя IAM или роли.

Дополнительную информацию об ARN IAM, символах подстановки и форматах см. в разделе Идентификаторы IAM в руководстве пользователя IAM.

--approval-rule-template-description (строка)

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

--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 для вывода.

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве по началу работы с AWS CLI.

Если не указано иное, все примеры используют правила цитирования, похожие на правила Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для создания шаблона правила утверждения

Следующий create-approval-rule-template пример создает шаблон правила утверждения с именем 2-approver-rule-for-main ``. The template requires two users who assume the role of ``CodeCommitReview для утверждения любого запроса на добавление перед его слиянием с веткой main.

aws codecommit create-approval-rule-template \
    --approval-rule-template-name 2-approver-rule-for-main \
    --approval-rule-template-description  "Requires two developers from the team to approve the pull request if the destination branch is main" \
    --approval-rule-template-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"

Вывод:

{
    "approvalRuleTemplate": {
        "approvalRuleTemplateName": "2-approver-rule-for-main",
        "creationDate": 1571356106.936,
        "approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
        "approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
        "lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
        "approvalRuleTemplateDescription": "Requires two developers from the team to approve the pull request if the destination branch is main",
        "lastModifiedDate": 1571356106.936,
        "ruleContentSha256": "4711b576EXAMPLE"
    }
}

Дополнительную информацию см. в разделе Создание шаблона правила утверждения в руководстве пользователя AWS CodeCommit.

Вывод

шаблонПравилУтверждения -> (структура)

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

idШаблонаПравилУтверждения -> (строка)

Сгенерированный системой идентификатор шаблона правила утверждения.

имяШаблонаПравилУтверждения -> (строка)

Имя шаблона правила утверждения.

описаниеШаблонаПравилУтверждения -> (строка)

Описание шаблона правила утверждения.

содержимоеШаблонаПравилУтверждения -> (строка)

Содержимое шаблона правила утверждения.

ruleContentSha256 -> (строка)

Значение SHA-256 для содержимого шаблона правила утверждения.

датаПоследнегоИзменения -> (временная метка)

Дата последнего изменения шаблона правила утверждения в формате временной метки.

датаСоздание -> (временная метка)

Дата создания шаблона правила утверждения в формате временной метки.

изменившийПользователь -> (строка)

Идентификатор Amazon Resource Name (ARN) пользователя, внесшего последние изменения в шаблон правила утверждения.

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

Spec-Zone.ru

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