amazon.aws.aws_rds инвентаризация – Источник инвентаризации экземпляров RDS

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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.

Конфигурация:

• Переменная окружения: AWS_ACCESS_KEY_ID
• Переменная окружения: AWS_ACCESS_KEY

• Переменная окружения: EC2_ACCESS_KEY

  Удалено в: основном релизе после 2024-12-01

  Почему: EC2 в названии подразумевало ограничение ресурсами EC2. Однако, он используется для всех соединений.

  Альтернатива: AWS_ACCESS_KEY_ID

assume_role_arn

aliases: iam_role_arn

string

ARN роли IAM, которую необходимо принять для выполнения поиска.

Вы все равно должны предоставить учетные данные AWS с достаточными правами для выполнения действия AssumeRole.

cache

boolean

Переключатель для включения/выключения кэширования исходных данных инвентаризации, для работы требуется настройка плагина кэша.

Варианты:

• false ← (по умолчанию)
• true

Конфигурация:

• Запись INI:

  [inventory]
  cache = false
  

• Переменная окружения: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Данные или путь подключения кэша, см. документацию плагина кэша для получения подробной информации.

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_connection = VALUE
  

  [inventory]
  cache_connection = VALUE
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_CONNECTION
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Плагин кэша, который нужно использовать для исходных данных инвентаризации.

По умолчанию: "memory"

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching = memory
  

  [inventory]
  cache_plugin = memory
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Префикс для использования в файлах/таблицах плагина кэша

По умолчанию: "ansible_inventory_"

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_prefix = ansible_inventory_
  

  [inventory]
  cache_prefix = ansible_inventory_
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_PREFIX
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Продолжительность кэша в секундах

По умолчанию: 3600

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_timeout = 3600
  

  [inventory]
  cache_timeout = 3600
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_TIMEOUT
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

Создать переменные из выражений jinja2.

По умолчанию: {}

endpoint_url

aliases: aws_endpoint_url, endpoint

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Псевдоним endpoint устарел и будет удален в релизе после 2024-12-01.

Конфигурация:

• Переменная окружения: AWS_URL

• Переменная окружения: EC2_URL

  Удалено в: основном релизе после 2024-12-01

  Почему: EC2 в названии подразумевало ограничение ресурсами EC2. Однако, он используется для всех соединений.

  Альтернатива: AWS_URL

filters

string

Словарь пар значений фильтров. Доступные фильтры перечислены здесь https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html#options. Если вы фильтруете по db-cluster-id и include_clusters равно True, это также будет применяться к кластерам.

По умолчанию: {}

groups

dictionary

Добавить хосты в группу на основе условных выражений Jinja2.

По умолчанию: {}

hostvars_prefix

строка

добавлено в amazon.aws 3.1.0

Префикс для имён переменных хоста, полученных из AWS.

hostvars_suffix

строка

добавлено в amazon.aws 3.1.0

Суффикс для имён переменных хоста, полученных из AWS.

include_clusters

булево

Включать ли запросы к кластерам Aurora наряду с экземплярами.

Варианты:

• false ← (по умолчанию)
• true

keyed_groups

список / элементы=словарь

Добавлять хосты в группу на основе значений переменной.

По умолчанию: []

default_value

строка

добавлено в ansible-core 2.12

Значение по умолчанию, когда значение переменной хоста — пустая строка.

Этот параметр взаимоисключающий с keyed_groups[].trailing_separator.

key

строка

Ключ из входного словаря, используемый для создания групп

parent_group

строка

родительская группа для keyed group

prefix

строка

Имя keyed группы будет начинаться с этого префикса

По умолчанию: ""

separator

строка

Разделитель, используемый для построения имени keyed группы

По умолчанию: "_"

trailing_separator

булево

добавлено в ansible-core 2.12

Установите этот параметр в False, чтобы опустить keyed_groups[].separator после переменной хоста, когда значение является пустой строкой.

Этот параметр взаимоисключающий с keyed_groups[].default_value.

Варианты:

• false
• true ← (по умолчанию)

leading_separator

булево

добавлено в ansible-core 2.11

Используется совместно с keyed_groups.

По умолчанию, имя keyed группы, не имеющей префикса или разделителя, начинается с нижнего подчёркивания.

Это происходит потому, что префикс по умолчанию — пустая строка, а разделитель — “_”.

Установите этот параметр в False, чтобы опустить ведущее нижнее подчёркивание (или другой разделитель), если префикс не указан.

Если имя группы получено из отображения, разделитель по-прежнему используется для конкатенации элементов.

Для того, чтобы вообще не использовать разделитель в имени группы, установите разделитель keyed группы в пустую строку.

Варианты:

• false
• true ← (по умолчанию)

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.

Настройка:

• Переменная среды: AWS_PROFILE
• Переменная среды: AWS_DEFAULT_PROFILE

region

алиасы: aws_region, ec2_region

строка

AWS регион для использования.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Настройка:

• Переменная среды: AWS_REGION

• Переменная среды: EC2_REGION

  Удалили в: основной релиз после 2024-12-01

  Почему: EC2 в названии предполагало ограничение EC2 ресурсами, тогда как используется для всех соединений

  Альтернатива: AWS_REGION

regions

строка

Список регионов, в которых описываются экземпляры и кластеры RDS. Доступные регионы перечислены здесь https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html.

По умолчанию: []

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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.

Настройка:

• Переменная среды: AWS_SECRET_ACCESS_KEY
• Переменная среды: AWS_SECRET_KEY

• Переменная среды: EC2_SECRET_KEY

  Удалено в: основной релиз после 2024-12-01

  Почему: EC2 в названии предполагало ограничение на ресурсы EC2. Однако используется для всех подключений.

  Альтернатива: AWS_SECRET_ACCESS_KEY

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сессии AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации о маркерах доступа 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.

Настройка:

• Переменная среды: AWS_SESSION_TOKEN

• Переменная среды: AWS_SECURITY_TOKEN

  Удалено в: основной релиз после 2024-12-01

  Почему: AWS_SECURITY_TOKEN использовался для совместимости с исходным SDK boto, поддержка которого прекращена

  Альтернатива: AWS_SESSION_TOKEN

• Переменная среды: EC2_SECURITY_TOKEN

  Удалено в: основной релиз после 2024-12-01

  Почему: EC2 в названии предполагало ограничение на ресурсы EC2. Однако используется для всех подключений.

  Альтернатива: AWS_SESSION_TOKEN

statuses

list / elements=string

Список желаемых состояний экземпляров/кластеров для добавления в инвентарь. Установлено в [‘all’] в качестве сокращения для поиска всего.

По умолчанию: ["creating", "available"]

strict

boolean

Если yes сделать недопустимые записи ошибкой, в противном случае пропустить и продолжить.

Поскольку в выражениях можно использовать факты, они могут быть недоступны, и мы по умолчанию игнорируем эти ошибки.

Варианты:

• false ← (по умолчанию)
• true

strict_permissions

boolean

По умолчанию, если возникает исключение AccessDenied, этот плагин завершится ошибкой. Вы можете установить strict_permissions в False в файле конфигурации инвентаризации, чтобы разрешить игнорирование ограничений.

Варианты:

• false
• true ← (по умолчанию)

use_extra_vars

boolean

added in ansible-core 2.11

Объединить дополнительные переменные в доступные переменные для композиции (самый высокий приоритет).

Варианты:

• false ← (по умолчанию)
• true

Настройка:

• Запись INI:

  [inventory_plugins]
  use_extra_vars = false
  

• Переменная среды: ANSIBLE_INVENTORY_USE_EXTRA_VARS