community.aws.aws_codecommit – Управление репозиториями в AWS CodeCommit
Примечание
Этот плагин является частью коллекции community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Чтобы использовать его в книге задач, укажите: community.aws.aws_codecommit.
Введено в версии 1.0.0: модуля community.aws
Обзор
- Поддерживает создание и удаление репозиториев CodeCommit.
- См. https://aws.amazon.com/codecommit/ для получения дополнительной информации о CodeCommit.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение пакета CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: пакет CA считывается со стороны модуля и может потребоваться явное копирование с контроллера, если он не запускается локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные параметры конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполняемых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| description строка | Описание или комментарий к репозиторию. псевдонимы: comment | |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| name строка / обязательно | Имя репозитория. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка / обязательно |
| Определяет состояние репозитория. |
| validate_certs логический тип |
| При значении "нет" SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION,AWS_CA_BUNDLE - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Create a new repository
- community.aws.aws_codecommit:
name: repo
state: present
# Delete a repository
- community.aws.aws_codecommit:
name: repo
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| repository_metadata complex | всегда | Информация о репозитории. | |
| account_id string | при наличии состояния | Идентификатор AWS-аккаунта, связанного с репозиторием. Пример: 268342293637 | |
| arn string | при наличии состояния | Amazon Resource Name (ARN) репозитория. Пример: arn:aws:codecommit:ap-northeast-1:268342293637:username | |
| clone_url_http string | при наличии состояния | URL для клонирования репозитория через HTTPS. Пример: https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame | |
| clone_url_ssh string | при наличии состояния | URL для клонирования репозитория через SSH. Пример: ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame | |
| creation_date string | при наличии состояния | Дата и время создания репозитория в формате метки времени. Пример: 2018-10-16T13:21:41.261000+09:00 | |
| last_modified_date string | при наличии состояния | Дата и время последнего изменения репозитория в формате метки времени. Пример: 2018-10-16T13:21:41.261000+09:00 | |
| repository_description string | при наличии состояния | Комментарий или описание репозитория. Пример: test from ptux | |
| repository_id string | всегда | Идентификатор репозитория, который был создан или удалён Пример: e62a5c54-i879-497b-b62f-9f99e4ebfk8e | |
| repository_name string | при наличии состояния | Название репозитория. Пример: reponame | |
| response_metadata complex | всегда | Информация о ответе. | |
| http_headers dictionary | всегда | http заголовки http ответа | |
| http_status_code string | всегда | http код состояния http ответа Пример: 200 | |
| request_id string | всегда | Идентификатор http запроса Пример: fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef | |
| retry_attempts string | всегда | Количество попыток повтора Пример: 0 | |
Авторы
- Shuang Wang (@ptux)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_codecommit_module.html
