amazon.aws.aws_rds – rds instance source
Примечание
Этот плагин входит в состав коллекции amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws.
Для использования в playbook, укажите: amazon.aws.aws_rds.
Обзор
- Получение экземпляров и кластеров из Amazon Web Services RDS.
- Использует файл конфигурации YAML, который заканчивается на aws_rds.(yml|yaml).
Требования
Ниже приведены требования к локальному контроллеру, на котором выполняется этот инвентаризационный инструмент.
- boto3
- botocore
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| aws_access_key строка | env:EC2_ACCESS_KEY env:AWS_ACCESS_KEY env:AWS_ACCESS_KEY_ID | Используемый AWS ключ доступа. псевдонимы: aws_access_key_id | |
| aws_profile строка | env:AWS_DEFAULT_PROFILE env:AWS_PROFILE | AWS профиль псевдонимы: boto_profile | |
| aws_secret_key строка | env:EC2_SECRET_KEY env:AWS_SECRET_KEY env:AWS_SECRET_ACCESS_KEY | AWS секретный ключ, соответствующий ключу доступа. псевдонимы: aws_secret_access_key | |
| aws_security_token строка | env:EC2_SECURITY_TOKEN env:AWS_SESSION_TOKEN env:AWS_SECURITY_TOKEN | AWS токен безопасности, если используются временные ключи доступа и секретные ключи. | |
| cache логическое |
| записи ini: [inventory] env:ANSIBLE_INVENTORY_CACHE | Включить/выключить кэширование исходных данных инвентаризации, для работы требуется настройка плагина кэша. |
| cache_connection строка | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN_CONNECTION env:ANSIBLE_INVENTORY_CACHE_CONNECTION | Данные или путь к подключению к кэшу, для получения подробностей обратитесь к документации плагина кэша. | |
| cache_plugin строка | По умолчанию: "memory" | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN env:ANSIBLE_INVENTORY_CACHE_PLUGIN | Плагин кэша для использования исходных данных инвентаризации. |
| cache_prefix строка | По умолчанию: "ansible_inventory_" | записи ini: [default] [inventory] env:ANSIBLE_CACHE_PLUGIN_PREFIX env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX | Префикс, используемый для файлов/таблиц плагина кэша |
| cache_timeout целое число | По умолчанию: 3600 | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN_TIMEOUT env:ANSIBLE_INVENTORY_CACHE_TIMEOUT | Срок хранения кэша в секундах |
| compose словарь | По умолчанию: {} | Создание переменных из выражений jinja2. | |
| filters строка | По умолчанию: {} | Словарь пар значений фильтра. Доступные фильтры перечислены здесь https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html#options. Если вы фильтруете по db-cluster-id и include_clusters имеет значение True, он будет применяться и к кластерам. | |
| groups словарь | По умолчанию: {} | Добавление хостов в группу на основе условных выражений Jinja2. | |
| iam_role_arn строка | ARN роли IAM для выполнения поиска инвентаризации. Вы по-прежнему должны предоставить AWS учетные данные с достаточными привилегиями для выполнения действия AssumeRole. | ||
| include_clusters логическое |
| Включать ли запросы к Aurora кластерам, а также экземплярам | |
| keyed_groups список / элементы=строка | По умолчанию: [] | Добавление хостов в группу на основе значений переменной. | |
| leading_separator логическое добавлен в версии 2.11 ansible.builtin |
| Используйте вместе с keyed_groups. По умолчанию, у ключированной группы, у которой нет префикса или разделителя, будет имя, начинающееся с нижнего подчеркивания. Это потому, что префикс по умолчанию "" и разделитель по умолчанию "_". Установите этот параметр в False, чтобы опустить ведущий знак подчеркивания (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель все равно используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключированной группы на пустую строку вместо этого. | |
| regions строка | По умолчанию: [] | Список регионов, в которых нужно описать экземпляры и кластеры RDS. Доступные регионы перечислены здесь https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
| |
| statuses список / элементы=строка | По умолчанию: ["creating", "available"] | Список желаемых состояний экземпляров/кластеров, которые будут добавлены в инвентарь. Установите в ['all'] для краткого поиска всего. | |
| strict логическое |
| Если yes, то невалидные записи будут ошибкой, иначе пропустить и продолжить.Поскольку фактический возможности использовать выражения, они не всегда доступны, поэтому эти ошибки игнорируются по умолчанию. | |
| strict_permissions логическое |
| По умолчанию, если возникает исключение AccessDenied, этот плагин завершит работу. Вы можете установить strict_permissions в False в файле конфигурации инвентаризации, что позволит без проблем пропустить ограничения. | |
| use_extra_vars логическое добавлен в версии 2.11 ansible.builtin |
| записи ini: [inventory_plugins] env:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединить дополнительные переменные с доступными переменными для композиции (высший приоритет). |
Примеры
plugin: aws_rds
regions:
- us-east-1
- ca-central-1
keyed_groups:
- key: 'db_parameter_groups|json_query("[].db_parameter_group_name")'
prefix: rds_parameter_group
- key: engine
prefix: rds
- key: tags
- key: region
Авторы
- Sloane Hertel (@s-hertel)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/amazon/aws/aws_rds_inventory.html
