Модуль community.aws.glue_job – управление заданием AWS Glue
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: community.aws.glue_job.
Добавлено в community.aws 1.0.0
Краткое описание
- Управление заданием AWS Glue. Подробности см. на странице https://aws.amazon.com/glue/.
- До выпуска версии 5.0.0 этот модуль назывался
community.aws.aws_glue_job. Использование не изменилось.
Псевдонимы: aws_glue_job
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
allocated_capacity integer | Количество единиц обработки данных AWS Glue (DPU), выделяемых этому заданию. Можно выделить от 2 до 100 DPU; значение по умолчанию — 10. DPU — это относительная мера вычислительной мощности, соответствующая 4 виртуальным ЦП и 16 ГБ памяти. |
aws_ca_bundle path | Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Описание параметров доступно в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
command_name string | Имя команды задания. Оно должно быть ‘glueetl’. По умолчанию: |
command_python_version string добавлено в community.aws 2.2.0 | Версия Python, используемая для выполнения задания оболочки Python. В настоящее время AWS поддерживает |
command_script_location string | Путь S3 к скрипту, выполняющему задание. Обязателен, если state=present. |
connections list / элементы=string | Список подключений Glue, используемых для этого задания. |
debug_botocore_endpoint_logs boolean | Использовать средство ведения журнала Также можно использовать переменную среды Варианты:
|
default_arguments dictionary | Словарь аргументов по умолчанию для этого задания. Здесь можно указать аргументы, которые использует ваш скрипт выполнения задания, а также аргументы, используемые самим AWS Glue. |
description string | Описание создаваемого задания. |
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
glue_version string добавлено в community.aws 1.5.0 | Версия Glue определяет версии Apache Spark и Python, поддерживаемые AWS Glue. |
max_concurrent_runs integer | Максимальное число одновременных запусков задания. Значение по умолчанию — 1. При достижении этого порога возвращается ошибка. Максимальное допустимое значение определяется ограничением сервиса. |
max_retries integer | Максимальное число повторных попыток выполнения задания в случае сбоя. |
name string / обязательный | Имя, присваиваемое этому определению задания. Оно должно быть уникальным в вашей учетной записи. |
number_of_workers integer добавлено в community.aws 1.5.0 | Количество рабочих узлов указанного типа, выделяемых при запуске задания. |
profile псевдонимы: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
purge_tags boolean | Если Если параметр Ключи тегов, начинающиеся с Варианты:
|
region псевдонимы: aws_region string | Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
role string | Имя или ARN роли IAM, связанной с этим заданием. Обязателен, если state=present. |
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. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
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. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
state string / обязательный | Создать или удалить задание AWS Glue. Варианты:
|
tags псевдонимы: resource_tags dictionary | Словарь тегов, применяемых к ресурсу. Если параметр |
timeout integer | Время ожидания задания в минутах. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность настройки aws_ca_bundle. Варианты:
|
worker_type string добавлено в community.aws 1.5.0 | Тип предопределенного рабочего узла, выделяемого при запуске задания. Поддержка типов экземпляров Варианты:
|
Примечания
Примечание
- Поддержка параметров tags и purge_tags добавлена в выпуске 2.2.0.
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» 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 job
- community.aws.glue_job:
command_script_location: "s3://s3bucket/script.py"
default_arguments:
"--extra-py-files": s3://s3bucket/script-package.zip
"--TempDir": "s3://s3bucket/temp/"
name: my-glue-job
role: my-iam-role
state: present
# Delete an AWS Glue job
- community.aws.glue_job:
name: my-glue-job
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
allocated_capacity integer | Количество единиц обработки данных AWS Glue (DPU), выделенных для запусков этой задачи. Можно выделить от 2 до 100 DPU; значение по умолчанию — 10. DPU — это относительная мера вычислительной мощности, включающая 4 виртуальных ЦП и 16 ГБ памяти. Возвращается: когда state имеет значение present Пример: |
command complex | Команда JobCommand, выполняющая эту задачу. Возвращается: когда state имеет значение present |
|
name string |
Имя команды задачи. Возвращается: когда state имеет значение present Пример: |
|
python_version string |
Указывает версию Python. Возвращается: когда state имеет значение present Пример: |
|
script_location string |
Указывает путь S3 к скрипту, выполняющему задачу. Возвращается: когда state имеет значение present Пример: |
connections dictionary | Подключения, используемые этой задачей. Возвращается: когда state имеет значение present Пример: |
created_on string | Дата и время создания определения этой задачи. Возвращается: когда state имеет значение present Пример: |
default_arguments dictionary | Аргументы по умолчанию для этой задачи, заданные в виде пар «имя — значение». Возвращается: когда state имеет значение present Пример: |
description string | Описание создаваемой задачи. Возвращается: когда state имеет значение present Пример: |
execution_property complex | Свойство ExecutionProperty, задающее максимальное количество одновременных запусков этой задачи. Возвращается: всегда |
|
max_concurrent_runs integer |
Максимальное количество одновременных запусков задачи. Значение по умолчанию — 1. При достижении этого порога возвращается ошибка. Максимальное допустимое значение определяется ограничением сервиса. Возвращается: когда state имеет значение present Пример: |
glue_version string | Версия Glue. Возвращается: когда state имеет значение present Пример: |
job_name string | Имя задачи AWS Glue. Возвращается: всегда Пример: |
last_modified_on string | Время последнего изменения определения этой задачи. Возвращается: когда state имеет значение present Пример: |
max_retries integer | Максимальное количество повторных попыток запуска этой задачи после сбоя JobRun. Возвращается: когда state имеет значение present Пример: |
name string | Имя, присвоенное определению этой задачи. Возвращается: когда state имеет значение present Пример: |
role string | Имя или ARN роли IAM, связанной с этой задачей. Возвращается: когда state имеет значение present Пример: |
timeout integer | Тайм-аут задачи в минутах. Возвращается: когда state имеет значение present Пример: |
Ссылки на коллекцию
© 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_job_module.html