Модуль amazon.aws.rds_global_cluster_info — получение информации о глобальных кластерах баз данных Aurora

Примечание

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

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

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

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

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

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

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

Получение информации о глобальных кластерах баз данных Aurora.

Требования

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

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 botocore SDK.
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.
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`.
global_cluster_identifier строка	Заданный пользователем идентификатор глобального кластера БД. Если этот параметр указан, возвращаются сведения только о соответствующем кластере БД. Этот параметр не чувствителен к регистру. Если параметр указан, его значение должно совпадать с существующим DBClusterIdentifier.
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 botocore SDK.
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` ← (по умолчанию)

Примечания

Примечание

Во время разработки этого модуля команда describe_global_cluster CLI не возвращала сведения о тегах.
Поэтому параметр «tags» не включен в этот модуль.
Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» 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_global_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_global_cluster_info:
    global_cluster_identifier: "{{ cluster_id }}"
  register: _result_global_cluster_info

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

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

Ключ	Описание
global_clusters список / элементы=словарь	Список глобальных кластеров. Возвращается: всегда
deletion_protection логическое значение	Показывает, включена ли для кластера БД защита от удаления. Если защита от удаления включена, базу данных нельзя удалить. Возвращается: всегда Пример: `false`
engine строка	Ядро базы данных кластера БД. Возвращается: всегда Пример: `"aurora-postgresql"`
engine_version строка	Версия ядра базы данных. Возвращается: всегда Пример: `"14.8"`
failover_state словарь	Объект данных со всеми свойствами текущего состояния выполняющегося или ожидающего переключения либо аварийного переключения для этого глобального кластера (глобальной базы данных Aurora). Этот объект пуст, если для данного глобального кластера не была вызвана операция SwitchoverGlobalCluster или FailoverGlobalCluster. Возвращается: при успешном выполнении
from_db_cluster_arn строка	Имя ресурса Amazon (ARN) кластера БД Aurora, который в данный момент понижается и связан с этим состоянием. Возвращается: всегда Пример: `"arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"`
is_data_loss_allowed логическое значение	Показывает, является ли операция глобальным переключением или глобальным аварийным переключением. Если потеря данных допустима, операция является глобальным аварийным переключением. В противном случае это переключение. Возвращается: всегда Пример: `false`
status строка	Текущее состояние глобального кластера. Возвращается: всегда Пример: `"pending"`
to_db_cluster_arn строка	Имя ресурса Amazon (ARN) кластера БД Aurora, который в данный момент повышается и связан с этим состоянием. Возвращается: всегда Пример: `"arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"`
gloabl_cluster_members список / элементы=словарь	Список первичных и вторичных кластеров в глобальном кластере базы данных. Возвращается: при успешном выполнении
db_cluster_arn строка	Имя ресурса Amazon (ARN) каждого кластера БД Aurora в глобальном кластере. Возвращается: всегда Пример: `"arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"`
global_write_forwarding_status строка	Состояние перенаправления операций записи для вторичного кластера в глобальном кластере. Возвращается: всегда Пример: `"disabled"`
is_writer логическое значение	Показывает, является ли кластер БД Aurora первичным кластером связанного с ним глобального кластера. Возвращается: всегда Пример: `false`
readers список / элементы=строка	Имя ресурса Amazon (ARN) каждого связанного с глобальным кластером вторичного кластера, доступного только для чтения. Возвращается: всегда Пример: `["arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"]`
global_cluster_arn строка	Имя ресурса Amazon (ARN) глобального кластера базы данных. Возвращается: всегда Пример: `"arn:aws:rds::123456789012:global-cluster:ansible-test-global-cluster"`
global_cluster_identifier строка	Заданный пользователем идентификатор глобального кластера базы данных. Возвращается: при успешном выполнении Пример: `"ansible-test-global-cluster"`
global_cluster_resource_id строка	Уникальный для региона Amazon Web Services неизменяемый идентификатор глобального кластера базы данных. Возвращается: всегда Пример: `"cluster-123456789012"`
status строка	Состояние кластера БД. Возвращается: всегда Пример: `"available"`
storage_encrypted логическое значение	Зашифровано ли хранилище кластера БД. Возвращается: всегда Пример: `false`

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)

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

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