Модуль community.aws.batch_job_definition — управление определениями заданий AWS Batch

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

attempts

integer

Стратегия повторных попыток — число раз, когда задание переводится в статус RUNNABLE. Можно указать от 1 до 10 попыток. Если значение attempts больше единицы, при сбое задание будет запускаться повторно, пока оно не перейдёт в статус RUNNABLE указанное число раз.

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.

command

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

Команда, передаваемая контейнеру. Этот параметр соответствует Cmd в разделе Create a container API Docker Remote и параметру COMMAND команды docker run. Дополнительную информацию см. на странице https://docs.docker.com/engine/reference/builder/#cmd.

По умолчанию: []

debug_botocore_endpoint_logs

boolean

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

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

Допустимые значения:

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

endpoint_url

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

string

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

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

environment

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

Переменные окружения, передаваемые контейнеру. Этот параметр соответствует Env в разделе Create a container API Docker Remote и параметру --env команды docker run.

По умолчанию: []

name

string

Имя пары «ключ-значение». Для переменных окружения это имя переменной окружения.

value

string

Значение пары «ключ-значение». Для переменных окружения это значение переменной окружения.

image

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

Образ, используемый для запуска контейнера. Эта строка передаётся непосредственно демону Docker. По умолчанию доступны образы из реестра Docker Hub. Другие репозитории указываются с помощью repository-url/image-name:tag. Допускается до 255 букв (в верхнем и нижнем регистре), цифр, дефисов, подчёркиваний, двоеточий, точек, косых черт и знаков номера. Этот параметр соответствует Image в разделе Create a container API Docker Remote и параметру IMAGE команды docker run.

job_definition_arn

string

ARN определения задания.

job_definition_name

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

Имя определения задания.

job_role_arn

string

Имя ресурса Amazon (ARN) роли IAM, которую контейнер может принимать для получения разрешений AWS.

memory

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

Жёсткий предел памяти (в МиБ), выделяемой контейнеру. Если контейнер попытается превысить указанное здесь значение, он будет остановлен. Этот параметр соответствует Memory в разделе Create a container API Docker Remote и параметру --memory команды docker run.

mount_points

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

Точки монтирования томов данных в контейнере. Этот параметр соответствует Volumes в разделе Create a container API Docker Remote и параметру --volume команды docker run.

По умолчанию: []

containerPath

string

Путь в контейнере, по которому монтируется том хоста.

readOnly

string

Если это значение равно true, контейнер получает доступ к тому только для чтения; в противном случае контейнер может записывать данные в том. Значение по умолчанию — false.

sourceVolume

string

Имя монтируемого тома.

parameters

dictionary

Заполнители для подстановки параметров по умолчанию, задаваемые в определении задания. Параметры указываются в виде пар «ключ-значение». Параметры запроса SubmitJob переопределяют соответствующие значения параметров по умолчанию из определения задания.

privileged

string

Если этот параметр равен true, контейнеру предоставляются расширенные привилегии на экземпляре контейнера хоста (аналогичные привилегиям пользователя root). Этот параметр соответствует Privileged в разделе Create a container API Docker Remote и параметру --privileged команды docker run.

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.

readonly_root_filesystem

string

Если этот параметр равен true, контейнер получает доступ к корневой файловой системе только для чтения. Этот параметр соответствует ReadonlyRootfs в разделе Create a container API Docker Remote и параметру --read-only команды docker run.

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

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

Описывает требуемое состояние.

Допустимые значения:

• "present" ← (по умолчанию)
• "absent"

type

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

Тип определения задания.

ulimits

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

Список ограничений ulimit, задаваемых для контейнера. Этот параметр соответствует Ulimits в разделе Create a container API Docker Remote и параметру --ulimit команды docker run.

По умолчанию: []

hardLimit

string

Жёсткое ограничение для типа ulimit.

name

string

Тип ограничения ulimit.

softLimit

string

Мягкое ограничение для типа ulimit.

user

string

Имя пользователя, используемое внутри контейнера. Этот параметр соответствует User в разделе Create a container API Docker Remote и параметру --user команды docker run.

validate_certs

boolean

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

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

Допустимые значения:

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

vcpus

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

Число виртуальных процессоров, зарезервированных для контейнера. Этот параметр соответствует CpuShares в разделе Create a container API Docker Remote и параметру --cpu-shares команды docker run. Каждый виртуальный процессор соответствует 1 024 долям ЦП.

volumes

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

Список томов данных, используемых в задании.

По умолчанию: []

host

string

Содержимое параметра host определяет, сохраняется ли том данных на экземпляре контейнера хоста и где он хранится. Если параметр host пуст, демон Docker назначает путь на хосте для тома данных, однако сохранность данных после остановки связанных с ним контейнеров не гарантируется. Это словарь с одним свойством — sourcePath, путём на экземпляре контейнера хоста, который предоставляется контейнеру. Если этот параметр пуст, путь на хосте назначает демон Docker. Если параметр host содержит расположение sourcePath, том данных сохраняется в указанном месте на экземпляре контейнера хоста, пока вы не удалите его вручную. Если значение sourcePath не существует на экземпляре контейнера хоста, демон Docker создаёт его. Если расположение существует, экспортируется содержимое папки исходного пути.

name

string

Имя тома. Допускается до 255 букв (в верхнем и нижнем регистре), цифр, дефисов и подчёркиваний. Это имя указывается в параметре sourceVolume в mountPoints определения контейнера.

output

словарь

возвращает сведения о выполненном действии, о том, были ли внесены изменения, а также о вызове и ответе

Возвращается: всегда

Пример: {"aws_batch_job_definition_action": "none", "changed": false, "response": {"job_definition_arn": "arn:aws:batch:....", "job_definition_name": "<name>", "status": "INACTIVE", "type": "container"}}