Spec-Zone.ru › Ansible

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

Примечание

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

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • 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.

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.

global_cluster_identifier

строка

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

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

Этот параметр не чувствителен к регистру.

Если указан, должен соответствовать существующему 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 и 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

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, 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 ← (по умолчанию)

Примечания

Примечание

  • При разработке этого модуля CLI describe_global_cluster не предоставил информацию о тегах.
  • Вследствие этого параметр «tags» не включён в этот модуль.
  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов lookup и connection переменные окружения и файлы конфигурации считываются из контекста 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 DB, который в данный момент понижается и связан с этим состоянием.

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

Пример: "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 DB, который в данный момент повышается и связан с этим состоянием.

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

Пример: "arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"

gloabl_cluster_members

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

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

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

db_cluster_arn

строка

Идентификатор ресурса Amazon (ARN) для каждого кластера Aurora DB в глобальном кластере.

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

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

global_write_forwarding_status

строка

Состояние переадресации записи для вторичного кластера в глобальном кластере.

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

Пример: "disabled"

is_writer

булево

Указывает, является ли кластер Aurora DB первичным кластером для глобального кластера, с которым он связан.

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

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

string

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

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

Пример: "ansible-test-global-cluster"

global_cluster_resource_id

string

Уникальный, неизменяемый идентификатор глобального кластера баз данных, предоставляемый областью Amazon Web Services.

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

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

status

string

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

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

Пример: "available"

storage_encrypted

boolean

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

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

Пример: false

Авторы

  • Gomathi Selvi Srinivasan (@GomathiselviS)

Ссылки на сборки

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

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

Spec-Zone.ru

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