community.aws.aws_glue_connection – Управление соединением AWS Glue
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в плейбуке укажите: community.aws.aws_glue_connection.
Новое в версии 1.0.0: коллекции community.aws
Обзор
- Управление соединением AWS Glue. Подробности см. на https://aws.amazon.com/glue/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- 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 | |
| catalog_id строка | Идентификатор каталога данных AWS, в котором необходимо создать подключение. Если не задан, по умолчанию используется идентификатор учетной записи AWS. | |
| connection_properties словарь | Словарь пар ключ-значение, используемых в качестве параметров для этого подключения. Требуется, когда state=present. | |
| connection_type строка |
| Тип подключения. В настоящее время поддерживается только JDBC; SFTP не поддерживается. |
| debug_botocore_endpoint_logs булево |
| Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя их в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время исполнения playbook. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| description строка | Описание подключения. | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url | |
| match_criteria список / элементы=строка | Список строк UTF-8, определяющих критерии для выбора этого подключения. | |
| 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_groups список / элементы=строка | Список групп безопасности, которые должны использоваться подключением. Используйте либо имя, либо ID группы безопасности. | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела, и эти параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка / обязательно |
| Создание или удаление подключения AWS Glue. |
| subnet_id строка | Идентификатор подсети, используемой подключением. | |
| 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
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create an AWS Glue connection
- community.aws.aws_glue_connection:
name: my-glue-connection
connection_properties:
JDBC_CONNECTION_URL: jdbc:mysql://mydb:3306/databasename
USERNAME: my-username
PASSWORD: my-password
state: present
# Delete an AWS Glue connection
- community.aws.aws_glue_connection:
name: my-glue-connection
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| connection_properties словарь | при наличии состояния | Словарь пар ключ-значение, используемых в качестве параметров для этого подключения. Пример: {'JDBC_CONNECTION_URL': 'jdbc:mysql://mydb:3306/databasename', 'PASSWORD': 'y', 'USERNAME': 'x'} |
| connection_type строка | при наличии состояния | Тип подключения. Пример: JDBC |
| creation_time строка | при наличии состояния | Время создания этого определения подключения. Пример: 2018-04-21T05:19:58.326000+00:00 |
| description строка | при наличии состояния | Описание задачи, которая определяется. Пример: Моя первая задача Glue |
| last_updated_time строка | при наличии состояния | Последнее время обновления этого определения подключения. Пример: 2018-04-21T05:19:58.326000+00:00 |
| match_criteria список / элементы=строка | при наличии состояния | Список критериев, которые могут быть использованы для выбора этого подключения. |
| name строка | при наличии состояния | Имя определения подключения. Пример: my-glue-connection |
| physical_connection_requirements словарь | при наличии состояния | Словарь требований к физическому подключению, таких как VPC и SecurityGroup, необходимых для успешного создания этого подключения. Пример: {'subnet-id': 'subnet-aabbccddee'} |
Авторы
- Rob White (@wimnat)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/aws_glue_connection_module.html