redshift_facts - Сбор фактов о кластере(ах) Redshift
Новая в версии 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Сбор фактов о кластере(ах) Redshift
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- boto
Параметры
| параметр | обязателен | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| aws_access_key | нет | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| cluster_identifier | нет | Префикс идентификатора кластера Redshift, который вы ищете. Это соответствие по регулярному выражению с неявным '^'. Добавьте '$' для полного соответствия. псевдонимы: name, identifier | ||
| ec2_url | нет | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. | ||
| profile (добавлен в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | нет | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_token (добавлен в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| tags | нет | Словарь/хеш тегов в формате { tag1_name: 'tag1_value', tag2_name: 'tag2_value' } для сопоставления с группой безопасности(ями), которую вы ищете. | ||
| validate_certs (добавлен в 1.5)
| нет | да |
| Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примеры
# Note: These examples do net set authentication details, see the AWS guide for details.
# Find all clusters
- redshift_facts:
register: redshift
# Find cluster(s) with matching tags
- redshift_facts:
tags:
env: prd
stack: monitoring
register: redshift_tags
# Find cluster(s) with matching name/prefix and tags
- redshift_facts:
tags:
env: dev
stack: web
name: user-
register: redshift_web
# Fail if no cluster(s) is/are found
- redshift_facts:
tags:
env: stg
stack: db
register: redshift_user
failed_when: "{{ redshift_user.results | length == 0 }}"
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для данного модуля:
| name | description | returned | type | sample |
|---|---|---|---|---|
| allow_version_upgrade | Логическое значение, которое, если истинно, указывает, что обновления основной версии будут автоматически применяться к кластеру во время окна обслуживания. | success | boolean | true|false |
| automated_snapshot_retention_period | Количество дней, в течение которого сохраняются автоматические снимки кластера. | success | int | 1 |
| availibility_zone | Имя зоны доступности, в которой расположен кластер. | success | string | us-east-1b |
| cluster_create_time | Дата и время создания кластера. | success | string | 2016-05-10T08:33:16.629000+00:00 |
| cluster_identifier | Уникальный ключ для идентификации кластера. | success | string | redshift-identifier |
| cluster_nodes | Узлы в кластере. | success | list | [{'private_ip_address': '10.0.0.1', 'public_ip_address': 'x.x.x.x', 'node_role': 'LEADER'}, {'private_ip_address': '10.0.0.3', 'public_ip_address': 'x.x.x.x', 'node_role': 'COMPUTE-1'}] |
| cluster_paramater_groups | Список параметров кластера, связанных с этим кластером. | success | list | [{'parameter_group_name': 'tuba', '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'}] |
| cluster_public_keys | Открытый ключ для кластера. | success | string | ssh-rsa anjigfam Amazon-Redshift |
| cluster_revision_number | Конкретный номер ревизии базы данных в кластере. | success | string | 1231 |
| cluster_security_groups | Список групп безопасности кластера, связанных с кластером. | success | list | [] |
| cluster_snapshot_copy_status | Значение, возвращающее целевой регион и срок хранения, настроенные для копирования снимков между регионами. | success | dict | {} |
| cluster_status | Текущее состояние кластера. | success | string | available |
| cluster_subnet_group_name | Название группы подсетей, связанной с кластером. | success | string | redshift-subnet |
| cluster_version | Идентификатор версии движка Amazon Redshift, работающего в кластере. | success | string | 1.0 |
| db_name | Имя начальной базы данных, созданной при создании кластера. | success | string | dev |
| elastic_ip_status | Состояние адреса Elastic IP (EIP). | success | dict | {} |
| encrypted | Логическое значение, которое, если истинно, указывает, что данные в кластере зашифрованы в состоянии покоя. | success | boolean | true|false |
| endpoint | Точка подключения. | success | string | {'port': 5439, 'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com'} |
| enhanced_vpc_routing | Параметр, который указывает, следует ли создавать кластер с включённым расширенным маршрутизацией VPC. | success | boolean | true|false |
| hsm_status | Значение, которое сообщает, завершил ли кластер Amazon Redshift применение любых изменений настроек модуля безопасности аппаратного обеспечения (HSM), указанных в команде модификации кластера. | success | dict | {} |
| iam_roles | Список ролей IAM, прикреплённых к кластеру. | success | list | [] |
| kms_key_id | Идентификатор ключа AWS Key Management Service (AWS KMS) используемого ключа шифрования для шифрования данных в кластере. | success | string | |
| master_username | Имя пользователя мастера для кластера. | success | string | admin |
| modify_status | Состояние операции модификации. | optional | string | |
| node_type | Тип узла для узлов в кластере. | success | string | ds2.xlarge |
| number_of_nodes | Количество вычислительных узлов в кластере. | success | int | 12 |
| pending_modified_values | Значение, которое, если присутствует, указывает, что изменения в кластере находятся в ожидании. | success | dict | {} |
| preferred_maintenance_window | Еженедельный интервал времени в универсальном координированном времени (UTC), в течение которого может выполняться техническое обслуживание системы. | success | string | tue:07:30-tue:08:00 |
| publicly_accessible | Логическое значение, которое, если истинно, указывает, что к кластеру можно получить доступ из публичной сети. | success | boolean | true|false |
| restore_status | Значение, описывающее состояние действия восстановления кластера. | success | dict | {} |
| tags | Список тегов для кластера. | success | list | [] |
| vpc_id | Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. | success | string | vpc-1234567 |
| vpc_security_groups | Список групп безопасности VPC, связанных с кластером. | success | list | [{'status': 'active', 'vpc_security_group_id': 'sg-12cghhg'}] |
Примечания
Примечание
- Если параметры не заданы внутри модуля, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует файл конфигурации boto (как правило, ~/.boto), если учетные данные не указаны. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы так расположены, пожалуйста, прочтите Справочная информация и помощь в разработке модулей сообщества, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/redshift_facts_module.html