community.aws.ecs_attribute модуль — управление атрибутами ECS
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Для использования в книге задач укажите: community.aws.ecs_attribute.
Новая в community.aws 1.0.0
Обзор
- Создание, обновление или удаление атрибутов экземпляра контейнера ECS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
attributes список / элементы=словарь / обязательно | Список атрибутов. |
|
name строка / обязательно |
Имя атрибута. Допускается до 128 символов (строчные и прописные буквы), цифры, дефисы, нижние подчеркивания и точки. |
|
value строка |
Значение атрибута. Допускается до 128 символов (строчные и прописные буквы), цифры, дефисы, нижние подчеркивания, точки, знаки "@" (собачка), слэши "/", двоеточия и пробелы. |
aws_ca_bundle путь | Расположение файла CA Bundle для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
cluster строка / обязательно | Короткое имя или полное Amazon Resource Name (ARN) кластера, содержащего ресурс, к которому необходимо применить атрибуты. |
debug_botocore_endpoint_logs логический | Использовать Также можно использовать переменную среды Варианты:
|
ec2_instance_id строка / обязательно | Идентификатор экземпляра EC2 контейнера кластера ECS. |
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только против AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
state string | Желаемое состояние атрибутов. Варианты:
|
validate_certs boolean | Если установлено в Установка validate_certs=false настоятельно не рекомендуется; вместо этого рассмотрите установку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и соединения переменные окружения и файлы конфигурации считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из файлов конфигурации в контексте 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: Set attributes
community.aws.ecs_attribute:
state: present
cluster: test-cluster
ec2_instance_id: "{{ ec2_id }}"
attributes:
- flavor: test
- migrated
delegate_to: localhost
- name: Delete attributes
community.aws.ecs_attribute:
state: absent
cluster: test-cluster
ec2_instance_id: "{{ ec2_id }}"
attributes:
- flavor: test
- migrated
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
attributes complex | атрибуты Возвращается: всегда |
|
attributes список / элементы=словарь |
список атрибутов Возвращается: успех |
|
name строка |
имя атрибута Возвращается: успех |
|
value строка |
значение атрибута Возвращается: если присутствует |
|
cluster строка |
имя кластера Возвращается: успех |
|
ec2_instance_id строка |
id экземпляра EC2 контейнерного экземпляра ECS Возвращается: успех |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ecs_attribute_module.html