Модуль community.aws.ecs_cluster — создание и удаление кластеров ECS.

Примечание

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

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

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

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

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

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

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

Создаёт или удаляет кластеры ECS.

Требования

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

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.
capacity_provider_strategy список / элементы=словарь добавлено в community.aws 5.2.0	Список стратегий поставщиков ёмкости для использования в кластере.
base целое число	Минимальное количество задач, которые должны использовать указанного поставщика. По умолчанию: `0`
capacity_provider строка	Имя поставщика ёмкости.
weight целое число	Относительная доля от общего количества запускаемых задач, которые должны использовать указанного поставщика.
capacity_providers список / элементы=строка добавлено в community.aws 5.2.0	Список поставщиков ёмкости для использования в кластере.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для подсчёта уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключе resource_actions результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в течение плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
delay целое число	Количество секунд ожидания. По умолчанию: `10`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
name строка / обязательный	Имя кластера.
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.
purge_capacity_providers логическое значение добавлено в community.aws 5.2.0	Включает или отключает перезапись существующих поставщиков ёмкости или стратегии. Этот параметр необходим для обратной совместимости. По умолчанию purge_capacity_providers=true. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
repeat целое число	Количество попыток ожидания появления экземпляра в кластере. По умолчанию: `10`
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 являются взаимоисключающими.
state строка / обязательный	Желаемое состояние кластера. Варианты: `"present"` `"absent"` `"has_instances"`
validate_certs логическое значение	Если задано значение `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.

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

- name: Cluster creation with capacity providers and strategies.
  community.aws.ecs_cluster:
    name: default
    state: present
    capacity_providers:
      - FARGATE
      - FARGATE_SPOT
    capacity_provider_strategy:
      - capacity_provider: FARGATE
        base: 1
        weight: 1
      - capacity_provider: FARGATE_SPOT
        weight: 100
    purge_capacity_providers: true

- 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 для нового кластера
capacityProviders список / элементы=строка добавлено в community.aws 5.2.0	список поставщиков ёмкости, используемых в этом кластере Возвращается: всегда
clusterArn строка	ARN только что созданного кластера Возвращается: 0 для нового кластера Пример: `"arn:aws:ecs:us-west-2:123456789012:cluster/test-cluster"`
clusterName строка	имя только что созданного кластера (должно совпадать с входным аргументом) Возвращается: всегда Пример: `"test-cluster"`
defaultCapacityProviderStrategy список / элементы=строка добавлено в community.aws 5.2.0	список стратегий поставщиков ёмкости, используемых в этом кластере Возвращается: всегда
pendingTasksCount целое число	количество задач, ожидающих запуска в этом кластере Возвращается: 0 для нового кластера
registeredContainerInstancesCount целое число	количество доступных контейнерных экземпляров в этом кластере Возвращается: 0 для нового кластера
runningTasksCount целое число	количество выполняющихся задач в этом кластере Возвращается: 0 для нового кластера
status строка	состояние нового кластера Возвращается: всегда Пример: `"ACTIVE"`

Авторы

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_cluster_module.html