Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

stop-build

Описание

Попытка остановить запущенное построение.

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

Синтаксис

  stop-build
--id <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]

Параметры

--id (строка)

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

--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.

Примеры

Примечание

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

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

Чтобы остановить построение проекта AWS CodeBuild.

Следующий stop-build пример останавливает указанное построение CodeBuild.

aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE

Вывод:

{
    "build": {
        "startTime": 1556906956.318,
        "initiator": "my-aws-account-name",
        "projectName": "my-demo-project",
        "currentPhase": "COMPLETED",
        "cache": {
            "type": "NO_CACHE"
        },
        "source": {
            "insecureSsl": false,
            "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip",
            "type": "S3"
        },
        "id": "my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
        "endTime": 1556906974.781,
        "phases": [
            {
                "durationInSeconds": 0,
                "phaseType": "SUBMITTED",
                "endTime": 1556906956.935,
                "phaseStatus": "SUCCEEDED",
                "startTime": 1556906956.318
            },
            {
                "durationInSeconds": 1,
                "phaseType": "QUEUED",
                "endTime": 1556906958.272,
                "phaseStatus": "SUCCEEDED",
                "startTime": 1556906956.935
            },
            {
                "phaseType": "PROVISIONING",
                "phaseStatus": "SUCCEEDED",
                "durationInSeconds": 14,
                "contexts": [
                    {
                        "message": "",
                        "statusCode": ""
                    }
                ],
                "endTime": 1556906972.847,
                "startTime": 1556906958.272
            },
            {
                "phaseType": "DOWNLOAD_SOURCE",
                "phaseStatus": "SUCCEEDED",
                "durationInSeconds": 0,
                "contexts": [
                        {
                        "message": "",
                        "statusCode": ""
                    }
                ],
                "endTime": 1556906973.552,
                "startTime": 1556906972.847
            },
            {
                "phaseType": "INSTALL",
                "phaseStatus": "SUCCEEDED",
                "durationInSeconds": 0,
                "contexts": [
                    {
                        "message": "",
                        "statusCode": ""
                    }
                ],
                "endTime": 1556906973.75,
                "startTime": 1556906973.552
            },
            {
                "phaseType": "PRE_BUILD",
                "phaseStatus": "SUCCEEDED",
                "durationInSeconds": 0,
                "contexts": [
                    {
                        "message": "",
                        "statusCode": ""
                    }
                ],
                "endTime": 1556906973.937,
                "startTime": 1556906973.75
            },
            {
                "durationInSeconds": 0,
                "phaseType": "BUILD",
                "endTime": 1556906974.781,
                "phaseStatus": "STOPPED",
                "startTime": 1556906973.937
            },
            {
                "phaseType": "COMPLETED",
                "startTime": 1556906974.781
            }
        ],
        "artifacts": {
            "location": "arn:aws:s3:::artifacts-override/my-demo-project",
            "encryptionDisabled": false,
            "overrideArtifactName": true
        },
        "buildComplete": true,
        "buildStatus": "STOPPED",
        "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
        "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
        "queuedTimeoutInMinutes": 5,
        "timeoutInMinutes": 60,
        "environment": {
            "type": "LINUX_CONTAINER",
            "environmentVariables": [],
            "computeType": "BUILD_GENERAL1_MEDIUM",
            "privilegedMode": false,
            "image": "aws/codebuild/standard:1.0",
            "imagePullCredentialsType": "CODEBUILD"
        },
        "logs": {
            "streamName": "1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
            "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-demo-project;stream=1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
            "groupName": "/aws/codebuild/my-demo-project"
        },
        "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE"
    }
}

Дополнительную информацию см. в разделе "Остановка построения (AWS CLI)" в руководстве пользователя AWS CodeBuild.

Вывод

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

Информация о построении.

id -> (строка)

Уникальный идентификатор построения.

arn -> (строка)

Amazon Resource Name (ARN) построения.

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

Номер построения. Для каждого проекта, buildNumber первого построения равно 1. buildNumber каждого последующего построения увеличивается на 1. Если построение удалено, buildNumber других построений не изменяется.

startTime -> (метка времени)

Время начала процесса построения в формате Unix.

endTime -> (метка времени)

Время окончания процесса построения в формате Unix.

currentPhase -> (строка)

Текущая фаза построения.

buildStatus -> (строка)

Текущий статус построения. Допустимые значения:

  • FAILED : Построение завершилось неудачно.
  • FAULT : Построение завершилось с ошибкой.
  • IN_PROGRESS : Построение все еще выполняется.
  • STOPPED : Построение остановлено.
  • SUCCEEDED : Построение завершилось успешно.
  • TIMED_OUT : Построение превысило время ожидания.

sourceVersion -> (строка)

Любой идентификатор версии для версии исходного кода, подлежащего построению. Если sourceVersion указан на уровне проекта, то этот sourceVersion (на уровне построения) имеет приоритет.

Дополнительную информацию см. в примере версии исходного кода с CodeBuild в руководстве пользователя CodeBuild.

resolvedSourceVersion -> (строка)

Идентификатор версии исходного кода этого построения.

  • Для CodeCommit, GitHub, GitHub Enterprise и BitBucket — идентификатор коммита.
  • Для CodePipeline — версия исходного кода, предоставленная CodePipeline.
  • Для Amazon S3 — это не применимо.

projectName -> (строка)

Имя проекта CodeBuild.

phases -> (список)

Информация обо всех завершенных фазах построения и информации о любой текущей фазе построения, которая еще не завершена.

(структура)

Информация о стадии построения.

phaseType -> (строка)

Имя фазы построения. Допустимые значения:

BUILD

В этой фазе обычно выполняются основные задачи построения.

COMPLETED

Построение завершено.

DOWNLOAD_SOURCE

В этой фазе происходит загрузка исходного кода.

FINALIZING

Построение завершается в этой фазе.

INSTALL

В этой фазе обычно выполняются установки.

POST_BUILD

В этой фазе выполняются действия после построения.

PRE_BUILD

В этой фазе выполняются действия перед построением.

PROVISIONING

Настройка среды построения.

QUEUED

Построение было отправлено и стоит в очереди позади других отправленных построений.

SUBMITTED

Построение было отправлено.

UPLOAD_ARTIFACTS

Артефакты выходных данных построения загружаются в место назначения.

phaseStatus -> (строка)

Текущий статус фазы построения. Допустимые значения:

FAILED

Фаза построения завершилась неудачно.

FAULT

Фаза построения завершилась с ошибкой.

IN_PROGRESS

Фаза построения все еще выполняется.

STOPPED

Фаза построения остановлена.

SUCCEEDED

Фаза построения завершилась успешно.

TIMED_OUT

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

startTime -> (метка времени)

Время начала фазы построения в формате Unix.

endTime -> (метка времени)

Время окончания фазы построения в формате Unix.

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

Сколько секунд между начальным и конечным временем фазы построения.

contexts -> (список)

Дополнительная информация о фазе построения, особенно для устранения неполадок с неудачным построением.

(структура)

Дополнительная информация о фазе построения, у которой есть ошибка. Вы можете использовать эту информацию для устранения неполадок.

statusCode -> (строка)

Код состояния для контекста фазы построения.

message -> (строка)

Объяснение контекста фазы построения. Это может включать идентификатор команды и код завершения.

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

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

type -> (строка)

Тип репозитория, содержащего исходный код для построения. Допустимые значения:

  • BITBUCKET : Исходный код находится в репозитории Bitbucket.
  • CODECOMMIT : Исходный код находится в репозитории CodeCommit.
  • CODEPIPELINE : Настройки исходного кода указаны в действии источника в конвейере CodePipeline.
  • GITHUB : Исходный код находится в репозитории GitHub.
  • GITHUB_ENTERPRISE : Исходный код находится в репозитории GitHub Enterprise Server.
  • GITLAB : Исходный код находится в репозитории GitLab.
  • GITLAB_SELF_MANAGED : Исходный код находится в самообслуживаемом репозитории GitLab.
  • NO_SOURCE : Проект не имеет исходного кода.
  • S3 : Исходный код находится в ведре Amazon S3.

location -> (строка)

Информация о расположении исходного кода для построения. Допустимые значения:

  • Для настроек исходного кода, указанных в действии источника в конвейере CodePipeline, location не должно быть указано. Если оно указано, CodePipeline его игнорирует. Это связано с тем, что CodePipeline использует настройки действия источника в конвейере вместо этого значения.
  • Для исходного кода в репозитории CodeCommit, HTTPS URL для клонирования репозитория, содержащего исходный код и файл buildspec (например, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
  • Для исходного кода в входящем ведре Amazon S3, одно из следующего:
    • Путь к ZIP-архиву, содержащему исходный код (например, <bucket-name>/<path>/<object-name>.zip).
    • Путь к папке, содержащей исходный код (например, <bucket-name>/<path-to-source-code>/<folder>/).
  • Для исходного кода в репозитории GitHub, HTTPS URL для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitHub. Используйте консоль CodeBuild для начала создания проекта построения. При подключении (или повторном подключении) к GitHub в окне GitHub Authorize application для Organization access выберите Request access рядом с каждым репозиторием, которому вы хотите разрешить CodeBuild получать доступ, а затем выберите Authorize application . (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта построения. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth в OAUTH.
  • Для исходного кода в репозитории GitLab или самообслуживаемом репозитории GitLab, HTTPS URL для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта построения. При подключении (или повторном подключении) к GitLab в окне Connections Authorize application выберите Authorize . Затем на странице CodeConnections Create GitLab connection выберите Connect to GitLab . (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта построения. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild переопределить значение по умолчанию и использовать это подключение вместо него, установите значение объекта auth в CODECONNECTIONS в объекте source.
  • Для исходного кода в репозитории Bitbucket, HTTPS URL для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта построения. При подключении (или повторном подключении) к Bitbucket в окне Bitbucket Confirm access to your account выберите Grant access . (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта построения. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth в OAUTH.

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

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

Информация о глубине клонирования Git для проекта построения.

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

Информация о конфигурации Git подмодулей для проекта построения.

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

Установите в значение true, чтобы получить подмодули Git для вашего проекта построения CodeBuild.

buildspec -> (строка)

Объявление файла buildspec для использования в построениях в этом проекте построения.

Если это значение задано, оно может представлять собой встроенное определение buildspec, путь к альтернативному файлу buildspec, относительный к значению встроенной переменной среды CODEBUILD_SRC_DIR, или путь к ведру S3. Ведро должно находиться в той же области Amazon Web Services, что и проект построения. Укажите файл buildspec, используя его ARN (например, arn:aws:s3:::my-codebuild-sample2/buildspec.yml ). Если это значение не указано или установлено в пустую строку, исходный код должен содержать файл buildspec в корневой директории. Дополнительную информацию см. в разделе Имя и расположение файла buildspec.

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

Информация о настройках авторизации для доступа CodeBuild к исходному коду для построения.

type -> (строка)

Тип авторизации для использования. Допустимые варианты: OAUTH, CODECONNECTIONS или SECRETS_MANAGER.

resource -> (строка)

Значение ресурса, применимое к указанному типу авторизации.

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

Установите в значение true, чтобы сообщать о статусе начала и завершения построения вашему поставщику источника. Этот параметр действителен только при использовании GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, GitLab, GitLab Self Managed или Bitbucket в качестве поставщика источника. Если этот параметр установлен, а вы используете другой поставщик источника, будет выброшено исключение invalidInputException.

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

Статус построения, вызванного веб-хуком, всегда сообщается вашему поставщику источника.

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

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

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

context -> (строка)

Указывает контекст статуса построения, отправляемого CodeBuild поставщику источника. Использование этого параметра зависит от поставщика источника.

Bitbucket

Этот параметр используется для параметра name в статусе коммита Bitbucket. Дополнительную информацию см. в документации к API Bitbucket.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра context в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub.

targetUrl -> (строка)

Указывает целевой URL статуса построения, отправляемого CodeBuild поставщику источника. Использование этого параметра зависит от поставщика источника.

Bitbucket

Этот параметр используется для параметра url в статусе коммита Bitbucket. Дополнительную информацию см. в документации к API Bitbucket.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра target_url в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub.

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

Включите этот флаг, чтобы игнорировать предупреждения SSL при подключении к исходному коду проекта.

sourceIdentifier -> (строка)

Идентификатор источника этого проекта. Идентификатор может содержать только символы латинского алфавита, цифры и символы подчеркивания, и должен быть менее 128 символов в длину.

secondarySources -> (список)

Массив объектов ProjectSource.

(структура)

Информация о коде исходного кода для проекта сборки.

тип -> (строка)

Тип репозитория, содержащего исходный код, подлежащий сборке. Допустимые значения:

  • BITBUCKET : Исходный код находится в репозитории Bitbucket.
  • CODECOMMIT : Исходный код находится в репозитории CodeCommit.
  • CODEPIPELINE : Настройки исходного кода указаны в действии источника конвейера в CodePipeline.
  • GITHUB : Исходный код находится в репозитории GitHub.
  • GITHUB_ENTERPRISE : Исходный код находится в репозитории GitHub Enterprise Server.
  • GITLAB : Исходный код находится в репозитории GitLab.
  • GITLAB_SELF_MANAGED : Исходный код находится в репозитории GitLab (самоуправляемый).
  • NO_SOURCE : Проект не имеет исходного кода.
  • S3 : Исходный код находится в ведре Amazon S3.

местоположение -> (строка)

Информация о расположении исходного кода, подлежащего сборке. Допустимые значения:

  • Для настроек исходного кода, указанных в действии источника конвейера CodePipeline, поле location не должно указываться. Если оно указано, CodePipeline его игнорирует. Это связано с тем, что CodePipeline использует настройки действия источника в конвейере, а не это значение.
  • Для исходного кода в репозитории CodeCommit, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec (например, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
  • Для исходного кода в ведре ввода Amazon S3, одно из следующих:
    • Путь к файлу ZIP, содержащему исходный код (например, <bucket-name>/<path>/<object-name>.zip).
    • Путь к папке, содержащей исходный код (например, <bucket-name>/<path-to-source-code>/<folder>/).
  • Для исходного кода в репозитории GitHub, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitHub. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitHub в окне GitHub Авторизовать приложение, для Доступ к организации выберите Запросить доступ рядом с каждым репозиторием, которому вы хотите разрешить доступ CodeBuild, а затем выберите Авторизовать приложение . (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth свойство type в значение OAUTH.
  • Для исходного кода в репозитории GitLab или самоуправляемом репозитории GitLab, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitLab в окне Авторизовать приложение выберите Авторизовать. Затем в окне CodeConnections Создать подключение GitLab выберите Подключиться к GitLab. (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение объекта auth свойство type в значение CODECONNECTIONS в объекте source.
  • Для исходного кода в репозитории Bitbucket, HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Вам необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к Bitbucket в окне Bitbucket Подтвердить доступ к вашей учетной записи выберите Предоставить доступ. (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth свойство type в значение OAUTH.

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

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

Информация о глубине клонирования Git для проекта сборки.

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

Информация о конфигурации Git подмодулей для проекта сборки.

fetchSubmodules -> (булево)

Установите в значение true, чтобы извлечь Git подмодули для вашего проекта сборки CodeBuild.

buildspec -> (строка)

Объявление файла buildspec для использования при сборках в этом проекте сборки.

Если это значение установлено, оно может быть либо встроенным определением buildspec, путем к альтернативному файлу buildspec по отношению к значению встроенной переменной окружения CODEBUILD_SRC_DIR, либо путем к ведру S3. Ведро должно находиться в том же регионе Amazon Web Services, что и проект сборки. Укажите файл buildspec, используя его ARN (например, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). Если это значение не указано или установлено в пустую строку, исходный код должен содержать файл buildspec в корневой директории. Дополнительную информацию см. в разделе Имя и расположение файла buildspec .

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

Информация об установках авторизации для CodeBuild, чтобы получить доступ к исходному коду, подлежащему сборке.

тип -> (строка)

Тип авторизации для использования. Допустимые значения OAUTH, CODECONNECTIONS или SECRETS_MANAGER.

ресурс -> (строка)

Значение ресурса, которое применяется к указанному типу авторизации.

reportBuildStatus -> (булево)

Установите в значение true, чтобы сообщить поставщику источника о начале и завершении сборки. Этот параметр действует только для поставщиков источника GitHub, GitHub Enterprise, GitLab, GitLab Self Managed или Bitbucket. Если это значение установлено, и вы используете другой поставщик источника, возникает invalidInputException.

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

Статус сборки, запущенной через веб-хук, всегда сообщается поставщику источника.

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

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

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

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

Указывает контекст статуса сборки, который CodeBuild отправляет поставщику источника. Использование этого параметра зависит от поставщика источника.

Bitbucket

Этот параметр используется для параметра name в статусе коммита Bitbucket. Дополнительную информацию см. в документации Bitbucket API по сборке.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра context в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub по созданию статуса коммита.

targetUrl -> (строка)

Указывает целевой URL статуса сборки, который CodeBuild отправляет поставщику источника. Использование этого параметра зависит от поставщика источника.

Bitbucket

Этот параметр используется для параметра url в статусе коммита Bitbucket. Дополнительную информацию см. в документации Bitbucket API по сборке.

GitHub/GitHub Enterprise Server

Этот параметр используется для параметра target_url в статусе коммита GitHub. Дополнительную информацию см. в руководстве разработчика GitHub по созданию статуса коммита.

insecureSsl -> (булево)

Включите этот флаг, чтобы игнорировать предупреждения SSL при подключении к исходному коду проекта.

sourceIdentifier -> (строка)

Идентификатор источника проекта. Идентификатор может содержать только буквенно-цифровые символы и подчеркивания, и его длина должна быть меньше 128 символов.

secondarySourceVersions -> (список)

Массив объектов ProjectSourceVersion. Каждый объект ProjectSourceVersion должен быть одним из:

  • Для CodeCommit: идентификатор коммита, ветка или Git тег для использования.
  • Для GitHub: идентификатор коммита, ID запроса на вытягивание, имя ветки или имя тега, соответствующие версии исходного кода, которую нужно собрать. Если указан ID запроса на вытягивание, он должен иметь формат pr/pull-request-ID (например, pr/25). Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
  • Для Bitbucket: идентификатор коммита, имя ветки или имя тега, соответствующие версии исходного кода, которую нужно собрать. Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
  • Для Amazon S3: идентификатор версии объекта, представляющего файл build input ZIP для использования.

(структура)

Идентификатор источника и соответствующая версия.

sourceIdentifier -> (строка)

Идентификатор источника в проекте сборки. Идентификатор может содержать только буквенно-цифровые символы и подчеркивания, и его длина должна быть меньше 128 символов.

sourceVersion -> (строка)

Версия источника для соответствующего идентификатора источника. Если указано, должно быть одним из:

  • Для CodeCommit: идентификатор коммита, ветка или Git тег для использования.
  • Для GitHub: идентификатор коммита, ID запроса на вытягивание, имя ветки или имя тега, соответствующие версии исходного кода, которую нужно собрать. Если указан ID запроса на вытягивание, он должен иметь формат pr/pull-request-ID (например, pr/25). Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
  • Для GitLab: идентификатор коммита, ветка или Git тег для использования.
  • Для Bitbucket: идентификатор коммита, имя ветки или имя тега, соответствующие версии исходного кода, которую нужно собрать. Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
  • Для Amazon S3: идентификатор версии объекта, представляющего файл build input ZIP для использования.

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

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

Информация о результатах сборки.

location -> (строка)

Информация о расположении результатов сборки.

sha256sum -> (строка)

Хэш SHA-256 артефакта сборки.

Вы можете использовать этот хэш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP.

md5sum -> (строка)

Хэш MD5 артефакта сборки.

Вы можете использовать этот хэш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP.

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

Если этот флаг установлен, имя, указанное в файле buildspec, переопределяет имя артефакта. Имя, указанное в файле buildspec, вычисляется во время сборки и использует язык командной оболочки. Например, вы можете добавить дату и время к имени артефакта, чтобы оно всегда было уникальным.

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

Информация о том, отключено ли шифрование для артефактов сборки.

artifactIdentifier -> (строка)

Идентификатор этого определения артефакта.

bucketOwnerAccess -> (строка)

Указывает доступ владельца ведра для объектов, которые другое учётное устройство загружает в их ведро Amazon S3. По умолчанию доступ к этим объектам имеет только учётная запись, загрузившая объекты в ведро. Это свойство позволяет предоставить доступ к этим объектам владельцу ведра.

Примечание

Чтобы использовать это свойство, ваша служба CodeBuild должна иметь разрешение s3:PutBucketAcl. Это разрешение позволяет CodeBuild изменять список управления доступом для ведра.

Это свойство может принимать одно из следующих значений:

NONE

Владелец ведра не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

Владелец ведра имеет только доступ для чтения к объектам. Загружающая учётная запись сохраняет владение объектами.

FULL

Владелец ведра имеет полный доступ к объектам. Владение объектами определяется следующими критериями:

  • Если ведро настроено с параметром Bucket owner preferred, владелец ведра владеет объектами. Загружающая учётная запись будет иметь доступ к объектам в соответствии с политикой ведра.
  • В противном случае загружающая учётная запись сохраняет владение объектами.

Дополнительную информацию о владении объектами Amazon S3 см. в разделе «Управление владение загруженными объектами с помощью S3 Object Ownership» в руководстве пользователя Amazon Simple Storage Service.

secondaryArtifacts -> (список)

Массив объектов ProjectArtifacts.

(структура)

Информация об артефактах выходных данных сборки.

location -> (строка)

Информация о расположении артефактов сборки.

sha256sum -> (строка)

Хэш SHA-256 артефакта сборки.

Вы можете использовать этот хэш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP.

md5sum -> (строка)

Хэш MD5 артефакта сборки.

Вы можете использовать этот хэш вместе с инструментом проверки контрольных сумм для подтверждения целостности и подлинности файла.

Примечание

Это значение доступно только в том случае, если значение packaging проекта сборки установлено в ZIP.

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

Если этот флаг установлен, имя, указанное в файле buildspec, переопределяет имя артефакта. Имя, указанное в файле buildspec, вычисляется во время сборки и использует язык командной оболочки. Например, вы можете добавить дату и время к имени артефакта, чтобы оно всегда было уникальным.

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

Информация о том, отключено ли шифрование для артефактов сборки.

artifactIdentifier -> (строка)

Идентификатор этого определения артефакта.

bucketOwnerAccess -> (строка)

Указывает доступ владельца ведра для объектов, которые другое учётное устройство загружает в их ведро Amazon S3. По умолчанию доступ к этим объектам имеет только учётная запись, загрузившая объекты в ведро. Это свойство позволяет предоставить доступ к этим объектам владельцу ведра.

Примечание

Чтобы использовать это свойство, ваша служба CodeBuild должна иметь разрешение s3:PutBucketAcl. Это разрешение позволяет CodeBuild изменять список управления доступом для ведра.

Это свойство может принимать одно из следующих значений:

NONE

Владелец ведра не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

Владелец ведра имеет только доступ для чтения к объектам. Загружающая учётная запись сохраняет владение объектами.

FULL

Владелец ведра имеет полный доступ к объектам. Владение объектами определяется следующими критериями:

  • Если ведро настроено с параметром Bucket owner preferred, владелец ведра владеет объектами. Загружающая учётная запись будет иметь доступ к объектам в соответствии с политикой ведра.
  • В противном случае загружающая учётная запись сохраняет владение объектами.

Дополнительную информацию о владении объектами Amazon S3 см. в разделе «Управление владение загруженными объектами с помощью S3 Object Ownership» в руководстве пользователя Amazon Simple Storage Service.

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

Информация о кэше для сборки.

type -> (строка)

Тип кэша, используемого проектом сборки. Допустимые значения включают:

  • NO_CACHE : Проект сборки не использует кэш.
  • S3 : Проект сборки считывает и записывает в S3.
  • LOCAL : Проект сборки хранит кэш локально на хосте сборки, который доступен только этому хосту.

location -> (строка)

Информация о местоположении кэша:

  • NO_CACHE или LOCAL : Это значение игнорируется.
  • S3 : Это имя/префикс ведра S3.

modes -> (список)

Массив строк, которые определяют режимы локального кэша. Вы можете использовать один или несколько локальных режимов кэша одновременно. Это используется только для типов кэша LOCAL.

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

LOCAL_SOURCE_CACHE

Кэширует метаданные Git для первичных и вторичных источников. После создания кэша последующие сборки извлекают только изменения между коммитами. Этот режим подходит для проектов с чистым рабочим каталогом и источником, который является большим репозиторием Git. Если вы выбрали этот вариант, а ваш проект не использует репозиторий Git (GitHub, GitHub Enterprise или Bitbucket), этот параметр будет проигнорирован.

LOCAL_DOCKER_LAYER_CACHE

Кэширует существующие слои Docker. Этот режим подходит для проектов, которые собирают или извлекают большие Docker-образы. Он может предотвратить проблемы с производительностью, связанные с загрузкой больших Docker-образов из сети.

Примечание

  • Вы можете использовать кэш слоев Docker только в среде Linux.
  • Флаг privileged должен быть установлен, чтобы ваш проект имел необходимые разрешения Docker.
  • Вы должны учитывать последствия для безопасности перед использованием кэша слоев Docker.

LOCAL_CUSTOM_CACHE

Кэширует каталоги, которые вы указываете в файле buildspec. Этот режим подходит, если сценарий вашей сборки не подходит ни для одного из трех других локальных режимов кэша. Если вы используете пользовательский кэш:

  • Для кэширования можно указывать только каталоги. Вы не можете указывать отдельные файлы.
  • Символические ссылки используются для ссылки на кэшированные каталоги.
  • Кэшированные каталоги связаны с вашей сборкой до того, как она загрузит исходные файлы проекта. Кэшированные элементы переопределяются, если элемент источника имеет то же имя. Каталоги указываются с помощью путей кэша в файле buildspec.

(строка)

cacheNamespace -> (строка)

Определяет область кэша. Вы можете использовать этот namespace для совместного использования кэша между несколькими проектами. Дополнительную информацию см. в разделе «Совместное использование кэша между проектами» в руководстве пользователя CodeBuild.

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

Информация о среде построения для этого построения.

type -> (строка)

Тип среды построения, используемой для связанных построений.

Примечание

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

Для получения дополнительной информации см. Типы вычислительных сред построения в руководстве пользователя CodeBuild .

image -> (строка)

Тег или дайджест изображения, идентифицирующие Docker-образ, который следует использовать для этого проекта построения. Используйте следующие форматы:

  • Для тега изображения: <registry>/<repository>:<tag> . Например, в Docker-репозитории, который CodeBuild использует для управления своими Docker-образами, это будет aws/codebuild/standard:4.0 .
  • Для дайджеста изображения: <registry>/<repository>@<digest> . Например, для указания образа с дайджестом “sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,” используйте <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf .

Для получения дополнительной информации см. Docker-образы, предоставляемые CodeBuild, в руководстве пользователя CodeBuild .

computeType -> (строка)

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

  • ATTRIBUTE_BASED_COMPUTE : Укажите количество vCPU, памяти, дискового пространства и тип машины.

Примечание

Если вы используете ATTRIBUTE_BASED_COMPUTE , вы должны определить свои атрибуты, используя computeConfiguration . CodeBuild выберет самый дешевый экземпляр, который удовлетворяет вашим указанным атрибутам. Для получения дополнительной информации см. Типы сред резервированной емкости в Руководстве пользователя CodeBuild .
  • BUILD_GENERAL1_SMALL : Используйте до 4 ГБ памяти и 2 vCPU для построений.
  • BUILD_GENERAL1_MEDIUM : Используйте до 8 ГБ памяти и 4 vCPU для построений.
  • BUILD_GENERAL1_LARGE : Используйте до 16 ГБ памяти и 8 vCPU для построений, в зависимости от типа вашей среды.
  • BUILD_GENERAL1_XLARGE : Используйте до 72 ГБ памяти и 36 vCPU для построений, в зависимости от типа вашей среды.
  • BUILD_GENERAL1_2XLARGE : Используйте до 144 ГБ памяти, 72 vCPU и 824 ГБ SSD-хранилища для построений. Этот тип вычислений поддерживает Docker-образы объемом до 100 ГБ без сжатия.
  • BUILD_LAMBDA_1GB : Используйте до 1 ГБ памяти для построений. Доступно только для типа среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER .
  • BUILD_LAMBDA_2GB : Используйте до 2 ГБ памяти для построений. Доступно только для типа среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER .
  • BUILD_LAMBDA_4GB : Используйте до 4 ГБ памяти для построений. Доступно только для типа среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER .
  • BUILD_LAMBDA_8GB : Используйте до 8 ГБ памяти для построений. Доступно только для типа среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER .
  • BUILD_LAMBDA_10GB : Используйте до 10 ГБ памяти для построений. Доступно только для типа среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER .

Если вы используете BUILD_GENERAL1_SMALL :

  • Для типа среды LINUX_CONTAINER вы можете использовать до 4 ГБ памяти и 2 vCPU для построений.
  • Для типа среды LINUX_GPU_CONTAINER вы можете использовать до 16 ГБ памяти, 4 vCPU и 1 NVIDIA A10G Tensor Core GPU для построений.
  • Для типа среды ARM_CONTAINER вы можете использовать до 4 ГБ памяти и 2 vCPU на процессорах на базе ARM для построений.

Если вы используете BUILD_GENERAL1_LARGE :

  • Для типа среды LINUX_CONTAINER вы можете использовать до 16 ГБ памяти и 8 vCPU для построений.
  • Для типа среды LINUX_GPU_CONTAINER вы можете использовать до 255 ГБ памяти, 32 vCPU и 4 NVIDIA Tesla V100 GPU для построений.
  • Для типа среды ARM_CONTAINER вы можете использовать до 16 ГБ памяти и 8 vCPU на процессорах на базе ARM для построений.

Для получения дополнительной информации см. Типы сред по требованию в Руководстве пользователя CodeBuild.

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

Конфигурация вычислений проекта построения. Это необходимо только если computeType установлено в ATTRIBUTE_BASED_COMPUTE .

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

Количество vCPU типа экземпляра, включенного в ваш флот.

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

Объем памяти типа экземпляра, включенного в ваш флот.

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

Объем дискового пространства типа экземпляра, включенного в ваш флот.

machineType -> (строка)

Тип машины типа экземпляра, включенного в ваш флот.

instanceType -> (строка)

Тип EC2-экземпляра, который будет запущен в вашем флоте.

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

Объект ProjectFleet для использования в этом проекте построения.

fleetArn -> (строка)

Указывает ARN вычислительного флота для проекта построения.

environmentVariables -> (список)

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

(структура)

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

name -> (строка)

Имя или ключ переменной среды.

value -> (строка)

Значение переменной среды.

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

Мы настоятельно не рекомендуем использовать PLAINTEXT переменные среды для хранения конфиденциальных значений, особенно идентификаторов секретных ключей Amazon Web Services. PLAINTEXT переменные среды могут отображаться в текстовом формате в консоли CodeBuild и с помощью командной строки. Для конфиденциальных значений мы рекомендуем использовать переменную среды типа PARAMETER_STORE или SECRETS_MANAGER .

type -> (строка)

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

  • PARAMETER_STORE : Переменная среды, хранящаяся в хранилище параметров Systems Manager. Для переменных среды этого типа укажите имя параметра как value переменной EnvironmentVariable. Значение параметра будет заменено именем во время выполнения. Вы также можете определять переменные среды Parameter Store в buildspec. Чтобы узнать как, см. env/parameter-store в Руководстве пользователя CodeBuild .
  • PLAINTEXT : Переменная среды в формате обычного текста. Это значение по умолчанию.
  • SECRETS_MANAGER : Переменная среды, хранящаяся в Secrets Manager. Для переменных среды этого типа укажите имя секрета как value переменной EnvironmentVariable. Значение секрета будет заменено именем во время выполнения. Вы также можете определять переменные среды Secrets Manager в buildspec. Чтобы узнать как, см. env/secrets-manager в Руководстве пользователя CodeBuild .

privilegedMode -> (булево)

Включает запуск Docker-демонов внутри Docker-контейнера. Установите в значение true только если проект построения используется для построения Docker-образов. В противном случае построение, пытающееся взаимодействовать с Docker-демоном, завершается ошибкой. Значение по умолчанию - false .

Вы можете инициализировать Docker-демон во время фазы установки вашего построения, добавив один из следующих наборов команд в фазу установки вашего файла buildspec:

Если базовый образ операционной системы - Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

Если базовый образ операционной системы - Alpine Linux и предыдущая команда не работает, добавьте аргумент -t к timeout :

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

certificate -> (строка)

ARN Amazon S3-бакета, префикса пути и имени объекта, содержащего PEM-закодированный сертификат для проекта построения. Для получения дополнительной информации см. certificate в Руководстве пользователя CodeBuild .

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

Учетные данные для доступа к частному репозиторию.

credential -> (строка)

Amazon Resource Name (ARN) или имя учетных данных, созданных с помощью Secrets Manager.

Примечание

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

credentialProvider -> (строка)

Служба, создавшая учетные данные для доступа к частному Docker-репозиторию. Действительное значение SECRETS_MANAGER относится к Secrets Manager.

imagePullCredentialsType -> (строка)

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

  • CODEBUILD указывает, что CodeBuild использует собственные учетные данные. Это требует изменения политики вашего репозитория ECR для доверия сервисному принципалу CodeBuild.
  • SERVICE_ROLE указывает, что CodeBuild использует служебную роль вашего проекта построения.

При использовании образа из другого аккаунта или частного репозитория необходимо использовать учетные данные SERVICE_ROLE. При использовании образа CodeBuild, выпущенного компанией, необходимо использовать учетные данные CODEBUILD.

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

Объект DockerServer для использования в этом проекте построения.

computeType -> (строка)

Информация о вычислительных ресурсах, используемых docker-сервером. Доступные значения включают:

  • BUILD_GENERAL1_SMALL : Используйте до 4 ГБ памяти и 2 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_MEDIUM : Используйте до 8 ГБ памяти и 4 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_LARGE : Используйте до 16 ГБ памяти и 8 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_XLARGE : Используйте до 64 ГБ памяти и 32 vCPU для вашего docker-сервера.
  • BUILD_GENERAL1_2XLARGE : Используйте до 128 ГБ памяти и 64 vCPU для вашего docker-сервера.

securityGroupIds -> (список)

Список одного или нескольких идентификаторов групп безопасности.

Примечание

Конфигурированные для Docker-серверов группы безопасности должны разрешать входящий сетевой трафик из VPC, настроенного в проекте. Они должны разрешать входящий трафик на порт 9876.

(строка)

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

Объект DockerServerStatus для использования для этого docker-сервера.

status -> (строка)

Статус docker-сервера.

message -> (строка)

Сообщение, связанное со статусом docker-сервера.

serviceRole -> (строка)

Имя служебной роли, используемой для этого построения.

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

Информация о журналах сборки в CloudWatch Logs.

groupName -> (string)

Имя группы CloudWatch Logs для журналов сборки.

streamName -> (string)

Имя потока CloudWatch Logs для журналов сборки.

deepLink -> (string)

URL отдельного журнала сборки в CloudWatch Logs. Поток журнала создаётся во время фазы PROVISIONING сборки, и deeplink будет действителен только после его создания.

s3DeepLink -> (string)

URL журнала сборки в ведре S3.

cloudWatchLogsArn -> (string)

ARN потока CloudWatch Logs для выполнения сборки. Его формат: arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName} . Поток CloudWatch Logs создаётся во время фазы PROVISIONING сборки, и ARN будет действителен только после его создания. Дополнительную информацию см. в разделе Ресурсы, определённые CloudWatch Logs.

s3LogsArn -> (string)

ARN журналов S3 для проекта сборки. Его формат: arn:${Partition}:s3:::${BucketName}/${ObjectName} . Дополнительную информацию см. в разделе Ресурсы, определённые Amazon S3.

cloudWatchLogs -> (structure)

Информация о CloudWatch Logs для проекта сборки.

status -> (string)

Текущий статус журналов в CloudWatch Logs для проекта сборки. Допустимые значения:

  • ENABLED : CloudWatch Logs включены для этого проекта сборки.
  • DISABLED : CloudWatch Logs не включены для этого проекта сборки.

groupName -> (string)

Имя группы журналов в CloudWatch Logs. Дополнительную информацию см. в разделе Работа с группами и потоками журналов.

streamName -> (string)

Префикс имени потока CloudWatch Logs. Дополнительную информацию см. в разделе Работа с группами и потоками журналов.

s3Logs -> (structure)

Информация о журналах S3 для проекта сборки.

status -> (string)

Текущий статус журналов сборки в S3. Допустимые значения:

  • ENABLED : Журналы сборки S3 включены для этого проекта сборки.
  • DISABLED : Журналы сборки S3 не включены для этого проекта сборки.

location -> (string)

ARN ведра S3 и префикс пути для журналов S3. Если имя вашего ведра Amazon S3 — my-bucket, а префикс пути — build-log, то допустимые форматы — my-bucket/build-log или arn:aws:s3:::my-bucket/build-log.

encryptionDisabled -> (boolean)

Устанавливается в значение true, если вы не хотите шифровать вывод журналов сборки в S3. По умолчанию журналы сборки в S3 шифруются.

bucketOwnerAccess -> (string)

Указывает доступ владельца ведра для объектов, загруженных в ведро Amazon S3 другим аккаунтом. По умолчанию доступ к этим объектам имеет только аккаунт, который загрузил эти объекты в ведро. Это свойство позволяет предоставить доступ к этим объектам владельцу ведра.

Примечание

Для использования этого свойства ваша роль службы CodeBuild должна иметь разрешение s3:PutBucketAcl. Это разрешение позволяет CodeBuild изменять список управления доступом для ведра.

Это свойство может иметь одно из следующих значений:

NONE

Владелец ведра не имеет доступа к объектам. Это значение по умолчанию.

READ_ONLY

Владелец ведра имеет доступ для чтения к объектам. Загружающий аккаунт сохраняет владение объектами.

FULL

Владелец ведра имеет полный доступ к объектам. Владение объектами определяется следующими критериями:

  • Если ведро настроено с параметром Предпочтительный владелец ведра, владелец ведра владеет объектами. Загружающий аккаунт будет иметь доступ к объектам в соответствии с политикой ведра.
  • В противном случае загружающий аккаунт сохраняет владение объектами.

Дополнительную информацию о владении объектами Amazon S3 см. в разделе Управление владением загруженными объектами с помощью владения объектами S3 в руководстве Amazon Simple Storage Service User Guide.

timeoutInMinutes -> (integer)

Время в минутах (от 5 до 2160, 36 часов), которое CodeBuild ждёт, прежде чем завершить сборку из-за истечения времени, если она не отмечена как завершённая.

queuedTimeoutInMinutes -> (integer)

Количество минут, в течение которого сборка может ожидать в очереди, прежде чем истечёт время ожидания.

buildComplete -> (boolean)

Завершена ли сборка. True, если завершена; иначе false.

initiator -> (string)

Сущность, которая запустила сборку. Допустимые значения:

  • Если сборку запустил CodePipeline, имя пайплайна (например, codepipeline/my-demo-pipeline).
  • Если сборку запустил пользователь, имя пользователя (например, MyUserName).
  • Если сборку запустил плагин Jenkins для CodeBuild, строка CodeBuild-Jenkins-Plugin.

vpcConfig -> (structure)

Если ваш проект CodeBuild обращается к ресурсам в Amazon VPC, вы предоставляете этот параметр, который идентифицирует ID VPC и список идентификаторов сетевых групп и подсетей. Сетевые группы и подсети должны принадлежать к одному VPC. Вы должны указать как минимум один идентификатор сетевой группы и один идентификатор подсети.

vpcId -> (string)

Идентификатор Amazon VPC.

subnets -> (list)

Список одного или нескольких идентификаторов подсетей в вашей Amazon VPC.

(string)

securityGroupIds -> (list)

Список одного или нескольких идентификаторов сетевых групп в вашей Amazon VPC.

(string)

networkInterface -> (structure)

Описывает сетевой интерфейс.

subnetId -> (string)

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

networkInterfaceId -> (string)

Идентификатор сетевого интерфейса.

encryptionKey -> (string)

Ключ управления ключами (CMK) службы Key Management Service, используемый для шифрования выходных артефактов сборки.

Примечание

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

Можно указать либо Amazon Resource Name (ARN) CMK, либо, если доступно, псевдоним CMK (в формате alias/<alias-name>).

exportedEnvironmentVariables -> (list)

Список экспортированных переменных среды для этой сборки.

Экспортированные переменные среды используются совместно с CodePipeline для экспорта переменных среды из текущей стадии сборки в последующие стадии пайплайна. Дополнительную информацию см. в разделе Работа с переменными в руководстве CodePipeline User Guide.

(structure)

Содержит информацию об экспортированной переменной среды.

Экспортированные переменные среды используются совместно с CodePipeline для экспорта переменных среды из текущей стадии сборки в последующие стадии пайплайна. Дополнительную информацию см. в разделе Работа с переменными в руководстве CodePipeline User Guide.

Примечание

Во время сборки значение переменной доступно, начиная с фазы install. Оно может быть обновлено между началом фазы install и концом фазы post_build. После завершения фазы post_build значение экспортированных переменных больше не может меняться.

name -> (string)

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

value -> (string)

Значение, назначенное экспортированной переменной среды.

reportArns -> (list)

Массив ARNs, связанных с отчётами этой сборки.

(string)

fileSystemLocations -> (list)

Массив объектов ProjectFileSystemLocation для проекта сборки CodeBuild. Объект ProjectFileSystemLocation указывает identifier, location, mountOptions, mountPoint и type файловой системы, созданной с помощью Amazon Elastic File System.

(structure)

Информация о файловой системе, созданной с помощью Amazon Elastic File System (EFS). Дополнительную информацию см. в разделе Что такое Amazon Elastic File System?

type -> (string)

Тип файловой системы. Поддерживается только тип EFS.

location -> (string)

Строка, определяющая расположение файловой системы, созданной с помощью Amazon EFS. Его формат: efs-dns-name:/directory-path. Вы можете найти DNS-имя файловой системы, просмотрев её в консоли Amazon EFS. Путь к каталогу — это путь к каталогу в файловой системе, который монтирует CodeBuild. Например, если DNS-имя файловой системы — fs-abcd1234.efs.us-west-2.amazonaws.com, а её каталог для монтирования — my-efs-mount-directory, то location — fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

Путь к каталогу в формате efs-dns-name:/directory-path необязателен. Если вы не указываете путь к каталогу, расположением является только DNS-имя, и CodeBuild монтирует всю файловую систему.

mountPoint -> (string)

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

identifier -> (string)

Имя, используемое для доступа к файловой системе, созданной с помощью Amazon EFS. CodeBuild создаёт переменную среды, добавляя identifier в верхнем регистре к CODEBUILD_. Например, если вы укажете my_efs для identifier, будет создана новая переменная среды с именем CODEBUILD_MY_EFS.

identifier используется для монтирования вашей файловой системы.

mountOptions -> (string)

Параметры монтирования для файловой системы, созданной с помощью Amazon EFS. По умолчанию CodeBuild использует параметры монтирования nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. Дополнительную информацию см. в разделе Рекомендуемые параметры монтирования NFS.

debugSession -> (structure)

Содержит информацию о сеансе отладки для этой сборки.

sessionEnabled -> (boolean)

Указывает, включена ли отладка сеанса для этой сборки.

sessionTarget -> (string)

Содержит идентификатор сеанса Session Manager, используемого для сборки. Чтобы работать с приостановленной сборкой, откройте этот сеанс для просмотра, управления и возобновления сборки.

buildBatchArn -> (string)

ARN пакета сборок, членом которого является эта сборка, применимо.

autoRetryConfig -> (structure)

Информация об автоматической настройке повторных попыток для сборки.

autoRetryLimit -> (integer)

Максимальное количество дополнительных автоматических повторных попыток после неудачной сборки. Например, если предел автоматических повторных попыток установлен в 2, CodeBuild будет вызывать API RetryBuild для автоматической повторной попытки вашей сборки до 2 дополнительных раз.

autoRetryNumber -> (integer)

Количество раз, когда сборка была повторно запущена. Изначальная сборка будет иметь номер автоматической повторной попытки 0.

nextAutoRetry -> (string)

ARN сборки повторной попытки, запущенной текущей сборкой. Следующая автоматическая повторная попытка будет null для сборок, которые не запускают автоматическую повторную попытку.

previousAutoRetry -> (string)

ARN сборки, которая вызвала текущую сборку повторной попытки. Предыдущая автоматическая повторная попытка будет null для начальной сборки.

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

Spec-Zone.ru

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