Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Краткое описание

  • Получение информации об одном или нескольких кластерах RDS.
  • Этот модуль впервые добавлен в community.aws в выпуске 3.2.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

путь

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

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

aws_config

словарь

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

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

db_cluster_identifier

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

строка

Заданный пользователем идентификатор кластера БД.

Если указан этот параметр, возвращается информация только о конкретном кластере БД.

debug_botocore_endpoint_logs

логический

Использовать регистратор botocore.endpoint для подсчёта уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и выводить их список в ключе resource_actions результатов задачи. Используйте callback 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_DescribeDBClusters.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 info of all existing DB clusters
  amazon.aws.rds_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_cluster_info:
    cluster_id: "{{ cluster_id }}"
  register: _result_cluster_info

- name: Get info all DB clusters with specific engine
  amazon.aws.rds_cluster_info:
    engine: "aurora"
  register: _result_cluster_info

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

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

Ключ

Описание

clusters

list / elements=string

Список кластеров RDS.

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

activity_stream_status

string

Состояние потока активности базы данных.

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

Пример: "stopped"

allocated_storage

integer

Выделенный объем хранилища в гигабайтах. Поскольку размер хранилища Aurora не фиксирован, для движков баз данных Aurora это значение всегда равно 1.

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

Пример: 1

associated_roles

list / elements=string

Список словарей с ролями AWS Identity and Access Management (IAM), связанными с кластером БД. Каждый словарь содержит role_arn и состояние роли.

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

Пример: []

auto_minor_version_upgrade

boolean

Указывает, выполняется ли автоматическая установка минорных обновлений движка для кластера БД в течение окна обслуживания.

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

Пример: true

availability_zones

list / elements=string

Список зон доступности, в которых можно создавать экземпляры кластера БД.

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

Пример: ["us-east-1c", "us-east-1a", "us-east-1e"]

backup_retention_period

integer

Количество дней хранения автоматических снимков БД.

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

Пример: 1

cluster_create_time

string

Время создания кластера БД в формате UTC.

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

Пример: "2018-06-29T14:08:58.491000+00:00"

copy_tags_to_snapshot

boolean

Указывает, копируются ли теги с кластера БД на его снимки.

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

Пример: false

cross_account_clone

boolean

Указывает, является ли кластер БД клоном кластера БД, принадлежащего другой учетной записи Amazon Web Services.

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

Пример: false

db_cluster_arn

string

Имя ресурса Amazon (ARN) кластера БД.

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

Пример: "arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo"

db_cluster_identifier

string

Идентификатор кластера БД в нижнем регистре, заданный пользователем.

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

Пример: "rds-cluster-demo"

db_cluster_members

list / elements=string

Список словарей со сведениями об экземплярах в кластере. Каждый словарь содержит db_instance_identifier, is_cluster_writer (bool), db_cluster_parameter_group_status и promotion_tier (int).

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

Пример: []

db_cluster_parameter_group

string

Группа параметров, связанная с кластером БД.

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

Пример: "default.aurora5.6"

db_cluster_resource_id

string

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

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

Пример: "cluster-D2MEQDN3BQNXDF74K6DQJTHASU"

db_subnet_group

string

Имя группы подсетей, связанной с кластером БД.

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

Пример: "default"

deletion_protection

boolean

Указывает, включена ли для кластера БД защита от удаления. Если защита включена, удалить базу данных нельзя.

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

Пример: false

domain_memberships

list / elements=string

Записи о членстве в домене Active Directory, связанные с кластером БД.

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

Пример: []

earliest_restorable_time

string

Самый ранний момент времени, до которого можно восстановить базу данных с помощью восстановления на момент времени.

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

Пример: "2018-06-29T14:09:34.797000+00:00"

endpoint

string

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

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

Пример: "rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com"

engine

string

Движок базы данных кластера БД.

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

Пример: "aurora"

engine_mode

string

Режим работы движка БД кластера БД.

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

Пример: "provisioned"

engine_version

string

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

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

Пример: "5.6.10a"

hosted_zone_id

string

Идентификатор, который Amazon Route 53 присваивает при создании размещенной зоны.

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

Пример: "Z2R2ITUGPM61AM"

http_endpoint_enabled

boolean

Значение, указывающее, включена ли конечная точка HTTP для бессерверного кластера БД Aurora.

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

Пример: false

iam_database_authentication_enabled

boolean

Указывает, можно ли сопоставлять учетные записи IAM с учетными записями базы данных.

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

Пример: false

latest_restorable_time

string

Самый поздний момент времени, до которого можно восстановить базу данных с помощью восстановления на момент времени.

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

Пример: "2018-06-29T14:09:34.797000+00:00"

master_username

string

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

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

Пример: "username"

multi_az

boolean

Указывает, размещены ли экземпляры кластера БД в нескольких зонах доступности.

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

Пример: false

port

integer

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

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

Пример: 3306

preferred_backup_window

string

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

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

Пример: "10:18-10:48"

preferred_maintenance_window

string

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

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

Пример: "tue:03:23-tue:03:53"

read_replica_identifiers

list / elements=string

Список идентификаторов реплик для чтения, связанных с кластером БД.

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

Пример: []

reader_endpoint

string

Конечная точка для чтения кластера БД.

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

Пример: "rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com"

status

string

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

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

Пример: "available"

storage_encrypted

boolean

Указывает, зашифровано ли хранилище кластера БД.

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

Пример: false

tag_list

list / elements=dictionary

Список тегов в виде пар «ключ—значение».

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

Пример: [{"key": "Created_By", "value": "Ansible_rds_cluster_integration_test"}]

tags

dictionary

Словарь пар «ключ—значение».

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

Пример: {"Name": "rds-cluster-demo"}

vpc_security_groups

complex

Список групп безопасности кластера БД и их состояний.

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

status

string

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

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

Пример: "active"

vpc_security_group_id

string

Группа безопасности кластера.

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

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

Авторы

  • Alina Buzachis (@alinabuzachis)

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

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

© 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_cluster_info_module.html

Spec-Zone.ru

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