Spec-Zone.ru › Ansible

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

Примечание

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

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

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

строка

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

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

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_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 и 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.
END_OF_DOCUMENT_MARKER

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.

Также можно использовать переменные среды 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 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

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

Возвращается: успех

Пример: "stopped"

allocated_storage

integer

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

Возвращается: успех

Пример: 1

associated_roles

list / elements=string

Список словарей, содержащих информацию о ролях AWS Identity and Access Management (IAM), связанных с кластером DB. Каждый словарь содержит role_arn и статус роли.

Возвращается: успех

Пример: []

auto_minor_version_upgrade

boolean

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

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

Пример: true

availability_zones

list / elements=string

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

Возвращается: успех

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

backup_retention_period

integer

Количество дней, в течение которых сохраняются автоматические снимки DB.

Возвращается: успех

Пример: 1

cluster_create_time

string

Время в UTC, когда был создан кластер DB.

Возвращается: успех

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

copy_tags_to_snapshot

boolean

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

Возвращается: успех

Пример: false

cross_account_clone

boolean

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

Возвращается: успех

Пример: false

db_cluster_arn

string

Уникальное имя ресурса Amazon (ARN) для кластера DB.

Возвращается: успех

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

db_cluster_identifier

string

Указанный пользователем идентификатор кластера DB в нижнем регистре.

Возвращается: успех

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

db_cluster_members

list / elements=string

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

Возвращается: успех

Пример: []

db_cluster_parameter_group

string

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

Возвращается: успех

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

db_cluster_resource_id

string

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

Возвращается: успех

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

db_subnet_group

string

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

Возвращается: успех

Пример: "default"

deletion_protection

boolean

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

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

Пример: false

domain_memberships

list / elements=string

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

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

Пример: []

earliest_restorable_time

string

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

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

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

endpoint

string

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

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

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

engine

string

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

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

Пример: "aurora"

engine_mode

string

Режим движка DB кластера DB.

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

Пример: "provisioned"

engine_version

string

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

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

Пример: "5.6.10a"

hosted_zone_id

string

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

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

Пример: "Z2R2ITUGPM61AM"

http_endpoint_enabled

boolean

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

Возвращается: 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

Имя пользователя master для кластера DB.

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

Пример: "username"

multi_az

boolean

Есть ли у кластера DB экземпляры в нескольких зонах доступности.

Возвращается: 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

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

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

Возвращается: успех

Пример: []

reader_endpoint

строка

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

Возвращается: успех

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

status

строка

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

Возвращается: успех

Пример: "available"

storage_encrypted

булево

Зашифровано ли хранилище кластера БД.

Возвращается: успех

Пример: false

tag_list

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

Список тегов, состоящий из пар ключ-значение.

Возвращается: успех

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

tags

словарь

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

Возвращается: успех

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

vpc_security_groups

сложный

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

Возвращается: успех

status

строка

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

Возвращается: успех

Пример: "active"

vpc_security_group_id

строка

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

Возвращается: успех

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

Авторы

  • Alina Buzachis (@alinabuzachis)

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

  • Трекер проблем
  • Репозиторий (источники)
  • Общение

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

Spec-Zone.ru

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