Модуль community.aws.codecommit_repository – Управление репозиториями в AWS CodeCommit
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для подробной информации.
Для использования в playbook, укажите: community.aws.codecommit_repository.
Новое в community.aws 1.0.0
Краткое описание
- Поддерживает создание и удаление репозиториев CodeCommit.
- См. https://aws.amazon.com/codecommit/ для получения дополнительной информации о CodeCommit.
- До релиза 5.0.0 этот модуль назывался
community.aws.aws_codecommit. Использование не изменилось.
Псевдонимы: aws_codecommit
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
description aliases: comment string | Описание или комментарий репозитория. По умолчанию: |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
name string / required | Название репозитория. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры security_token и profile являются взаимоисключающими. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
state string / required | Указывает состояние репозитория. Варианты:
|
validate_certs boolean | Когда установлено значение Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Предупреждение: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы могут нуждаться в явном копировании на «хост». Для подключаемых модулей поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
- SDK AWS (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
# Create a new repository
- community.aws.codecommit_repository:
name: repo
state: present
# Delete a repository
- community.aws.codecommit_repository:
name: repo
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
repository_metadata complex | Информация о репозитории. Возвращается: всегда |
|
account_id string |
Идентификатор учетной записи AWS, связанной с репозиторием. Возвращается: когда состояние равно present Пример: |
|
arn string |
Универсальное имя ресурса (ARN) репозитория. Возвращается: когда состояние равно present Пример: |
|
clone_url_http string |
URL-адрес для клонирования репозитория по протоколу HTTPS. Возвращается: когда состояние равно present Пример: |
|
clone_url_ssh string |
URL-адрес для клонирования репозитория по протоколу SSH. Возвращается: когда состояние равно present Пример: |
|
creation_date string |
Дата и время создания репозитория в формате метки времени. Возвращается: когда состояние равно present Пример: |
|
last_modified_date string |
Дата и время последнего изменения репозитория в формате метки времени. Возвращается: когда состояние равно present Пример: |
|
repository_description string |
Комментарий или описание репозитория. Возвращается: когда состояние равно present Пример: |
|
repository_id string |
Идентификатор репозитория, который был создан или удален Возвращается: всегда Пример: |
|
repository_name string |
Имя репозитория. Возвращается: когда состояние равно present Пример: |
response_metadata complex | Информация об ответе. Возвращается: всегда |
|
http_headers dictionary |
HTTP-заголовки HTTP-ответа Возвращается: всегда |
|
http_status_code string |
HTTP-код состояния HTTP-ответа Возвращается: всегда Пример: |
|
request_id string |
Идентификатор HTTP-запроса Возвращается: всегда Пример: |
|
retry_attempts string |
Количество попыток повтора Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/codecommit_repository_module.html
