ecs_attribute – управление атрибутами ecs
Новое в версии 2.4.
Обзор
- Создание, обновление или удаление атрибутов контейнера экземпляра ECS.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| attributes - / обязательно | Список атрибутов. | ||
| name - / обязательно | Имя атрибута. Допускается до 128 букв (строчные и прописные), цифр, дефисов, подчеркиваний и точек. | ||
| value - | Значение атрибута. Допускается до 128 букв (строчные и прописные), цифр, дефисов, подчеркиваний, точек, символов @, слешей (/), двоеточий и пробелов. | ||
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| cluster - / обязательно | Короткое имя или полное Amazon Resource Name (ARN) кластера, содержащего ресурс, к которому применяются атрибуты. | ||
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения книги команд. | |
| ec2_instance_id - / обязательно | Идентификатор экземпляра EC2 контейнера ECS-кластера. | ||
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она есть. | ||
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region строка | AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_token строка | AWS STS-токен безопасности. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state - |
| Желаемое состояние атрибутов. | |
| validate_certs логический тип |
| При значении «нет» сертификаты SSL не будут проверены для версий boto >= 2.6.0. | |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - 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.
# Set attributes
- ecs_attribute:
state: present
cluster: test-cluster
ec2_instance_id: "{{ ec2_id }}"
attributes:
- flavor: test
- migrated
delegate_to: localhost
# Delete attributes
- ecs_attribute:
state: absent
cluster: test-cluster
ec2_instance_id: "{{ ec2_id }}"
attributes:
- flavor: test
- migrated
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | ||
|---|---|---|---|---|
| attributes сложный тип | всегда | атрибуты | ||
| attributes список сложных типов | список атрибутов | |||
| name строка | имя атрибута | |||
| value строка | если присутствует | значение атрибута | ||
| cluster строка | имя кластера | |||
| ec2_instance_id строка | идентификатор экземпляра ec2 контейнера ecs | |||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Andrej Svenke (@anryko)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ecs_attribute_module.html