Spec-Zone.ru › Ansible

Модуль community.aws.glue_connection — управление подключением AWS Glue

Примечание

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

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

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

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

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

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

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

  • Управление подключением AWS Glue. Подробности см. на странице https://aws.amazon.com/glue/.
  • До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_glue_connection. Использование не изменилось.

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

Требования

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

  • 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 SDK botocore.

availability_zone

string

добавлено в community.aws 1.5.0

Зона доступности, используемая подключением

Обязателен, если connection_type=NETWORK.

aws_ca_bundle

path

Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры перечислены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

catalog_id

string

Идентификатор каталога данных, в котором нужно создать подключение. Если значение не указано, по умолчанию используется идентификатор учетной записи AWS.

connection_properties

dictionary

Словарь пар «ключ-значение», используемых в качестве параметров этого подключения.

Обязателен, если state=present.

connection_type

string

Тип подключения. В настоящее время SFTP не поддерживается.

Варианты:

  • "CUSTOM"
  • "JDBC" ← (по умолчанию)
  • "KAFKA"
  • "MARKETPLACE"
  • "MONGODB"
  • "NETWORK"

debug_botocore_endpoint_logs

boolean

Использовать логгер botocore.endpoint для подсчета уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

description

string

Описание подключения.

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

match_criteria

list / элементы=string

Список строк в кодировке UTF-8, задающих критерии, которые можно использовать для выбора этого подключения.

name

string / обязательный

Имя подключения.

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.

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 SDK botocore.

security_groups

list / элементы=string

Список групп безопасности, используемых подключением. Укажите имя или идентификатор группы безопасности.

Обязателен, если connection_type=NETWORK.

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 являются взаимоисключающими.

state

string / обязательный

Создать или удалить подключение AWS Glue.

Варианты:

  • "present"
  • "absent"

subnet_id

string

Идентификатор подсети, используемой подключением.

Обязателен, если connection_type=NETWORK.

validate_certs

boolean

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность настройки aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «хоста» 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.

# Create an AWS Glue connection
- community.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

# Create an AWS Glue network connection
- community.aws.glue_connection:
    name: my-glue-network-connection
    availability_zone: us-east-1a
    connection_properties:
      JDBC_ENFORCE_SSL: "false"
    connection_type: NETWORK
    description: Test connection
    security_groups:
      - sg-glue
    subnet_id: subnet-123abc
    state: present

# Delete an AWS Glue connection
- community.aws.glue_connection:
    name: my-glue-connection
    state: absent

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

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

Ключ

Описание

connection_type

string

Тип подключения.

Возвращается: если state имеет значение present

Пример: "JDBC"

creation_time

string

Время создания определения этого подключения.

Возвращается: если state имеет значение present

Пример: "2018-04-21T05:19:58.326000+00:00"

description

string

Описание определяемого задания.

Возвращается: если state имеет значение present

Пример: "My first Glue job"

last_updated_time

string

Время последнего обновления определения этого подключения.

Возвращается: если state имеет значение present

Пример: "2018-04-21T05:19:58.326000+00:00"

match_criteria

list / элементы=string

Список критериев, которые можно использовать для выбора этого подключения.

Возвращается: если state имеет значение present

Пример: []

name

string

Имя определения подключения.

Возвращается: если state имеет значение present

Пример: "my-glue-connection"

physical_connection_requirements

dictionary

Словарь с требованиями к физическому подключению, например VPC и SecurityGroup, необходимыми для успешного подключения.

Возвращается: если state имеет значение present

Пример: {"subnet-id": "subnet-aabbccddee"}

raw_connection_properties

dictionary

Словарь пар «ключ-значение», используемых в качестве параметров этого подключения.

Возвращается: если state имеет значение present

Пример: {"JDBC_CONNECTION_URL": "jdbc:mysql://mydb:3306/databasename", "PASSWORD": "y", "USERNAME": "x"}

Авторы

  • Rob White (@wimnat)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 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/glue_connection_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API