amazon.aws.aws_account_attribute lookup – Поиск атрибутов учетной записи AWS
Примечание
Этот плагин поиска является частью коллекции amazon.aws (версия 8.2.1).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого плагина поиска вам потребуются дополнительные зависимости. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: amazon.aws.aws_account_attribute.
Обзор
- Описывает атрибуты вашей учетной записи AWS. Вы можете указать один из перечисленных атрибутов или опустить его, чтобы увидеть все атрибуты.
Требования
Ниже перечислены требования, необходимые на узле локального контроллера, который выполняет этот поиск.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры ключевых слов
Это описывает параметры ключевых слов для поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...) и query('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
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 AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Конфигурация:
|
attribute строка | Атрибут, для которого необходимо получить значение(я). Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url, endpoint строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS. Псевдоним endpoint устарел и будет удален в релизе после 2024-12-01. Конфигурация: |
profile псевдонимы: aws_profile, boto_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. Псевдоним boto_profile устарел и будет удален в релизе после 2024-12-01. Конфигурация:
|
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Дополнительную информацию см. в документации 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 AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Конфигурация:
|
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access-токен 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. Настройка:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Таким образом, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). Смотрите https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
vars:
has_ec2_classic: "{{ lookup('aws_account_attribute', attribute='has-ec2-classic') }}"
# true | false
default_vpc_id: "{{ lookup('aws_account_attribute', attribute='default-vpc') }}"
# vpc-xxxxxxxx | none
account_details: "{{ lookup('aws_account_attribute', wantlist='true') }}"
# {'default-vpc': ['vpc-xxxxxxxx'], 'max-elastic-ips': ['5'], 'max-instances': ['20'],
# 'supported-platforms': ['VPC', 'EC2'], 'vpc-max-elastic-ips': ['5'], 'vpc-max-security-groups-per-interface': ['5']}
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение string | Возвращает логическое значение, когда attribute равно check_ec2_classic. В противном случае возвращает значение(я) атрибута (или все атрибуты, если один не указан). Возвращено: success |
Ссылки на сборку
© 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/amazon/aws/aws_account_attribute_lookup.html
