Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

stop-build-batch

Описание

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

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

Синтаксис

  stop-build-batch
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--id (строка)

Идентификатор пакетной сборки, которую нужно остановить.

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

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

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

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

Включает отладку.

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

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

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

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

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

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

--output (строка)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

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

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

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

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

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

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

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

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

  • base64
  • raw-in-base64-out

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

Отключить вывод пагинатора CLI.

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

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

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

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

Примеры

Примечание

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

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

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

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

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

Вывод:

{
    "buildBatch": {
        "id": "<project-name>:<batch-ID>",
        "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build-batch/<project-name>:<batch-ID>",
        "startTime": "2020-10-21T16:54:24.740000+00:00",
        "endTime": "2020-10-21T16:56:05.152000+00:00",
        "currentPhase": "STOPPED",
        "buildBatchStatus": "STOPPED",
        "resolvedSourceVersion": "aef7744ed069c51098e15c360f4102cd2cd1ad64",
        "projectName": "<project-name>",
        "phases": [
            {
                "phaseType": "SUBMITTED",
                "phaseStatus": "SUCCEEDED",
                "startTime": "2020-10-21T16:54:24.740000+00:00",
                "endTime": "2020-10-21T16:54:25.039000+00:00",
                "durationInSeconds": 0
            },
            {
                "phaseType": "DOWNLOAD_BATCHSPEC",
                "phaseStatus": "SUCCEEDED",
                "startTime": "2020-10-21T16:54:25.039000+00:00",
                "endTime": "2020-10-21T16:54:56.583000+00:00",
                "durationInSeconds": 31
            },
            {
                "phaseType": "IN_PROGRESS",
                "phaseStatus": "STOPPED",
                "startTime": "2020-10-21T16:54:56.583000+00:00",
                "endTime": "2020-10-21T16:56:05.152000+00:00",
                "durationInSeconds": 68
            },
            {
                "phaseType": "STOPPED",
                "startTime": "2020-10-21T16:56:05.152000+00:00"
            }
        ],
        "source": {
            "type": "GITHUB",
            "location": "<GitHub-repo-URL>",
            "gitCloneDepth": 1,
            "gitSubmodulesConfig": {
                "fetchSubmodules": false
            },
            "reportBuildStatus": false,
            "insecureSsl": false
        },
        "secondarySources": [],
        "secondarySourceVersions": [],
        "artifacts": {
            "location": ""
        },
        "secondaryArtifacts": [],
        "cache": {
            "type": "NO_CACHE"
        },
        "environment": {
            "type": "LINUX_CONTAINER",
            "image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
            "computeType": "BUILD_GENERAL1_SMALL",
            "environmentVariables": [],
            "privilegedMode": false,
            "imagePullCredentialsType": "CODEBUILD"
        },
        "logConfig": {
            "cloudWatchLogs": {
                "status": "ENABLED"
            },
            "s3Logs": {
                "status": "DISABLED",
                "encryptionDisabled": false
            }
        },
        "buildTimeoutInMinutes": 60,
        "queuedTimeoutInMinutes": 480,
        "complete": true,
        "initiator": "Strohm",
        "encryptionKey": "arn:aws:kms:<region-ID>:<account-ID>:alias/aws/s3",
        "buildBatchNumber": 3,
        "buildBatchConfig": {
            "serviceRole": "arn:aws:iam::<account-ID>:role/service-role/<project-name>",
            "restrictions": {
                "maximumBuildsAllowed": 100
            },
            "timeoutInMins": 480
        },
        "buildGroups": [
            {
                "identifier": "DOWNLOAD_SOURCE",
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T16:54:25.468000+00:00",
                    "buildStatus": "SUCCEEDED",
                    "primaryArtifact": {
                        "type": "no_artifacts",
                        "identifier": "DOWNLOAD_SOURCE"
                    },
                    "secondaryArtifacts": []
                }
            },
            {
                "identifier": "linux_small",
                "dependsOn": [],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T16:54:56.833000+00:00",
                    "buildStatus": "IN_PROGRESS"
                }
            },
            {
                "identifier": "linux_medium",
                "dependsOn": [
                    "linux_small"
                ],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T16:54:56.211000+00:00",
                    "buildStatus": "PENDING"
                }
            },
            {
                "identifier": "linux_large",
                "dependsOn": [
                    "linux_medium"
                ],
                "ignoreFailure": false,
                "currentBuildSummary": {
                    "arn": "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
                    "requestedOn": "2020-10-21T16:54:56.330000+00:00",
                    "buildStatus": "PENDING"
                }
            }
        ]
    }
}

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

Вывод

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

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

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

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

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

contexts -> (список)

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

(структура)

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

statusCode -> (строка)

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

message -> (строка)

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

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

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

type -> (строка)

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

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

location -> (строка)

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

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

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

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

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

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

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

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

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

buildspec -> (строка)

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

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

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

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

type -> (строка)

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

resource -> (строка)

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

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

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

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

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

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

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

Если вы указываете 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.

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

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

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

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

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

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

secondarySourceVersions -> (список)

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

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

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

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

Дополнительную информацию о владении объектами 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

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

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

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

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

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

type -> (строка)

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

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

location -> (строка)

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

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

modes -> (список)

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

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

LOCAL_SOURCE_CACHE

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

LOCAL_DOCKER_LAYER_CACHE

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

Примечание

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

LOCAL_CUSTOM_CACHE

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

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

(строка)

cacheNamespace -> (строка)

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

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

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

type -> (строка)

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

Примечание

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

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

image -> (строка)

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

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

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

computeType -> (строка)

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

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

Примечание

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

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

  • Для типа среды LINUX_CONTAINER вы можете использовать до 4 ГБ памяти и 2 vCPU для сборок.
  • Для типа среды LINUX_GPU_CONTAINER вы можете использовать до 16 ГБ памяти, 4 vCPU и 1 графический процессор NVIDIA A10G Tensor Core для сборок.
  • Для типа среды 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 и командной строки. Для конфиденциальных значений мы рекомендуем использовать переменную среды типа 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 -> (строка)

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

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

Информация о логах для проекта сборки. Это могут быть логи в 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 -> (строка)

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

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

Список одного или нескольких идентификаторов групп безопасности в вашей 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 созданных отчетов путем объединения отчетов из сборок, связанных с этой пакетной сборкой.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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