Модуль community.aws.ecs_task — запуск, старт или остановка задачи в ECS

Примечание

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

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

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

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

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

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

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

Создаёт или удаляет экземпляры определений задач.

Требования

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа 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.
aws_ca_bundle путь	Путь к набору сертификатов CA, используемому при проверке SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cluster строка	Имя кластера, в котором будет запущена задача. Если параметр не указан, именем кластера будет `default`. По умолчанию: `"default"`
container_instances список / элементы=строка	Список экземпляров контейнеров, на которых будет развёрнута задача.
count целое число	Количество новых запускаемых экземпляров.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить набор в ключ resource_actions в результатах задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести полный список вызовов, выполненных в плейбуке. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Этот параметр можно использовать для подключения к другим совместимым с AWS службам, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
launch_type строка	Тип запуска, используемый для запуска службы. Варианты: `"EC2"` `"FARGATE"`
network_configuration словарь	Сетевая конфигурация службы. Применяется только к определениям задач, созданным с параметром network_mode=awsvpc.
assign_public_ip логическое значение добавлено в community.aws 1.5.0	Получает ли эластичный сетевой интерфейс задачи общедоступный IP-адрес. Варианты: `false` `true`
security_groups список / элементы=строка	Список имён или идентификаторов групп для задачи.
subnets список / элементы=строка	Список идентификаторов подсетей, к которым подключена задача.
operation строка / обязательный	Операция над задачей, которую нужно выполнить. При operation=run необходимо указать task_definition. При operation=start необходимо указать оба параметра: task_definition и container_instances. При operation=stop необходимо указать оба параметра: task_definition и task. Варианты: `"run"` `"start"` `"stop"`
overrides словарь	Словарь значений, передаваемых новым экземплярам.
profile псевдонимы: aws_profile строка	Именованный профиль 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 строка	Регион 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 строка	Секретный ключ доступа 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.
session_token псевдонимы: aws_session_token строка	Токен сеанса 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 являются взаимоисключающими.
started_by строка	Значение, указывающее, кто или что запустило задачу (для справки).
tags псевдонимы: resource_tags словарь	Теги, добавляемые к задачам ECS при запуске и выполнении.
task строка	ARN задачи, которую нужно остановить.
task_definition строка	Определение задачи, которую нужно запустить, выполнить или остановить.
validate_certs логическое значение	Если установлено значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение добавлено в community.aws 4.1.0	Ожидать ли достижения требуемого состояния. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Simple example of run task
- name: Run task
  community.aws.ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    count: 1
    started_by: ansible_user
  register: task_output

# Simple example of start task

- name: Start a task
  community.aws.ecs_task:
    operation: start
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    tags:
      resourceName: a_task_for_ansible_to_run
      type: long_running_task
      network: internal
      version: 1.4
    container_instances:
      - arn:aws:ecs:us-west-2:123456789012:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8
    started_by: ansible_user
    network_configuration:
      subnets:
        - subnet-abcd1234
      security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate
  community.aws.ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    started_by: ansible_user
    launch_type: FARGATE
    network_configuration:
      subnets:
        - subnet-abcd1234
      security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate with public ip assigned
  community.aws.ecs_task:
    operation: run
    count: 2
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    started_by: ansible_user
    launch_type: FARGATE
    network_configuration:
      assign_public_ip: true
      subnets:
        - subnet-abcd1234
  register: task_output

- name: Stop a task
  community.aws.ecs_task:
    operation: stop
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"

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

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

Ключ	Описание
task сложный тип	сведения о запущенной задаче Возвращается: при успешном выполнении
clusterArn строка	Имя ресурса Amazon (ARN) кластера, в котором размещена задача. Возвращается: только если details имеет значение true
containerInstanceArn строка	Имя ресурса Amazon (ARN) контейнера, выполняющего задачу. Возвращается: только если details имеет значение true
containers список / элементы=словарь	Сведения о контейнере. Возвращается: только если details имеет значение true
createdAt строка	Время создания задачи. Возвращается: только если details имеет значение true
desiredStatus строка	Требуемый статус задачи. Возвращается: только если details имеет значение true
lastStatus строка	Последний зарегистрированный статус задачи. Возвращается: только если details имеет значение true
launchType строка	Тип запуска, используемый для запуска задачи. Возвращается: всегда
overrides список / элементы=словарь	Переопределения параметров контейнера, заданные для этой задачи. Возвращается: только если details имеет значение true
startedAt строка	Время запуска задачи. Возвращается: только если details имеет значение true
startedBy строка	Пользователь, запустивший задачу. Возвращается: только если details имеет значение true
stoppedAt строка	Время остановки задачи. Возвращается: только если details имеет значение true
stoppedReason строка	Причина остановки задачи. Возвращается: только если details имеет значение true
taskArn строка	Имя ресурса Amazon (ARN), идентифицирующее задачу. Возвращается: всегда
taskDefinitionArn строка	Имя ресурса Amazon (ARN) определения задачи. Возвращается: только если details имеет значение true

Авторы

Mark Chance (@Java1Guy)

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

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