Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

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

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

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

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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 для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов, чтобы вывести в список всех вызовов, сделанных в ходе выполнения книги сценариев.

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

Варианты:

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

endpoint_url

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

строка

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

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

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

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

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 и security_token.

region

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

строка

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

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

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

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

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

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

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

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

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

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

Поддержка переменной среды 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.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

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

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

Пример: "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

ID подсети.

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

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

subnet_status

string

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

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

Пример: "Active"

vpc_id

string

ID VPC группы подсетей.

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

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

dbi_resource_id

string

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

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

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

deletion_protection

boolean

added in community.aws 3.3.0

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

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

Пример: false

domain_memberships

list / elements=string

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

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

Пример: []

endpoint

complex

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

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

address

string

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

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

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

hosted_zone_id

string

ID хостинговой зоны 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

Зарезервированное значение IOPS для экземпляра DB.

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

Пример: 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

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

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

Пример: 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

Включены ли показатели производительности.

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

Пример: 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

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

Список реплик чтения БД.

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

Пример: []

storage_encrypted

boolean

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

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

Пример: true

storage_type

строка

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

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

Пример: "gp2"

tags

сложный

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

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

vpc_security_groups

сложный

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

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

status

строка

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

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

Пример: "active"

vpc_security_group_id

строка

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

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

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

Авторы

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

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

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

© 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/rds_instance_info_module.html

Spec-Zone.ru

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