Модуль community.aws.codebuild_project — создание или удаление проекта AWS CodeBuild

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.codebuild_project.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание или удаление проектов CodeBuild в AWS, используемых для сборки артефактов кода из исходного кода.
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_codebuild. Использование не изменилось.

Псевдонимы: aws_codebuild

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.
artifacts dictionary	Информация об артефактах, создаваемых при сборке проекта. Параметр artifacts обязателен при создании проекта.
location string	Информация о расположении выходного артефакта сборки. Если для type выбрано значение `S3`, укажите здесь имя бакета.
name string	Вместе с path и namespace_type задаёт шаблон, который AWS CodeBuild будет использовать для именования и хранения выходного артефакта.
namespace_type string	Вместе с path и name задаёт шаблон, который AWS CodeBuild будет использовать для определения имени и расположения выходных артефактов. Допустимые значения: `BUILD_ID` и `NONE`. Документацию см. здесь: http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project.
packaging string	Тип выходного артефакта сборки, создаваемого в S3: NONE для создания папки или ZIP для создания ZIP-файла.
path string	Вместе с namespace_type и name задаёт шаблон, который AWS CodeBuild будет использовать для именования и хранения выходных артефактов. Используется как путь в бакете S3, если type имеет значение `S3`.
type string / обязательный	Тип выходного артефакта сборки. Возможные значения: `CODEPIPELINE`, `NO_ARTIFACTS`, `S3`.
aws_ca_bundle path	Путь к пакету CA для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cache dictionary	Параметры кэширования для ускорения последующих сборок.
location string / обязательный	Расположение кэша в S3.
type string / обязательный	Тип кэша. Возможные значения: `NO_CACHE` или `S3`.
debug_botocore_endpoint_logs boolean	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общих) вызовов API `"resource:action"`, выполненных во время задачи, и выводить полученный набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description string	Описание проекта CodeBuild.
encryption_key string	Ключ AWS Key Management Service (AWS KMS), управляемый клиентом (CMK), который используется для шифрования выходных артефактов сборки.
endpoint_url псевдонимы: aws_endpoint_url string	URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
environment dictionary	Информация о среде сборки проекта.
compute_type string / обязательный	Информация о вычислительных ресурсах, которые будет использовать проект сборки. Доступные значения: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`.
environment_variables string	Набор переменных среды, доступных сборкам проекта. Список словарей с полями name и value. Пример: { name: ‘MY_ENV_VARIABLE’, value: ‘test’ }
image string / обязательный	Идентификатор образа Docker, используемого для этого проекта сборки.
privileged_mode string	Разрешает запуск демона Docker внутри контейнера Docker. Установите значение `true` только в том случае, если проект сборки используется для создания образов Docker.
type string / обязательный	Тип среды сборки, используемой проектом. Обычно это `LINUX_CONTAINER`.
name string / обязательный	Имя проекта CodeBuild.
profile псевдонимы: aws_profile string	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags boolean	Если задано значение `purge_tags=true` и указан параметр `tags`, существующие теги ресурса будут удалены, чтобы они в точности соответствовали параметру `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если установлено `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра `purge_tags`. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region string	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.
service_role string	ARN роли AWS IAM, позволяющей AWS CodeBuild взаимодействовать с зависимыми сервисами AWS от имени учетной записи AWS.
session_token псевдонимы: aws_session_token string	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile взаимоисключающие.
source dictionary	Настройка сервиса и расположения источника входных данных сборки. Параметр source обязателен при создании проекта.
buildspec string	Объявление спецификации сборки, используемое для сборок в этом проекте. Оставьте поле пустым, если оно является частью проекта CodeBuild.
git_clone_depth integer	При использовании git здесь можно указать глубину клонирования в виде целого числа.
insecure_ssl boolean	Включите этот флаг, чтобы игнорировать предупреждения SSL при подключении к исходному коду проекта. Варианты: `false` `true`
location string	Информация о расположении исходного кода, который будет собран. Если для type указано `CODEPIPELINE`, расположение указывать не следует.
type string / обязательный	Тип источника. Допустимые значения: `CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `S3`, `BITBUCKET`, `GITHUB_ENTERPRISE`.
state string	Создать или удалить проект CodeBuild. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags dictionary	Словарь с тегами, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
timeout_in_minutes integer	Время ожидания CodeBuild до завершения по тайм-ауту сборки, которая не была отмечена как завершенная. По умолчанию: `60`
validate_certs boolean	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vpc_config dictionary	Конфигурация VPC позволяет AWS CodeBuild получать доступ к ресурсам в Amazon VPC.

Примечания

Примечание

Описание параметров и возвращаемых значений см. по адресу http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html.
Формат tags изменен с формата boto3 на стандартный формат dict в выпуске 6.0.0.
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.codebuild_project:
    name: my_project
    description: My nice little project
    service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"
    source:
      # Possible values: BITBUCKET, CODECOMMIT, CODEPIPELINE, GITHUB, S3
      type: CODEPIPELINE
      buildspec: ''
    artifacts:
      namespaceType: NONE
      packaging: NONE
      type: CODEPIPELINE
      name: my_project
    environment:
      computeType: BUILD_GENERAL1_SMALL
      privilegedMode: "true"
      image: "aws/codebuild/docker:17.09.0"
      type: LINUX_CONTAINER
      environmentVariables:
        - name: 'PROFILE'
          value: 'staging'
    encryption_key: "arn:aws:kms:us-east-1:123123:alias/aws/s3"
    region: us-east-1
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
project complex	Возвращает словарь с описанием конфигурации проекта сборки. Возвращается: при успешном выполнении
arn string	ARN проекта CodeBuild. Возвращается: всегда Пример: `"arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder"`
artifacts complex	Информация о выходных артефактах сборки Возвращается: всегда
location string	Место размещения выходных артефактов сборки. Возвращается: если задано
type string	Тип артефакта сборки. Возвращается: всегда Пример: `"CODEPIPELINE"`
cache dictionary	Настройки кэша проекта сборки. Возвращается: если задано
created string	Метка времени создания проекта. Возвращается: всегда Пример: `"2018-04-17T16:56:03.245000+02:00"`
description string	Описание проекта CodeBuild. Возвращается: всегда Пример: `"My nice little project"`
environment dictionary	Настройки среды сборки. Возвращается: всегда
name string	Имя проекта CodeBuild. Возвращается: всегда Пример: `"my_project"`
reource_tags dictionary добавлено в community.aws 4.0.0	Простой словарь, представляющий теги, добавленные к проекту. tags и reource_tags представляют одни и те же данные в разных форматах. Возвращается: если задано
service_role string	Роль IAM, используемая во время сборки для доступа к другим сервисам AWS. Возвращается: всегда Пример: `"arn:aws:iam::123123123:role/codebuild-service-role"`
source complex	Информация об исходном коде, используемом в качестве входных данных сборки. Возвращается: всегда
auth complex	Информация о настройках авторизации, необходимых AWS CodeBuild для доступа к исходному коду, который требуется собрать. Возвращается: если задано
build_spec string	Спецификация сборки, используемая для сборок в этом проекте сборки. Возвращается: всегда
git_clone_depth integer	Глубина клонирования git. Возвращается: если задано
insecure_ssl boolean	Значение True, если задано игнорирование предупреждений SSL. Возвращается: если задано
location string	Идентификатор расположения, зависящий от типа источника. Возвращается: если задано
type string	Тип репозитория. Возвращается: всегда Пример: `"CODEPIPELINE"`
tags list / elements=string	Теги, добавленные к проекту в формате списка словарей boto3. tags и reource_tags представляют одни и те же данные в разных форматах. Возвращается: если задано
timeout_in_minutes integer	Время ожидания сборки в минутах. Возвращается: всегда Пример: `60`

Авторы

Stefan Horning (@stefanhorning)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/codebuild_project_module.html