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) кластера, содержащего ресурс, к которому применяются атрибуты. | ||
| ec2_instance_id - / обязательно | ID экземпляра EC2 контейнера кластера ECS. | ||
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | ||
| profile - добавлен в 1.6 | Использует профиль 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 - добавлен в 1.6 | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state - |
| Желаемое состояние атрибутов. | |
| validate_certs boolean добавлен в 1.5 |
| При значении "no", сертификаты 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 complex | всегда | атрибуты | ||
| attributes список complex | список атрибутов | |||
| name строка | имя атрибута | |||
| value строка | если присуствует | значение атрибута | ||
| cluster строка | имя кластера | |||
| ec2_instance_id строка | 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.7/modules/ecs_attribute_module.html