community.aws.redshift_info – Сбор информации о кластере(ах) Redshift

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.redshift_info.

Добавлено в версии 1.0.0: модуля community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о кластере(ах) Redshift.
Этот модуль назывался redshift_facts до Ansible 2.9. Использование не изменилось.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и станет взаимоисключающим после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с сертификатами CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл с сертификатами CA читается со стороны модуля и может потребоваться его явное копирование с контроллера, если он не запущен локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и станет взаимоисключающим после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cluster_identifier строка		Префикс идентификатора кластера Redshift, который вы ищете. Это регулярное выражение с неявным '^'. Добавьте '$' для полного совпадения. псевдонимы: name, identifier
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в список всех API-вызовов, выполненных во время плейбука.
ec2_url строка		Адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременного передачи с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Секретный токен AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и станет взаимоисключающим после 2022-06-01. псевдонимы: aws_security_token, access_token
tags словарь		Словарь тегов в формате { имя_тега1: 'значение_тега1', имя_тега2: 'значение_тега2' } для сопоставления с целевыми группами безопасности.
validate_certs логический	Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE.
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto.

Примеры

# Note: These examples do net set authentication details, see the AWS guide for details.

- name: Find all clusters
  community.aws.redshift_info:
  register: redshift

- name: Find cluster(s) with matching tags
  community.aws.redshift_info:
    tags:
      env: prd
      stack: monitoring
  register: redshift_tags

- name: Find cluster(s) with matching name/prefix and tags
  community.aws.redshift_info:
    tags:
      env: dev
      stack: web
    name: user-
  register: redshift_web

- name: Fail if no cluster(s) is/are found
  community.aws.redshift_info:
    tags:
      env: stg
      stack: db
  register: redshift_user
  failed_when: "{{ redshift_user.results | length == 0 }}"

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

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

Ключ	Возвращаемое значение	Описание
allow_version_upgrade boolean	успех	Булево значение, которое, если равно true, указывает, что апгрейды основных версий будут автоматически применяться к кластеру во время окна обслуживания. Пример: true\|false
automated_snapshot_retention_period integer	успех	Количество дней, в течение которого сохраняются автоматические снимки кластера. Пример: 1
availability_zone string	успех	Название зоны доступности, в которой расположен кластер. Пример: us-east-1b
cluster_create_time string	успех	Дата и время создания кластера. Пример: 2016-05-10T08:33:16.629000+00:00
cluster_identifier string	успех	Уникальный ключ для идентификации кластера. Пример: redshift-identifier
cluster_nodes list / elements=string	успех	Узлы в кластере. Пример: [{'node_role': 'LEADER', 'private_ip_address': '10.0.0.1', 'public_ip_address': 'x.x.x.x'}, {'node_role': 'COMPUTE-1', 'private_ip_address': '10.0.0.3', 'public_ip_address': 'x.x.x.x'}]
cluster_paramater_groups list / elements=string	успех	Список параметров кластера, связанных с этим кластером. Пример: [{'cluster_parameter_status_list': [{'parameter_apply_status': 'in-sync', 'parameter_name': 'statement_timeout'}, {'parameter_apply_status': 'in-sync', 'parameter_name': 'require_ssl'}], 'parameter_apply_status': 'in-sync', 'parameter_group_name': 'tuba'}]
cluster_public_keys string	успех	Открытый ключ для кластера. Пример: ssh-rsa anjigfam Amazon-Redshift
cluster_revision_number string	успех	Конкретный номер версии базы данных в кластере. Пример: 1231
cluster_security_groups list / elements=string	успех	Список групп безопасности кластера, связанных с кластером.
cluster_snapshot_copy_status dictionary	успех	Значение, которое возвращает целевой регион и срок хранения, настроенные для копирования снимков между регионами.
cluster_status string	успех	Текущее состояние кластера. Пример: available
cluster_subnet_group_name string	успех	Имя группы подсетей, связанной с кластером. Пример: redshift-subnet
cluster_version string	успех	Идентификатор версии движка Amazon Redshift, работающего в кластере. Пример: 1.0
db_name string	успех	Имя начальной базы данных, созданной при создании кластера. Пример: dev
elastic_ip_status dictionary	успех	Состояние адреса Elastic IP (EIP).
encrypted boolean	успех	Булево значение, которое, если равно true, указывает, что данные в кластере зашифрованы в состоянии покоя. Пример: true\|false
endpoint string	успех	Точка подключения. Пример: {'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439}
enhanced_vpc_routing boolean	успех	Параметр, указывающий, включить ли расширенное маршрутирование VPC при создании кластера. Пример: true\|false
hsm_status dictionary	успех	Значение, которое сообщает, завершил ли Amazon Redshift кластер применение любых изменений настроек модулей аппаратной безопасности (HSM), указанных в команде изменения кластера.
iam_roles list / elements=string	успех	Список ролей IAM, присоединенных к кластеру.
kms_key_id string	успех	Идентификатор ключа AWS Key Management Service (AWS KMS), используемого для шифрования данных в кластере.
master_username string	успех	Имя пользователя мастера для кластера. Пример: admin
modify_status string	необязательно	Состояние операции изменения.
node_type string	успех	Тип узла для узлов в кластере. Пример: ds2.xlarge
number_of_nodes integer	успех	Количество вычислительных узлов в кластере. Пример: 12
pending_modified_values dictionary	успех	Значение, которое, если присутствует, указывает на то, что изменения в кластере находятся в ожидании.
preferred_maintenance_window string	успех	Еженедельный интервал времени в формате UTC, в течение которого может происходить техническое обслуживание системы. Пример: tue:07:30-tue:08:00
publicly_accessible boolean	успех	Булево значение, которое, если равно true, указывает, что к кластеру можно получить доступ из общедоступной сети. Пример: true\|false
restore_status dictionary	успех	Значение, описывающее состояние действия восстановления кластера.
tags list / elements=string	успех	Список тегов для кластера.
vpc_id string	успех	Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. Пример: vpc-1234567
vpc_security_groups list / elements=string	успех	Список групп безопасности VPC, связанных с кластером. Пример: [{'status': 'active', 'vpc_security_group_id': 'sg-12cghhg'}]

Авторы

Jens Carl (@j-carl)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/redshift_info_module.html