Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

availability_zone

string

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

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

Требуется, когда connection_type=NETWORK.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке сертификатов 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 регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время работы playbook.

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

Варианты:

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

description

string

Описание соединения.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

match_criteria

list / elements=string

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

name

string / required

Название соединения.

profile

aliases: 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 и security_token.

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется.

Переменные среды AWS_REGION или EC2_REGION также могут использоваться.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

Также могут использоваться переменные окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

security_groups

list / elements=string

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

Требуется, когда connection_type=NETWORK.

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.

Также могут использоваться переменные окружения AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных окружения EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

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 SDK AWS (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_properties

словарь

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

Этот ключ возврата устарел и будет удален в версии 9.0.0.

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

Пример: {"jdbc_connection_url": "jdbc:mysql://mydb:3306/databasename", "password": "y", "username": "x"}

connection_type

строка

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

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

Пример: "JDBC"

creation_time

строка

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

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

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

description

строка

Описание задачи, которая определяется.

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

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

last_updated_time

строка

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

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

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

match_criteria

список / элементы=строка

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

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

Пример: []

name

строка

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

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

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

physical_connection_requirements

словарь

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

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

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

raw_connection_properties

словарь

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

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

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

Авторы

  • Rob White (@wimnat)

Ссылки на сборки

  • Трекер задач
  • Репозиторий (источники)
  • Связь

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

Spec-Zone.ru

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