Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

batch-get-build-batches

Описание

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

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

Синтаксис

  batch-get-build-batches
--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
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

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

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

aws codebuild batch-get-build-batches \
    --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE

Вывод:

{
    "buildBatches": [
        {
            "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
            "arn": "arn:aws:codebuild:us-west-2:123456789012:build-batch/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
            "startTime": "2020-11-03T21:52:20.775000+00:00",
            "endTime": "2020-11-03T21:56:59.784000+00:00",
            "currentPhase": "SUCCEEDED",
            "buildBatchStatus": "SUCCEEDED",
            "resolvedSourceVersion": "0a6546f68309560d08a310daac92314c4d378f6b",
            "projectName": "codebuild-demo-project",
            "phases": [
                {
                    "phaseType": "SUBMITTED",
                    "phaseStatus": "SUCCEEDED",
                    "startTime": "2020-11-03T21:52:20.775000+00:00",
                    "endTime": "2020-11-03T21:52:20.976000+00:00",
                    "durationInSeconds": 0
                },
                {
                    "phaseType": "DOWNLOAD_BATCHSPEC",
                    "phaseStatus": "SUCCEEDED",
                    "startTime": "2020-11-03T21:52:20.976000+00:00",
                    "endTime": "2020-11-03T21:52:57.401000+00:00",
                    "durationInSeconds": 36
                },
                {
                    "phaseType": "IN_PROGRESS",
                    "phaseStatus": "SUCCEEDED",
                    "startTime": "2020-11-03T21:52:57.401000+00:00",
                    "endTime": "2020-11-03T21:56:59.751000+00:00",
                    "durationInSeconds": 242
                },
                {
                    "phaseType": "COMBINE_ARTIFACTS",
                    "phaseStatus": "SUCCEEDED",
                    "startTime": "2020-11-03T21:56:59.751000+00:00",
                    "endTime": "2020-11-03T21:56:59.784000+00:00",
                    "durationInSeconds": 0
                },
                {
                    "phaseType": "SUCCEEDED",
                    "startTime": "2020-11-03T21:56:59.784000+00:00"
                }
            ],
            "source": {
                "type": "GITHUB",
                "location": "https://github.com/my-repo/codebuild-demo-project.git",
                "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"
            },
            "logConfig": {
                "cloudWatchLogs": {
                    "status": "ENABLED"
                },
                "s3Logs": {
                    "status": "DISABLED",
                    "encryptionDisabled": false
                }
            },
            "buildTimeoutInMinutes": 60,
            "queuedTimeoutInMinutes": 480,
            "complete": true,
            "initiator": "Strohm",
            "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
            "buildBatchNumber": 6,
            "buildBatchConfig": {
                "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-demo-project",
                "restrictions": {
                    "maximumBuildsAllowed": 100
                },
                "timeoutInMins": 480
            },
            "buildGroups": [
                {
                    "identifier": "DOWNLOAD_SOURCE",
                    "ignoreFailure": false,
                    "currentBuildSummary": {
                        "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:379737d8-bc35-48ec-97fd-776d27545315",
                        "requestedOn": "2020-11-03T21:52:21.394000+00:00",
                        "buildStatus": "SUCCEEDED",
                        "primaryArtifact": {
                            "type": "no_artifacts",
                            "identifier": "DOWNLOAD_SOURCE"
                        },
                        "secondaryArtifacts": []
                    }
                },
                {
                    "identifier": "linux_small",
                    "dependsOn": [],
                    "ignoreFailure": false,
                    "currentBuildSummary": {
                        "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:dd785171-ed84-4bb6-8ede-ceeb86e54bdb",
                        "requestedOn": "2020-11-03T21:52:57.604000+00:00",
                        "buildStatus": "SUCCEEDED",
                        "primaryArtifact": {
                            "type": "no_artifacts",
                            "identifier": "linux_small"
                        },
                        "secondaryArtifacts": []
                    }
                },
                {
                    "identifier": "linux_medium",
                    "dependsOn": [
                        "linux_small"
                    ],
                    "ignoreFailure": false,
                    "currentBuildSummary": {
                        "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:97cf7bd4-5313-4786-8243-4aef350a1267",
                        "requestedOn": "2020-11-03T21:54:18.474000+00:00",
                        "buildStatus": "SUCCEEDED",
                        "primaryArtifact": {
                            "type": "no_artifacts",
                            "identifier": "linux_medium"
                        },
                        "secondaryArtifacts": []
                    }
                },
                {
                    "identifier": "linux_large",
                    "dependsOn": [
                        "linux_medium"
                    ],
                    "ignoreFailure": false,
                    "currentBuildSummary": {
                        "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:60a194cd-0d03-4337-9db1-d41476a17d27",
                        "requestedOn": "2020-11-03T21:55:39.203000+00:00",
                        "buildStatus": "SUCCEEDED",
                        "primaryArtifact": {
                            "type": "no_artifacts",
                            "identifier": "linux_large"
                        },
                        "secondaryArtifacts": []
                    }
                }
            ]
        }
    ],
    "buildBatchesNotFound": []
}

Дополнительную информацию см. в разделе «Пакетные сборки в AWS CodeBuild <https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html>» в руководстве пользователя AWS CodeBuild.

Вывод

buildBatches -> (список)

Массив объектов BuildBatch, представляющих полученные пакетные сборки.

(структура)

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

id -> (строка)

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

arn -> (строка)

ARN пакетной сборки.

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

Дата и время начала пакетной сборки.

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

Дата и время завершения пакетной сборки.

currentPhase -> (строка)

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

buildBatchStatus -> (строка)

Статус пакетной сборки.

sourceVersion -> (строка)

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

resolvedSourceVersion -> (строка)

Идентификатор разрешенной версии исходного кода этой пакетной сборки.

  • Для CodeCommit, GitHub, GitHub Enterprise и BitBucket — ID коммита.
  • Для CodePipeline — ревизия источника, предоставленная CodePipeline.
  • Для Amazon S3 — не применяется.

projectName -> (строка)

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

phases -> (список)

Массив объектов BuildBatchPhase, определяющих фазы пакетной сборки.

(структура)

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

phaseType -> (строка)

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

COMBINE_ARTIFACTS

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

DOWNLOAD_BATCHSPEC

Спецификация пакетной сборки загружается.

FAILED

Одна или несколько сборок завершились ошибкой.

IN_PROGRESS

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

STOPPED

Пакетная сборка была остановлена.

SUBMITTED

Пакетная сборка отправлена.

SUCCEEDED

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

phaseStatus -> (строка)

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

FAILED

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

FAULT

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

IN_PROGRESS

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

STOPPED

Фаза сборки остановлена.

SUCCEEDED

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

TIMED_OUT

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

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

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

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

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

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

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

contexts -> (список)

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

(структура)

Дополнительная информация о фазе сборки с ошибкой. Это может быть полезно для отладки.

statusCode -> (строка)

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

message -> (строка)

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

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 Self Managed, GitLab, GitLab Self Managed или Bitbucket в качестве поставщика исходного кода. Если это значение установлено, и вы используете другой поставщик исходного кода, возникает invalidInputException.

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

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

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

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

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

context -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

secondarySources -> (список)

Массив объектов ProjectSource, определяющих источники для пакетной сборки.

(структура)

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

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 Authorize application, для Organization access выберите Request access рядом с каждым репозиторием, которому вы хотите предоставить доступ CodeBuild, а затем выберите Authorize application . (После подключения к вашей учетной записи GitHub вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение поля auth объекта type на OAUTH .
  • Для исходного кода в репозитории GitLab или самообслуживаемом репозитории GitLab — HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи GitLab. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к GitLab в окне Connections Authorize application выберите Authorize. Затем в окне CodeConnections Create GitLab connection выберите Connect to GitLab . (После подключения к вашей учетной записи GitLab вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild переопределить стандартное подключение и использовать это подключение вместо него, установите значение поля type объекта auth на значение CODECONNECTIONS в объекте source.
  • Для исходного кода в репозитории Bitbucket — HTTPS-ссылка для клонирования репозитория, содержащего исходный код и файл buildspec. Необходимо подключить вашу учетную запись Amazon Web Services к вашей учетной записи Bitbucket. Используйте консоль CodeBuild для начала создания проекта сборки. При подключении (или повторном подключении) к Bitbucket в окне Bitbucket Confirm access to your account выберите Grant access. (После подключения к вашей учетной записи Bitbucket вам не нужно завершать создание проекта сборки. Вы можете выйти из консоли CodeBuild.) Чтобы указать CodeBuild использовать это подключение, в объекте source установите значение поля type объекта auth на OAUTH.

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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

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

type -> (строка)

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

resource -> (строка)

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

reportBuildStatus -> (булево)

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

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

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

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

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

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

context -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

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

Объект BuildArtifacts, определяющий артефакты сборки для этой пакетной сборки.

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

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

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

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

secondaryArtifacts -> (список)

Массив объектов BuildArtifacts, определяющих артефакты сборки для этой пакетной сборки.

(структура)

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

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

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

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

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

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

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

type -> (строка)

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

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

location -> (строка)

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

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

modes -> (список)

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

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

LOCAL_SOURCE_CACHE

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

LOCAL_DOCKER_LAYER_CACHE

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

Примечание

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

LOCAL_CUSTOM_CACHE

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

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

(строка)

cacheNamespace -> (строка)

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

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

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

type -> (string)

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

Примечание

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

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

image -> (string)

Тег или дайджест изображения, определяющие 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 -> (string)

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

  • 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 -> (structure)

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

vCpu -> (long)

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

memory -> (long)

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

disk -> (long)

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

machineType -> (string)

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

instanceType -> (string)

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

fleet -> (structure)

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

fleetArn -> (string)

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

environmentVariables -> (list)

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

(structure)

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

name -> (string)

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

value -> (string)

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

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

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

type -> (string)

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

  • 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 -> (boolean)

Включает запуск 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 -> (string)

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

registryCredential -> (structure)

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

credential -> (string)

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

Примечание

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

credentialProvider -> (string)

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

imagePullCredentialsType -> (string)

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

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

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

dockerServer -> (structure)

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

computeType -> (string)

Информация о вычислительных ресурсах, которые использует 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 -> (list)

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

Примечание

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

(string)

status -> (structure)

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

status -> (string)

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

message -> (string)

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

serviceRole -> (string)

Имя сервисной роли, используемой для сборок в пакетной обработке.

logConfig -> (structure)

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

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

Информация о журналах CloudWatch Logs для проекта сборки. CloudWatch Logs включены по умолчанию.

status -> (строка)

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

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

groupName -> (строка)

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

streamName -> (строка)

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

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

Информация о журналах, созданных в ведре S3 для проекта сборки. Журналы 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

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

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

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

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

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

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

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

complete -> (булево)

Указывает, завершена ли пакетная сборка.

initiator -> (строка)

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

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

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

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

vpcId -> (строка)

ID Amazon VPC.

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

encryptionKey -> (строка)

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

Примечание

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

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

buildBatchNumber -> (длинное целое число)

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

fileSystemLocations -> (список)

Массив объектов ProjectFileSystemLocation для проекта пакетной сборки. Объект 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.

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

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

serviceRole -> (строка)

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

combineArtifacts -> (булево)

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

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

Объект BatchRestrictions, который указывает ограничения для пакетной сборки.

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

Указывает максимальное количество разрешенных сборок.

computeTypesAllowed -> (список)

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

(строка)

fleetsAllowed -> (список)

Массив строк, указывающих флоты, разрешенные для пакетной сборки. См. Выполнение сборок на выделенных флотах резервируемой емкости в Руководстве пользователя CodeBuild для получения дополнительной информации.

(строка)

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

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

batchReportMode -> (строка)

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

REPORT_AGGREGATED_BATCH

(По умолчанию) Объединить все статусы сборки в один отчет о статусе.

REPORT_INDIVIDUAL_BUILDS

Отправить отдельный отчет о статусе для каждой отдельной сборки.

buildGroups -> (список)

Массив объектов BuildGroup, определяющих группы сборки для пакетной сборки.

(структура)

Содержит информацию о группе сборки пакетной сборки. Группы сборок используются для объединения сборок, которые могут выполняться параллельно, при этом сохраняя возможность устанавливать зависимости от других групп сборок.

identifier -> (строка)

Содержит идентификатор группы сборки.

dependsOn -> (список)

Массив строк, содержащих идентификаторы групп сборок, от которых зависит эта группа сборки.

(строка)

ignoreFailure -> (булево)

Указывает, можно ли игнорировать ошибки в этой группе сборки.

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

Объект BuildSummary, содержащий сводку текущей группы сборки.

arn -> (строка)

ARN пакетной сборки.

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

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

buildStatus -> (строка)

Статус группы сборки.

FAILED

Группа сборки завершилась ошибкой.

FAULT

Группа сборки прервана с ошибкой.

IN_PROGRESS

Группа сборки всё ещё в процессе.

STOPPED

Группа сборки остановлена.

SUCCEEDED

Группа сборки успешно завершена.

TIMED_OUT

Группа сборки превысила лимит времени.

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

Объект ResolvedArtifact, представляющий основные артефакты сборки для группы сборки.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

secondaryArtifacts -> (список)

Массив объектов ResolvedArtifact, представляющих вторичные артефакты сборки для группы сборки.

(структура)

Представляет разрешённый артефакт сборки. Разрешённый артефакт — это артефакт, который собран и развернут в пункт назначения, такой как Amazon S3.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

priorBuildSummaryList -> (список)

Массив объектов BuildSummary, содержащих сводки предыдущих групп сборок.

(структура)

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

arn -> (строка)

ARN пакетной сборки.

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

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

buildStatus -> (строка)

Статус группы сборки.

FAILED

Группа сборки завершилась ошибкой.

FAULT

Группа сборки прервана с ошибкой.

IN_PROGRESS

Группа сборки всё ещё в процессе.

STOPPED

Группа сборки остановлена.

SUCCEEDED

Группа сборки успешно завершена.

TIMED_OUT

Группа сборки превысила лимит времени.

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

Объект ResolvedArtifact, представляющий основные артефакты сборки для группы сборки.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

secondaryArtifacts -> (список)

Массив объектов ResolvedArtifact, представляющих вторичные артефакты сборки для группы сборки.

(структура)

Представляет разрешённый артефакт сборки. Разрешённый артефакт — это артефакт, который собран и развернут в пункт назначения, такой как Amazon S3.

type -> (строка)

Указывает тип артефакта.

location -> (строка)

Расположение артефакта.

identifier -> (строка)

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

debugSessionEnabled -> (булево)

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

reportArns -> (список)

Массив, содержащий ARN созданных отчётов, полученных путём объединения отчётов из сборок, связанных с этой пакетной сборкой.

(строка)

buildBatchesNotFound -> (список)

Массив, содержащий идентификаторы пакетных сборок, не найденных.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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