Spec-Zone.ru › Ansible 2.10

community.aws.rds_instance_facts – получение информации об одном или нескольких экземплярах RDS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в playbook укажите: community.aws.rds_instance_facts.

Новое в версии 1.0.0: из community.aws

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Получение информации об одном или нескольких экземплярах RDS.
  • Этот модуль назывался rds_instance_facts до Ansible 2.9. Использование не изменилось.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

  • boto
  • boto3
  • python >= 2.6
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_access_key и profile устарело и параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла сертификата CA, используемого для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: файл CA Bundle читается на стороне модуля и может потребоваться явное копирование его с контроллера, если он не используется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_secret_key и profile устарело и параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
db_instance_identifier
строка
Уникальный идентификатор экземпляра RDS.

псевдонимы: id
debug_botocore_endpoint_logs
логический
    Варианты:
  • нет ←
  • да
Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», производимых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения playbook. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если она существует.

псевдонимы: aws_endpoint_url, endpoint_url
filters
словарь
Фильтр, который определяет один или несколько экземпляров DB для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного использования их с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
строка
AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров security_token и profile устарело и параметры станут взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
validate_certs
логический
    Варианты:
  • нет
  • да ←
При значении "нет" SSL-сертификаты не будут проверятся для boto-версий >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это требуется, но это также можно настроить в конфигурационном файле boto

Примеры

- name: Get information about an instance
  community.aws.rds_instance_info:
    db_instance_identifier: new-database
  register: new_database_info

- name: Get all RDS instances
  community.aws.rds_instance_info:

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
instances
complex
всегда
Список экземпляров RDS
allocated_storage
integer
всегда
Гигабайты выделенного хранилища для базы данных

Пример:
10
auto_minor_version_upgrade
boolean
всегда
Автоматически ли происходят обновления до меньших версий

Пример:
True
availability_zone
string
всегда
Зона доступности, в которой находится база данных

Пример:
us-west-2b
backup_retention_period
integer
всегда
Дни, в течение которых хранятся резервные копии

Пример:
7
ca_certificate_identifier
string
всегда
Идентификатор сертификата CA

Пример:
rds-ca-2015
copy_tags_to_snapshot
boolean
всегда
Копировать ли метки БД в снимок
db_instance_arn
string
всегда
ARN экземпляра базы данных

Пример:
arn:aws:rds:us-west-2:111111111111:db:helloworld-rds
db_instance_class
string
всегда
Класс экземпляра базы данных

Пример:
db.t2.small
db_instance_identifier
string
всегда
Идентификатор экземпляра базы данных

Пример:
helloworld-rds
db_instance_port
integer
всегда
Порт, используемый экземпляром базы данных
db_instance_status
string
всегда
Статус экземпляра базы данных

Пример:
available
db_name
string
всегда
Имя базы данных

Пример:
management
db_parameter_groups
complex
всегда
Список групп параметров базы данных
db_parameter_group_name
string
всегда
Имя группы параметров базы данных

Пример:
psql-pg-helloworld
parameter_apply_status
string
всегда
Применена ли группа параметров

Пример:
in-sync
db_security_groups
list / elements=string
всегда
Список групп безопасности, используемых экземпляром базы данных
db_subnet_group
complex
всегда
список подсетей групп
db_subnet_group_description
string
всегда
Описание группы подсетей БД

Пример:
Моя группа подсетей базы данных
db_subnet_group_name
string
всегда
Имя группы подсетей базы данных

Пример:
my-subnet-group
subnet_group_status
string
всегда
Статус группы подсетей

Пример:
Завершено
subnets
complex
всегда
Список подсетей в группе подсетей
subnet_availability_zone
complex
всегда
Зона доступности подсети
name
string
всегда
Имя зоны доступности

Пример:
us-west-2c
subnet_identifier
string
всегда
Идентификатор подсети

Пример:
subnet-abcd1234
subnet_status
string
всегда
Статус подсети

Пример:
Активная
vpc_id
string
всегда
ID VPC группы подсетей

Пример:
vpc-abcd1234
dbi_resource_id
string
всегда
Уникальный, неизменяемый идентификатор экземпляра БД, уникальный для AWS-региона

Пример:
db-AAAAAAAAAAAAAAAAAAAAAAAAAA
domain_memberships
list / elements=string
всегда
Список членств в домене
endpoint
complex
всегда
Точка входа базы данных
address
string
всегда
Адрес точки входа базы данных

Пример:
helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com
hosted_zone_id
string
всегда
Идентификатор размещенной зоны Route53

Пример:
Z1PABCD0000000
port
integer
всегда
Порт точки входа базы данных

Пример:
5432
engine
string
всегда
Двигатель базы данных

Пример:
postgres
engine_version
string
всегда
Версия движка базы данных

Пример:
9.5.10
iam_database_authentication_enabled
boolean
всегда
Включена ли аутентификация базы данных через IAM
instance_create_time
string
всегда
Дата и время создания экземпляра

Пример:
2017-10-10T04:00:07.434000+00:00
kms_key_id
string
всегда
Идентификатор KMS-ключа

Пример:
arn:aws:kms:us-west-2:111111111111:key/abcd1234-0000-abcd-1111-0123456789ab
latest_restorable_time
string
всегда
Самое позднее время для восстановления базы данных с помощью точечного восстановления

Пример:
2018-05-17T00:03:56+00:00
license_model
string
всегда
Модель лицензии

Пример:
postgresql-license
master_username
string
всегда
Имя пользователя базы данных master

Пример:
dbadmin
monitoring_interval
integer
всегда
Интервал в секундах между моментами, когда собираются метрики мониторинга с улучшенной функциональностью для экземпляра базы данных
multi_az
boolean
всегда
Включен ли Multi-AZ
option_group_memberships
complex
всегда
Список групп параметров
option_group_name
string
всегда
Имя группы параметров

Пример:
default:postgres-9-5
статус
строка
всегда
Статус группы опций

Пример:
синхронизировано
pending_modified_values
сложное
всегда
Измененные значения, ожидающие применения
performance_insights_enabled
логическое
всегда
Включены ли данные о производительности
preferred_backup_window
строка
всегда
Предпочтительное время резервного копирования

Пример:
04:00-05:00
preferred_maintenance_window
строка
всегда
Предпочтительное время технического обслуживания

Пример:
вс:05:00-вс:05:30
publicly_accessible
логическое
всегда
База данных доступна для общего доступа
read_replica_db_instance_identifiers
список / элементы=строка
всегда
Список экземпляров базы данных чтений-реплик
storage_encrypted
логическое
всегда
Зашифрован ли хранилище

Пример:
True
storage_type
строка
всегда
Тип хранилища экземпляра базы данных

Пример:
gp2
tags
сложное
всегда
Теги, используемые экземпляром базы данных
vpc_security_groups
сложное
всегда
Список групп безопасности VPC
статус
строка
всегда
Статус группы безопасности VPC

Пример:
активно
vpc_security_group_id
строка
всегда
ID группы безопасности VPC

Пример:
sg-abcd1234


Авторы

  • Уильям Тамс (@willthames)
  • Майкл де ла Ру (@mikedlr)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/rds_instance_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API