start-sandbox

Описание

Запускает песочницу.

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

Синтаксис

  start-sandbox
[--project-name <value>]
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--project-name (строка)

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

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

Уникальный токен клиента.

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

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

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

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

Вывод

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

Информация о запрошенном контейнере.

id -> (строка)

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

arn -> (строка)

ARN контейнера.

projectName -> (строка)

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

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

Время первоначального запроса процесса контейнера в формате Unix.

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

Время запуска процесса контейнера в формате Unix.

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

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

status -> (строка)

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

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

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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 символов.

sourceVersion -> (строка)

Любой идентификатор версии для версии контейнера, который будет собираться.

secondarySources -> (список)

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

(структура)

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

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

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

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

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

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

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

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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

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

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

Тип авторизации для использования. Допустимые варианты: 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 .

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

secondarySourceVersions -> (список)

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

(структура)

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

sourceIdentifier -> (строка)

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

sourceVersion -> (строка)

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

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

Дополнительную информацию см. в разделе Пример версии исходного кода с CodeBuild в руководстве пользователя 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 ГБ твердотельного накопителя для сборок. Этот тип вычислений поддерживает Docker-образы объёмом до 100 ГБ без сжатия.
BUILD_LAMBDA_1GB : Используйте до 1 ГБ памяти для сборок. Доступен только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB : Используйте до 2 ГБ памяти для сборок. Доступен только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB : Используйте до 4 ГБ памяти для сборок. Доступен только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB : Используйте до 8 ГБ памяти для сборок. Доступен только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB : Используйте до 10 ГБ памяти для сборок. Доступен только для типов среды LINUX_LAMBDA_CONTAINER и ARM_LAMBDA_CONTAINER.

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

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

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

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

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

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

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

vCpu -> (целое)

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

memory -> (целое)

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

disk -> (целое)

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

machineType -> (строка)

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

instanceType -> (строка)

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

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

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

fleetArn -> (строка)

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

environmentVariables -> (список)

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

(структура)

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

name -> (строка)

Имя или ключ переменной окружения.

value -> (строка)

Значение переменной окружения.

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

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

type -> (строка)

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

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

fileSystemLocations -> (список)

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

(структура)

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

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

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

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

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

пункт_подключения -> (строка)

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

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

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

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

параметры_подключения -> (строка)

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

время_ожидания_в_минутах -> (целое_число)

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

время_ожидания_в_очереди_в_минутах -> (целое_число)

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

конфигурация_vpc -> (структура)

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

id_vpc -> (строка)

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

подсети -> (список)

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

(строка)

идентификаторы_групп_безопасности -> (список)

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

(строка)

конфигурация_журнала -> (структура)

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

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

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

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

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

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

имя_группы -> (строка)

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

encryptionKey -> (строка)

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

serviceRole -> (строка)

Имя роли сервиса, используемой для этой песочницы.

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

Текущая сессия для песочницы.

id -> (строка)

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

status -> (строка)

Статус сессии песочницы.

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

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

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

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

currentPhase -> (строка)

Текущая фаза песочницы.

phases -> (список)

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

(структура)

Содержит информацию о фазе песочницы.

phaseType -> (строка)

Название фазы песочницы.

phaseStatus -> (строка)

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

FAILED

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

FAULT

Фаза песочницы завершилась с ошибкой.

IN_PROGRESS

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

STOPPED

Фаза песочницы остановлена.

SUCCEEDED

Фаза песочницы завершилась успешно.

TIMED_OUT

Фаза песочницы истекла.

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

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

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

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

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

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

contexts -> (список)

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

(структура)

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

statusCode -> (строка)

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

message -> (строка)

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

resolvedSourceVersion -> (строка)

Идентификатор версии исходного кода песочницы.

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

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

groupName -> (строка)

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

streamName -> (строка)

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

deepLink -> (строка)

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

s3DeepLink -> (строка)

Ссылка на лог сборки в S3.

cloudWatchLogsArn -> (строка)

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

s3LogsArn -> (строка)

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

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

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

status -> (строка)

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

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

groupName -> (строка)

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

streamName -> (строка)

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

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

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

status -> (строка)

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

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

location -> (строка)

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

encryptionDisabled -> (булево)

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

bucketOwnerAccess -> (строка)

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

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

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

subnetId -> (строка)

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

networkInterfaceId -> (строка)

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