community.aws.ecs_cluster – Создание или завершение работы кластеров ECS.

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в playbook, укажите: community.aws.ecs_cluster.

Добавлено в версии 1.0.0: в community.aws

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

Описание

Создаёт или завершает работу кластеров ECS.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимно исключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение пакета CA для проверки сертификатов SSL. Используется только для модулей, основанных на boto3. Примечание: Пакет CA читается со стороны модуля и может потребоваться его явное копирование с контроллера, если он не запускается локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения более подробной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимно исключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполняемых во время задачи, вывода набора в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, выполненный во время playbook. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
delay целое число	Значение по умолчанию: 10	Количество секунд ожидания.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она присутствует. псевдонимы: aws_endpoint_url, endpoint_url
name строка / обязательно		Имя кластера.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она присутствует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
repeat целое число	Значение по умолчанию: 10	Количество повторений ожидания появления экземпляров в кластере.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимно исключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка / обязательно	Варианты: present absent has_instances	Желаемое состояние кластера.
validate_certs логический	Варианты: нет да ←	Если установлено значение "нет", сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.

Примечания

Примечание

При удалении кластера возвращается информация о состоянии кластера до удаления.
Также будет ожидаться регистрация экземпляров в кластере.
Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные о доступе не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Cluster creation
  community.aws.ecs_cluster:
    name: default
    state: present

- name: Cluster deletion
  community.aws.ecs_cluster:
    name: default
    state: absent

- name: Wait for register
  community.aws.ecs_cluster:
    name: "{{ new_cluster }}"
    state: has_instances
    delay: 10
    repeat: 10
  register: task_output

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

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

Ключ	Возвращаемое значение	Описание
activeServicesCount целое число	0, если новый кластер	количество активных сервисов в данном кластере
clusterArn строка	0, если новый кластер	ARN кластера, только что созданного Пример: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok
clusterName строка	всегда	имя кластера, только что созданного (должно совпадать с входным аргументом) Пример: test-cluster-mfshcdok
pendingTasksCount целое число	0, если новый кластер	количество задач, ожидающих выполнения в данном кластере
registeredContainerInstancesCount целое число	0, если новый кластер	количество зарегистрированных контейнерных экземпляров в данном кластере
runningTasksCount целое число	0, если новый кластер	количество выполняемых задач в данном кластере
status строка	всегда	состояние нового кластера Пример: ACTIVE

Авторы

Mark Chance (@Java1Guy)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/ecs_cluster_module.html