stop-sandbox

Описание

Останавливает песочницу.

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

Синтаксис

  stop-sandbox
--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
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

вкл
выкл
авто

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

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

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

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

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

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

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

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

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

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

base64
raw-in-base64-out

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

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

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

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

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

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

Вывод

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

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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

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

type -> (строка)

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

resource -> (строка)

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

reportBuildStatus -> (булево)

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

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

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

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

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

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

context -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

machineType -> (строка)

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

instanceType -> (строка)

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

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

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

fleetArn -> (строка)

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

environmentVariables -> (список)

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

(структура)

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

name -> (строка)

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

value -> (строка)

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

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

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

type -> (строка)

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

PARAMETER_STORE : Переменная среды, хранящаяся в хранилище параметров Systems Manager. Для переменных среды этого типа укажите имя параметра как value переменной EnvironmentVariable. Значение параметра будет заменено на имя во время выполнения. Вы также можете определить переменные среды хранилища параметров в buildspec. Чтобы узнать, как это сделать, см. env/parameter-store в руководстве пользователя CodeBuild.
PLAINTEXT : Переменная среды в формате простого текста. Это значение по умолчанию.
SECRETS_MANAGER : Переменная среды, хранящаяся в Secrets Manager. Для переменных среды этого типа укажите имя секрета как value переменной EnvironmentVariable. Значение секрета будет заменено на имя во время выполнения. Вы также можете определить переменные среды Secrets Manager в buildspec. Чтобы узнать, как это сделать, см. env/secrets-manager в руководстве пользователя CodeBuild.

privilegedMode -> (булево)

Включает запуск демона Docker внутри контейнера Docker. Установите в значение true только если проект сборки используется для построения Docker-образов. В противном случае сборка, которая пытается взаимодействовать с демоном Docker, завершается неудачно. Значение по умолчанию — false.

Вы можете инициализировать демон Docker во время фазы установки вашей сборки, добавив один из следующих наборов команд в фазу установки вашего файла buildspec:

Если базовый образ операционной системы — Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

Если базовый образ операционной системы — Alpine Linux и предыдущая команда не работает, добавьте аргумент -t к timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

certificate -> (строка)

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

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

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

credential -> (строка)

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

Примечание

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

credentialProvider -> (строка)

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

imagePullCredentialsType -> (строка)

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

CODEBUILD указывает, что CodeBuild использует свои собственные учетные данные. Для этого вам необходимо изменить политику вашего репозитория ECR, чтобы доверять службе CodeBuild.
SERVICE_ROLE указывает, что CodeBuild использует роль службы вашего проекта сборки.

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

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

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

computeType -> (строка)

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

BUILD_GENERAL1_SMALL : Использует до 4 ГБ памяти и 2 vCPU для вашего Docker-сервера.
BUILD_GENERAL1_MEDIUM : Использует до 8 ГБ памяти и 4 vCPU для вашего Docker-сервера.
BUILD_GENERAL1_LARGE : Использует до 16 ГБ памяти и 8 vCPU для вашего Docker-сервера.
BUILD_GENERAL1_XLARGE : Использует до 64 ГБ памяти и 32 vCPU для вашего Docker-сервера.
BUILD_GENERAL1_2XLARGE : Использует до 128 ГБ памяти и 64 vCPU для вашего Docker-сервера.

securityGroupIds -> (список)

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

Примечание

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

(строка)

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

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

status -> (строка)

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

message -> (строка)

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

fileSystemLocations -> (список)

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

(структура)

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

type -> (строка)

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

location -> (строка)

Строка, указывающая расположение файловой системы, созданной Amazon EFS. Ее формат — efs-dns-name:/directory-path . Имя DNS файловой системы можно найти в консоли Amazon EFS. Путь к каталогу — это путь к каталогу в файловой системе, который CodeBuild монтирует. Например, если имя DNS файловой системы — fs-abcd1234.efs.us-west-2.amazonaws.com , а каталог для монтирования — my-efs-mount-directory , то location — fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory .

Путь к каталогу в формате efs-dns-name:/directory-path необязателен. Если путь к каталогу не указан, расположением будет только имя DNS, и CodeBuild будет монтировать всю файловую систему.

mountPoint -> (строка)

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

identifier -> (строка)

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

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

mountOptions -> (строка)

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

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

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

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

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

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

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

vpcId -> (строка)

ID Amazon VPC.

subnets -> (список)

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

(строка)

securityGroupIds -> (список)

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

(строка)

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

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

encryptionKey -> (строка)

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

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}. Поток логов CloudWatch Logs создаётся во время фазы PROVISIONING сборки, и ARN не будет действительным до его создания. Дополнительную информацию см. в разделе Определяемые CloudWatch Logs ресурсы.

s3LogsArn -> (строка)

ARN логов S3 для проекта сборки. Его формат - arn:${Partition}:s3:::${BucketName}/${ObjectName}. Дополнительную информацию см. в разделе Определяемые Amazon S3 ресурсы.

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

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

status -> (строка)

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

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

groupName -> (строка)

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

streamName -> (строка)

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

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

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

status -> (строка)

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

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

location -> (строка)

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

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

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

bucketOwnerAccess -> (строка)

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

Примечание

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

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

NONE

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

READ_ONLY

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

FULL

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

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

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

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

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

subnetId -> (строка)

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

networkInterfaceId -> (строка)

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