batch-get-builds

Описание

Получение информации об одном или нескольких сборках.

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

Синтаксис

  batch-get-builds
--ids <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]

Параметры

--ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, заданному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретирована буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При предоставлении значения output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое)

Включить отладовую запись журнала.

--endpoint-url (строка)

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

--no-verify-ssl (логическое)

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

--no-paginate (логическое)

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

--output (строка)

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

json
текст
таблица
yaml
yaml-потоковый

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

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

включено
выключено
автоматически

--no-sign-request (логическое)

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

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставляемого с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Примеры

Примечание

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

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

Для просмотра деталей сборок в AWS CodeBuild.

Следующий batch-get-builds пример получает информацию о сборках в CodeBuild с указанными идентификаторами.

aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE

Вывод:

{
    "buildsNotFound": [],
    "builds": [
        {
            "artifacts": {
                "md5sum": "0e95edf915048a0c22efe6d139fff837",
                "location": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/BuildArtif/6DJsqQa",
                "encryptionDisabled": false,
                "sha256sum": "cfa0df33a090966a737f64ae4fe498969fdc842a0c9aec540bf93c37ac0d05a2"
            },
            "logs": {
                "cloudWatchLogs": {
                    "status": "ENABLED"
                },
                "s3Logs": {
                    "status": "DISABLED"
                },
                "streamName": "46472baf-8f6b-43c2-9255-b3b963af2732",
                "groupName": "/aws/codebuild/codebuild-demo-project",
                "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=46472baf-8f6b-43c2-9255-b3b963af2732"
            },
            "timeoutInMinutes": 60,
            "environment": {
                "privilegedMode": false,
                "computeType": "BUILD_GENERAL1_MEDIUM",
                "image": "aws/codebuild/windows-base:1.0",
                "environmentVariables": [],
                "type": "WINDOWS_CONTAINER"
            },
            "projectName": "codebuild-demo-project",
            "buildComplete": true,
            "source": {
                "gitCloneDepth": 1,
                "insecureSsl": false,
                "type": "CODEPIPELINE"
            },
            "buildStatus": "SUCCEEDED",
            "secondaryArtifacts": [],
            "phases": [
                {
                    "durationInSeconds": 0,
                    "startTime": 1548717462.122,
                    "phaseType": "SUBMITTED",
                    "endTime": 1548717462.484,
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "startTime": 1548717462.484,
                    "phaseType": "QUEUED",
                    "endTime": 1548717462.775,
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 34,
                    "endTime": 1548717496.909,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717462.775,
                    "phaseType": "PROVISIONING",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 15,
                    "endTime": 1548717512.555,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717496.909,
                    "phaseType": "DOWNLOAD_SOURCE",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "endTime": 1548717512.734,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717512.555,
                    "phaseType": "INSTALL",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "endTime": 1548717512.924,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717512.734,
                    "phaseType": "PRE_BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 9,
                    "endTime": 1548717522.254,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717512.924,
                    "phaseType": "BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 3,
                    "endTime": 1548717525.498,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717522.254,
                    "phaseType": "POST_BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 9,
                    "endTime": 1548717534.646,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717525.498,
                    "phaseType": "UPLOAD_ARTIFACTS",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 2,
                    "endTime": 1548717536.846,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548717534.646,
                    "phaseType": "FINALIZING",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "startTime": 1548717536.846,
                    "phaseType": "COMPLETED"
                }
            ],
            "startTime": 1548717462.122,
            "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
            "initiator": "codepipeline/CodeBuild-Pipeline",
            "secondarySources": [],
            "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
            "currentPhase": "COMPLETED",
            "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
            "cache": {
                "type": "NO_CACHE"
            },
            "sourceVersion": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/SourceArti/1TspnN3.zip",
            "endTime": 1548717536.846,
            "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
            "queuedTimeoutInMinutes": 480,
            "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b"
        },
        {
            "artifacts": {
                "md5sum": "",
                "overrideArtifactName": false,
                "location": "arn:aws:s3:::my-artifacts/codebuild-demo-project",
                "encryptionDisabled": false,
                "sha256sum": ""
            },
            "logs": {
                "cloudWatchLogs": {
                    "status": "ENABLED"
                },
                "s3Logs": {
                    "status": "DISABLED"
                },
                "streamName": "4dea3ca4-20ec-4898-b22a-a9eb9292775d",
                "groupName": "/aws/codebuild/codebuild-demo-project",
                "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=4dea3ca4-20ec-4898-b22a-a9eb9292775d"
            },
            "timeoutInMinutes": 60,
            "environment": {
                "privilegedMode": false,
                "computeType": "BUILD_GENERAL1_MEDIUM",
                "image": "aws/codebuild/windows-base:1.0",
                "environmentVariables": [],
                "type": "WINDOWS_CONTAINER"
            },
            "projectName": "codebuild-demo-project",
            "buildComplete": true,
            "source": {
                "gitCloneDepth": 1,
                "location": "https://github.com/my-repo/codebuild-demo-project.git",
                "insecureSsl": false,
                "reportBuildStatus": false,
                "type": "GITHUB"
            },
            "buildStatus": "SUCCEEDED",
            "secondaryArtifacts": [],
            "phases": [
                {
                    "durationInSeconds": 0,
                    "startTime": 1548716241.89,
                    "phaseType": "SUBMITTED",
                    "endTime": 1548716242.241,
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "startTime": 1548716242.241,
                    "phaseType": "QUEUED",
                    "endTime": 1548716242.536,
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 33,
                    "endTime": 1548716276.171,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716242.536,
                    "phaseType": "PROVISIONING",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 15,
                    "endTime": 1548716291.809,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716276.171,
                    "phaseType": "DOWNLOAD_SOURCE",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "endTime": 1548716291.993,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716291.809,
                    "phaseType": "INSTALL",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 0,
                    "endTime": 1548716292.191,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716291.993,
                    "phaseType": "PRE_BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 9,
                    "endTime": 1548716301.622,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716292.191,
                    "phaseType": "BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 3,
                    "endTime": 1548716304.783,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716301.622,
                    "phaseType": "POST_BUILD",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 8,
                    "endTime": 1548716313.775,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716304.783,
                    "phaseType": "UPLOAD_ARTIFACTS",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "durationInSeconds": 2,
                    "endTime": 1548716315.935,
                    "contexts": [
                        {
                            "statusCode": "",
                            "message": ""
                        }
                    ],
                    "startTime": 1548716313.775,
                    "phaseType": "FINALIZING",
                    "phaseStatus": "SUCCEEDED"
                },
                {
                    "startTime": 1548716315.935,
                    "phaseType": "COMPLETED"
                }
            ],
            "startTime": 1548716241.89,
            "secondarySourceVersions": [],
            "initiator": "my-codebuild-project",
            "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE",
            "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
            "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
            "currentPhase": "COMPLETED",
            "id": "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE",
            "cache": {
                "type": "NO_CACHE"
            },
            "endTime": 1548716315.935,
            "secondarySources": [],
            "queuedTimeoutInMinutes": 480,
            "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b"
        }
    ]
}

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

type -> (строка)

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

resource -> (строка)

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

reportBuildStatus -> (булево)

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

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

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

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

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 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 для доступа к исходному коду для сборки.

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

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

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

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

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

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

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

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

Если сборки вашего проекта запускаются через webhook, для изменения этого параметра необходимо выполнить 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: идентификатор коммита, ID pull request, имя ветки или имя тега, соответствующие версии исходного кода, которую вы хотите собрать. Если указан ID pull request, он должен иметь формат pr/pull-request-ID (например, pr/25). Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
Для Bitbucket: идентификатор коммита, имя ветки или имя тега, соответствующие версии исходного кода, которую вы хотите собрать. Если указано имя ветки, используется идентификатор коммита HEAD ветки. Если не указано, используется идентификатор коммита HEAD по умолчанию.
Для Amazon S3: идентификатор версии объекта, который представляет собой ZIP-архив с входными данными сборки.

(структура)

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

sourceIdentifier -> (строка)

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

sourceVersion -> (строка)

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

Для CodeCommit: идентификатор коммита, ветка или тег Git.
Для GitHub: идентификатор коммита, ID pull request, имя ветки или имя тега, соответствующие версии исходного кода, которую вы хотите собрать. Если указан ID pull request, он должен иметь формат 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, вычисляется во время сборки и использует язык командной оболочки. Например, вы можете добавлять дату и время к имени артефакта, чтобы оно всегда было уникальным.

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 для сборок.
Для типа среды ARM_CONTAINER вы можете использовать до 4 ГБ памяти и 2 vCPU на процессорах ARM для сборок.

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

Для типа среды LINUX_CONTAINER вы можете использовать до 16 ГБ памяти и 8 vCPU для сборок.
Для типа среды LINUX_GPU_CONTAINER вы можете использовать до 255 ГБ памяти, 32 vCPU и 4 графических процессора NVIDIA Tesla V100 для сборок.
Для типа среды 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 см. в руководстве пользователя 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, вы предоставляете этот параметр, определяющий ID VPC и список ID групп безопасности и ID подсетей. Группы безопасности и подсети должны принадлежать одному VPC. Вы должны указать как минимум одну группу безопасности и один ID подсети.

vpcId -> (строка)

ID Amazon VPC.

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

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

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

subnetId -> (строка)

ID подсети.

networkInterfaceId -> (строка)

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

encryptionKey -> (строка)

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

Примечание

Можно использовать межсчётный ключ 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). Дополнительную информацию см. в документе What Is 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 необязателен. Если вы не укажете путь к каталогу, location будет только 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 -> (целое число)

Количество раз, которое сборка перепробовалась.

nextAutoRetry -> (строка)

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

previousAutoRetry -> (строка)

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

buildsNotFound -> (список)

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

(строка)