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 по умолчанию.
connection_properties словарь		Словарь пар ключ-значение, используемых в качестве параметров для этого подключения. Требуется при state=present.
connection_type строка	Варианты: JDBC ← SFTP	Тип подключения. В настоящее время поддерживается только JDBC; SFTP не поддерживается.
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Использование регистратора botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие», выполняемых во время задачи, выводящего набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, выполненный во время плейбука. Также может использоваться переменная среды 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 строка / обязательно	Варианты: present absent	Создание или удаление подключения 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_glue_connection_module.html