batch-get-sandboxes

Описание

Получает информацию о статусе песочницы.

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

Синтаксис

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

Параметры

--ids (список)

Список sandboxIds или sandboxArns, разделённый запятыми.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

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

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

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

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

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

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

--output (строка)

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

json
text
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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

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

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

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

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

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

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

Вывод

песочницы -> (список)

Информация о запрошенных песочницах.

(структура)

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

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

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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

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

type -> (строка)

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

resource -> (строка)

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

reportBuildStatus -> (булево)

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

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

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

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

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

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

context -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

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

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

sourceVersion -> (строка)

Любой идентификатор версии для версии песочницы, подлежащей сборке.

secondarySources -> (список)

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

(структура)

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

type -> (строка)

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

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

location -> (строка)

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

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

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

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

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

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

fetchSubmodules -> (булево)

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

buildspec -> (строка)

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

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

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

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

type -> (строка)

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

resource -> (строка)

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

reportBuildStatus -> (булево)

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

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

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

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

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

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

context -> (строка)

Bitbucket

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

GitHub/GitHub Enterprise Server

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

targetUrl -> (строка)

Bitbucket

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

GitHub/GitHub Enterprise Server

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

insecureSsl -> (булево)

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

sourceIdentifier -> (строка)

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

secondarySourceVersions -> (список)

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

(структура)

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

sourceIdentifier -> (строка)

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

sourceVersion -> (строка)

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

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

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_. Например, если для identifier указано my_efs, создается новая переменная среды с именем 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 -> (строка)

Идентификатор 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

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

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

Дополнительную информацию об владении объектами Amazon S3 см. в разделе Управление правами собственности на загруженные объекты с помощью прав собственности на объекты S3 в Руководстве пользователя 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 -> (строка)

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

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

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

sandboxesNotFound -> (список)

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

(строка)

END_OF_DOCUMENT_MARKER