Spec-Zone.ru › Ansible

Модуль community.aws.redshift_info — сбор сведений о кластере (кластерах) Redshift

Примечание

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

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

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

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

Добавлено в community.aws 1.0.0

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

Обзор

  • Сбор сведений о кластере (кластерах) Redshift.

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа 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 SDK botocore.

aws_ca_bundle

path

Путь к пакету сертификатов CA, используемому для проверки сертификатов SSL.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cluster_identifier

псевдонимы: name, identifier

string

Префикс идентификатора искомого кластера Redshift.

Выполняется сопоставление с регулярным выражением с неявным символом «^». Добавьте «$» для точного совпадения.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить этот набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список, сформированный за время выполнения плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, однако коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

profile

псевдонимы: aws_profile

string

Именованный профиль 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

string

Регион 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

string

Секретный ключ доступа 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 SDK botocore.

session_token

псевдонимы: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

tags

dictionary

Словарь/хеш тегов в формате { tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’ } для сопоставления с искомыми группами безопасности.

validate_certs

boolean

Если задано значение false, проверка сертификатов SSL при обмене данными с API AWS выполняться не будет.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# 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\n"

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

Состояние эластичного 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/redshift_info_module.html

Spec-Zone.ru

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