Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_instance_info — получение сведений об одном или нескольких экземплярах RDS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: amazon.aws.rds_instance_info.

Добавлен в amazon.aws 5.0.0

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

Обзор

  • Получение сведений об одном или нескольких экземплярах RDS.
  • Этот модуль был впервые добавлен в community.aws в выпуске 1.0.0.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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_ID или AWS_ACCESS_KEY (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

aws_ca_bundle

путь

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

db_instance_identifier

псевдонимы: id

строка

Уникальный идентификатор экземпляра RDS.

debug_botocore_endpoint_logs

логическое значение

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и вывода их списка в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе сценария.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

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

Также можно использовать переменную среды AWS_URL.

filters

словарь

Фильтр, указывающий один или несколько экземпляров БД для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

region

псевдонимы: aws_region

строка

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

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

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

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

session_token

псевдонимы: aws_session_token

строка

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

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

validate_certs

логическое значение

Если установлено значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать параметр aws_ca_bundle.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительную информацию см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

- name: Get all RDS instances
  amazon.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

Копируются ли теги базы данных в снимок.

Возвращается: всегда

Пример: false

db_instance_arn

string

ARN экземпляра базы данных.

Возвращается: всегда

Пример: "arn:aws:rds:us-west-2:123456789012:db:helloworld-rds"

db_instance_class

string

Класс экземпляра базы данных.

Возвращается: всегда

Пример: "db.t3.small"

db_instance_identifier

string

Идентификатор экземпляра базы данных.

Возвращается: всегда

Пример: "helloworld-rds"

db_instance_port

integer

Порт, используемый экземпляром базы данных.

Возвращается: всегда

Пример: 0

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

Описание группы подсетей БД.

Возвращается: всегда

Пример: "My database subnet group"

db_subnet_group_name

string

Имя группы подсетей базы данных.

Возвращается: всегда

Пример: "my-subnet-group"

subnet_group_status

string

Статус группы подсетей.

Возвращается: всегда

Пример: "Complete"

subnets

complex

Список подсетей в группе подсетей.

Возвращается: всегда

subnet_availability_zone

complex

Зона доступности подсети.

Возвращается: всегда

name

string

Имя зоны доступности.

Возвращается: всегда

Пример: "us-west-2c"

subnet_identifier

string

Идентификатор подсети.

Возвращается: всегда

Пример: "subnet-abcd1234"

subnet_status

string

Статус подсети.

Возвращается: всегда

Пример: "Active"

vpc_id

string

Идентификатор VPC группы подсетей.

Возвращается: всегда

Пример: "vpc-abcd1234"

dbi_resource_id

string

Уникальный для региона AWS неизменяемый идентификатор экземпляра БД.

Возвращается: всегда

Пример: "db-AAAAAAAAAAAAAAAAAAAAAAAAAA"

deletion_protection

boolean

добавлено в community.aws 3.3.0

True, если для экземпляра БД включена защита от удаления, и False, если нет.

Возвращается: всегда

Пример: false

domain_memberships

list / elements=string

Список членств в доменах.

Возвращается: всегда

Пример: []

endpoint

complex

Конечная точка базы данных

Возвращается: всегда

address

string

Адрес конечной точки базы данных.

Возвращается: всегда

Пример: "helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com"

hosted_zone_id

string

Идентификатор размещённой зоны Route 53.

Возвращается: всегда

Пример: "Z1PABCD0000000"

port

integer

Порт конечной точки базы данных.

Возвращается: всегда

Пример: 5432

engine

string

Ядро базы данных.

Возвращается: всегда

Пример: "postgres"

engine_version

string

Версия ядра базы данных.

Возвращается: всегда

Пример: "9.5.10"

iam_database_authentication_enabled

boolean

Включена ли аутентификация в базе данных через IAM.

Возвращается: всегда

Пример: false

instance_create_time

string

Дата и время создания экземпляра.

Возвращается: всегда

Пример: "2017-10-10T04:00:07.434000+00:00"

iops

integer

Значение Provisioned IOPS для экземпляра БД.

Возвращается: всегда

Пример: 1000

kms_key_id

string

Идентификатор ключа KMS.

Возвращается: всегда

Пример: "arn:aws:kms:us-west-2:123456789012: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

Имя главного пользователя базы данных.

Возвращается: всегда

Пример: "dbadmin"

monitoring_interval

integer

Интервал в секундах между сбором метрик расширенного мониторинга для экземпляра БД.

Возвращается: всегда

Пример: 0

multi_az

boolean

Включён ли режим Multi-AZ.

Возвращается: всегда

Пример: false

option_group_memberships

complex

Список групп параметров.

Возвращается: всегда

option_group_name

string

Имя группы параметров.

Возвращается: всегда

Пример: "default:postgres-9-5"

status

string

Статус группы параметров.

Возвращается: всегда

Пример: "in-sync"

pending_modified_values

complex

Изменённые значения, ожидающие применения.

Возвращается: всегда

performance_insights_enabled

boolean

Включена ли функция Performance Insights.

Возвращается: всегда

Пример: false

preferred_backup_window

string

Предпочтительное время резервного копирования.

Возвращается: всегда

Пример: "04:00-05:00"

preferred_maintenance_window

string

Предпочтительное время обслуживания.

Возвращается: всегда

Пример: "mon:05:00-mon:05:30"

publicly_accessible

boolean

Доступна ли база данных из общедоступной сети.

Возвращается: всегда

Пример: false

read_replica_db_instance_identifiers

list / elements=string

Список реплик экземпляра базы данных для чтения.

Возвращается: всегда

Пример: []

storage_encrypted

boolean

Зашифровано ли хранилище.

Возвращается: всегда

Пример: true

storage_type

string

Тип хранилища экземпляра базы данных.

Возвращается: всегда

Пример: "gp2"

tags

complex

Теги, используемые экземпляром базы данных.

Возвращается: всегда

vpc_security_groups

complex

Список групп безопасности VPC.

Возвращается: всегда

status

string

Статус группы безопасности VPC.

Возвращается: всегда

Пример: "active"

vpc_security_group_id

string

Идентификатор группы безопасности VPC.

Возвращается: всегда

Пример: "sg-abcd1234"

Авторы

  • Will Thames (@willthames)
  • Michael De La Rue (@mikedlr)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/rds_instance_info_module.html

Spec-Zone.ru

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