Модуль community.aws.redshift_info — Сбор информации о кластере(ах) Redshift
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.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.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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение пакета CA, используемого при проверке SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
cluster_identifier псевдонимы: name, identifier строка | Префикс идентификатора кластера Redshift, который вы ищете. Это сопоставление с регулярным выражением с неявным соответствием «^». Для полного соответствия добавьте «$». |
debug_botocore_endpoint_logs логический | Используйте Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | AWS-регион для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним 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. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
Теги словарь | Словарь/хеш тегов в формате { имя_тега1: ‘значение_тега1’, имя_тега2: ‘значение_тега2’ } для сопоставления с группой(ами) безопасности, которые вы ищете. |
validate_certs булево | Если установлено в Установление validate_certs=false категорически не рекомендуется; вместо этого рассмотрите установку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы, возможно, нужно будет явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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 | Логическое значение, которое, если истинно, указывает на то, что обновления основных версий будут применяться автоматически к кластеру в течение окна обслуживания. Возвращается: success Пример: |
automated_snapshot_retention_period integer | Количество дней, в течение которых сохраняются автоматические снимки кластера. Возвращается: success Пример: |
availability_zone string | Имя зоны доступности, в которой расположен кластер. Возвращается: success Пример: |
cluster_create_time string | Дата и время создания кластера. Возвращается: success Пример: |
cluster_identifier string | Уникальный ключ для идентификации кластера. Возвращается: success Пример: |
cluster_nodes list / elements=string | Узлы в кластере. Возвращается: success Пример: |
cluster_paramater_groups list / elements=string | Список параметров кластера, связанных с этим кластером. Возвращается: success Пример: |
cluster_public_keys string | Открытый ключ для кластера. Возвращается: success Пример: |
cluster_revision_number string | Конкретный номер ревизии базы данных в кластере. Возвращается: success Пример: |
cluster_security_groups list / elements=string | Список групп безопасности кластера, связанных с кластером. Возвращается: success Пример: |
cluster_snapshot_copy_status dictionary | Значение, возвращающее регион назначения и период хранения, которые настроены для копирования снимков между регионами. Возвращается: success Пример: |
cluster_status string | Текущее состояние кластера. Возвращается: success Пример: |
cluster_subnet_group_name string | Имя подгруппы подсети, связанной с кластером. Возвращается: success Пример: |
cluster_version string | Идентификатор версии движка Amazon Redshift, работающего в кластере. Возвращается: success Пример: |
db_name string | Имя начальной базы данных, созданной при создании кластера. Возвращается: success Пример: |
elastic_ip_status dictionary | Статус адреса эластичного IP (EIP). Возвращается: success Пример: |
encrypted boolean | Булево значение, которое, если истинно, указывает на то, что данные в кластере зашифрованы в состоянии покоя. Returned: success Sample: |
endpoint string | Конечная точка подключения. Returned: success Sample: |
enhanced_vpc_routing boolean | Параметр, указывающий, следует ли создавать кластер с включенной расширенной маршрутизацией VPC. Returned: success Sample: |
hsm_status dictionary | Значение, которое сообщает, завершил ли кластер Amazon Redshift применение любых изменений настроек модуля аппаратной защиты (HSM), указанных в команде модификации кластера. Returned: success Sample: |
iam_roles list / elements=string | Список ролей IAM, присоединенных к кластеру. Returned: success Sample: |
kms_key_id string | Идентификатор ключа службы управления ключами AWS (AWS KMS) ключа шифрования, используемого для шифрования данных в кластере. Returned: success Sample: |
master_username string | Имя основного пользователя для кластера. Returned: success Sample: |
modify_status string | Статус операции модификации. Returned: optional Sample: |
node_type string | Тип узла для узлов в кластере. Returned: success Sample: |
number_of_nodes integer | Количество вычислительных узлов в кластере. Returned: success Sample: |
pending_modified_values dictionary | Значение, которое, если присутствует, указывает на то, что изменения в кластере ожидаются. Returned: success Sample: |
preferred_maintenance_window string | Еженедельный временной диапазон в универсальном координированном времени (UTC), в течение которого может проводиться техническое обслуживание системы. Returned: success Sample: |
publicly_accessible boolean | Булево значение, которое, если истинно, указывает на то, что к кластеру можно получить доступ из общедоступной сети. Returned: success Sample: |
restore_status dictionary | Значение, описывающее состояние действия восстановления кластера. Returned: success Sample: |
tags list / elements=string | Список тегов для кластера. Returned: success Sample: |
vpc_id string | Идентификатор VPC, в котором находится кластер, если кластер находится в VPC. Returned: success Sample: |
vpc_security_groups list / elements=string | Список групп безопасности VPC, связанных с кластером. Returned: success Sample: |
Ссылки на сборник
© 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/community/aws/redshift_info_module.html