retry-build

Описание

Перезапускает сборку.

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

Синтаксис

  retry-build
[--id <value>]
[--idempotency-token <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 (строка)

Указывает идентификатор сборки для перезапуска.

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

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

--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
таблица
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.

Примеры

Примечание

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

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

Для перезапуска не удавшейся сборки в AWS CodeBuild.

Следующий пример перезапускает указанную сборку.

aws codebuild retry-build \
    --id <project-name>:<build-ID>

Вывод:

{
    "build": {
        "id": "<project-name>:<build-ID>",
        "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
        "buildNumber": 9,
        "startTime": "2020-10-21T17:51:38.161000+00:00",
        "currentPhase": "QUEUED",
        "buildStatus": "IN_PROGRESS",
        "projectName": "<project-name>",
        "phases": [
            {
                "phaseType": "SUBMITTED",
                "phaseStatus": "SUCCEEDED",
                "startTime": "2020-10-21T17:51:38.161000+00:00",
                "endTime": "2020-10-21T17:51:38.210000+00:00",
                "durationInSeconds": 0
            },
            {
                "phaseType": "QUEUED",
                "startTime": "2020-10-21T17:51:38.210000+00:00"
            }
        ],
        "source": {
            "type": "GITHUB",
            "location": "<GitHub-repo-URL>",
            "gitCloneDepth": 1,
            "gitSubmodulesConfig": {
                "fetchSubmodules": false
            },
            "reportBuildStatus": false,
            "insecureSsl": false
        },
        "secondarySources": [],
        "secondarySourceVersions": [],
        "artifacts": {
            "location": ""
        },
        "secondaryArtifacts": [],
        "cache": {
            "type": "NO_CACHE"
        },
        "environment": {
            "type": "LINUX_CONTAINER",
            "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
            "computeType": "BUILD_GENERAL1_SMALL",
            "environmentVariables": [],
            "privilegedMode": false,
            "imagePullCredentialsType": "CODEBUILD"
        },
        "serviceRole": "arn:aws:iam::<account-ID>:role/service-role/<service-role-name>",
        "logs": {
            "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=<region-ID>#logEvent:group=null;stream=null",
            "cloudWatchLogsArn": "arn:aws:logs:<region-ID>:<account-ID>:log-group:null:log-stream:null",
            "cloudWatchLogs": {
                "status": "ENABLED"
            },
            "s3Logs": {
                "status": "DISABLED",
                "encryptionDisabled": false
            }
        },
        "timeoutInMinutes": 60,
        "queuedTimeoutInMinutes": 480,
        "buildComplete": false,
        "initiator": "<username>",
        "encryptionKey": "arn:aws:kms:<region-ID>:<account-ID>:alias/aws/s3"
    }
}

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

Вывод

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

Информация о сборке.

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 — ID коммита.
Для 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 Авторизовать приложение, для Доступа к организации выберите Запросить доступ рядом с каждым репозиторием, которому вы хотите разрешить CodeBuild иметь доступ, а затем выберите Авторизовать приложение. (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth для type в OAUTH.
Для исходного кода в репозитории GitLab или самообслуживаемом репозитории GitLab, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При использовании консоли для подключения (или повторного подключения) к GitLab на странице Подключения Авторизовать приложение выберите Авторизовать. Затем на странице CodeConnections Создать подключение GitLab выберите Подключиться к GitLab. (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild переопределить значение по умолчанию и использовать это подключение вместо него, установите значение объекта auth для type в CODECONNECTIONS в объекте source.
Для исходного кода в репозитории Bitbucket, HTTPS-URL для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При использовании консоли для подключения (или повторного подключения) к Bitbucket на странице Bitbucket Подтвердите доступ к вашей учетной записи выберите Предоставить доступ. (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth для type в 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 или Bitbucket в качестве вашего поставщика источника. Если он установлен, а вы используете другого поставщика, возникает invalidInputException.

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

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

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

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

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

context -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

Этот параметр используется для параметра url в статусе коммита Bitbucket. Дополнительная информация: build в документации 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-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, на странице Авторизовать приложение , для Доступ к организации выберите Запросить доступ рядом с каждым репозиторием, которому вы хотите разрешить CodeBuild иметь доступ, а затем выберите Авторизовать приложение . (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение объекта auth в OAUTH.
Для исходного кода в репозитории GitLab или репозитории GitLab с самостоятельным управлением, HTTPS-URL клонирования репозитория, содержащего исходный и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitLab на странице подключений Авторизовать приложение выберите Авторизовать . Затем на странице Создать подключение GitLab выберите Подключиться к GitLab . (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение объекта type в CODECONNECTIONS в объекте source.
Для исходного кода в репозитории Bitbucket, HTTPS-URL клонирования репозитория, содержащего исходный и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к Bitbucket на странице Bitbucket Подтвердить доступ к вашей учетной записи выберите Предоставить доступ . (После подключения к вашей учетной записи 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 для доступа к исходному коду, который необходимо собрать.

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

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

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

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

reportBuildStatus -> (булево)

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

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

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

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

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

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

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

Указывает контекст статуса сборки, который 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 символов в длину.

secondarySourceVersions -> (список)

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

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

(структура)

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

sourceIdentifier -> (строка)

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

sourceVersion -> (строка)

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

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

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

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

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

location -> (строка)

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

sha256sum -> (строка)

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

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

Примечание

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

md5sum -> (строка)

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

Примечание

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

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

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

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 -> (логическое значение)

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

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

artifactIdentifier -> (строка)

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

bucketOwnerAccess -> (строка)

Примечание

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

NONE

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

READ_ONLY

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

FULL

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

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

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 -> (строка)

Определяет область действия кэша. Вы можете использовать этот пространство имен для совместного использования кэша между несколькими проектами. Дополнительную информацию см. в разделе «Совместное использование кэша между проектами» в Руководстве пользователя 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 и с помощью CLI. Для конфиденциальных значений мы рекомендуем использовать переменную среды типа PARAMETER_STORE или SECRETS_MANAGER.

type -> (строка)

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

PARAMETER_STORE : Переменная среды, хранящаяся в хранилище параметров Systems Manager. Для переменных среды этого типа укажите имя параметра как value переменной EnvironmentVariable. Значение параметра будет заменено именем во время выполнения. Вы также можете определить переменные среды хранилища параметров в 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 -> (строка)

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

streamName -> (строка)

Название потока CloudWatch Logs для журналов сборки.

deepLink -> (строка)

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

s3DeepLink -> (строка)

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

cloudWatchLogsArn -> (строка)

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

s3LogsArn -> (строка)

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

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

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

status -> (строка)

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

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

groupName -> (строка)

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

streamName -> (строка)

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

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

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

status -> (строка)

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

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

location -> (строка)

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

encryptionDisabled -> (булево)

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

bucketOwnerAccess -> (строка)

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

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

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

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

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

buildComplete -> (булево)

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

initiator -> (строка)

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

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

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

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

vpcId -> (строка)

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

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

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

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

subnetId -> (строка)

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

networkInterfaceId -> (строка)

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

encryptionKey -> (строка)

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

Примечание

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

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

exportedEnvironmentVariables -> (список)

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

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

(структура)

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

Примечание

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

name -> (строка)

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

value -> (строка)

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

reportArns -> (список)

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

(строка)

fileSystemLocations -> (список)

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

(структура)

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

type -> (строка)

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

location -> (строка)

Строка, которая указывает расположение файловой системы, созданной 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 -> (строка)

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

identifier -> (строка)

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

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

mountOptions -> (строка)

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

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

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

sessionEnabled -> (булево)

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

sessionTarget -> (строка)

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

buildBatchArn -> (строка)

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

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

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

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

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

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

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

nextAutoRetry -> (строка)

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

previousAutoRetry -> (строка)

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