Spec-Zone.ru › Ansible

Модуль community.aws.elasticache_info – получение информации о кластерах AWS ElastiCache

Примечание

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

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

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

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Получение информации из кластеров AWS ElastiCache.

Требования

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

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

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.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для сбора уникальных (а не всех) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback 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.

name

string

Имя кластера ElastiCache.

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 botocore SDK.

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 являются взаимоисключающими.

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.

Примеры

- name: obtain all ElastiCache information
  community.aws.elasticache_info:

- name: obtain all information for a single ElastiCache cluster
  community.aws.elasticache_info:
    name: test_elasticache

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

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

Ключ

Описание

elasticache_clusters

list / elements=dictionary

Список кластеров ElastiCache.

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

arn

string

ARN кластера кэша.

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

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

auto_minor_version_upgrade

boolean

Автоматически ли выполняется обновление до минорных версий.

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

Пример: true

cache_cluster_create_time

string

Дата и время создания кластера.

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

Пример: "2017-09-15T05:43:46.038000+00:00"

cache_cluster_id

string

Идентификатор кластера кэша.

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

Пример: "abcd-1234-001"

cache_cluster_status

string

Статус кластера ElastiCache.

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

Пример: "available"

cache_node_type

string

Тип экземпляра узлов ElastiCache.

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

Пример: "cache.t2.micro"

cache_nodes

list / elements=dictionary

Список узлов ElastiCache в кластере.

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

cache_node_create_time

string

Дата и время создания узла.

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

Пример: "2017-09-15T05:43:46.038000+00:00"

cache_node_id

string

Идентификатор узла кэша.

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

Пример: "0001"

cache_node_status

string

Статус узла кэша.

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

Пример: "available"

customer_availability_zone

string

Зона доступности, в которой был создан узел кэша.

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

Пример: "ap-southeast-2b"

endpoint

dictionary

Сведения о подключении к узлу кэша.

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

address

string

URL конечной точки узла кэша.

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

Пример: "abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com"

port

integer

Порт конечной точки узла кэша.

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

Пример: 6379

parameter_group_status

string

Статус группы параметров кэша.

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

Пример: "in-sync"

cache_parameter_group

dictionary

Содержимое группы параметров кэша.

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

cache_node_ids_to_reboot

list / elements=string

Узлы кэша, которые необходимо перезагрузить, чтобы применить изменения параметров.

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

Пример: []

cache_parameter_group_name

string

Имя группы параметров кэша.

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

Пример: "default.redis3.2"

parameter_apply_status

string

Статус обновления параметров.

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

Пример: "in-sync"

cache_security_groups

list / elements=string

Группы безопасности, используемые кэшем.

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

Пример: ["sg-abcd1234"]

cache_subnet_group_name

string

Группа подсетей ElastiCache, используемая кэшем.

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

Пример: "abcd-subnet-group"

client_download_landing_page

string

URL веб-страницы загрузки клиента.

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

Пример: "https://console.aws.amazon.com/elasticache/home#client-download:"

engine

string

Механизм, используемый ElastiCache.

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

Пример: "redis"

engine_version

string

Версия механизма ElastiCache.

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

Пример: "3.2.4"

notification_configuration

dictionary

Конфигурация уведомлений.

Возвращается: если уведомления включены

topic_arn

string

ARN целевой темы уведомлений.

Возвращается: если уведомления включены

Пример: "arn:aws:sns:*:123456789012:my_topic"

topic_name

string

Имя целевой темы уведомлений.

Возвращается: если уведомления включены

Пример: "MyTopic"

num_cache_nodes

integer

Количество узлов кэша.

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

Пример: 1

pending_modified_values

dictionary

Значения, ожидающие изменения.

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

preferred_availability_zone

string

Предпочтительная зона доступности.

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

Пример: "ap-southeast-2b"

preferred_maintenance_window

string

Временной интервал предпочтительного окна обслуживания.

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

Пример: "sat:12:00-sat:13:00"

replication_group

dictionary

добавлено в community.aws 4.1.0

Сведения о связанной группе репликации.

Возвращается: если репликация включена

arn

string

ARN (имя ресурса Amazon) группы репликации.

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

at_rest_encryption_enabled

boolean

Флаг, который при значении true включает шифрование данных в состоянии покоя.

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

auth_token_enabled

boolean

Флаг, который включает использование AuthToken (пароля) при выполнении команд Redis.

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

automatic_failover

string

Указывает состояние автоматического переключения при сбое для этой группы репликации Redis.

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

Пример: "enabled"

cache_node_type

string

Имя типа узла, определяющего вычислительные ресурсы и объем памяти для каждого узла группы репликации.

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

Пример: "cache.t3.medium"

cluster_enabled

boolean

Флаг, указывающий, включен ли режим кластера для этой группы репликации.

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

description

string

Описание группы репликации, указанное пользователем.

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

global_replication_group_info

dictionary

Имя глобального хранилища данных и роль этой группы репликации в глобальном хранилище данных.

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

global_replication_group_id

string

Имя глобального хранилища данных.

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

global_replication_group_member_role

string

Роль группы репликации в глобальном хранилище данных. Может быть primary или secondary.

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

kms_key_id

string

Идентификатор ключа KMS, используемого для шифрования диска в кластере.

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

member_clusters

list / elements=string

Имена всех кластеров кэша, входящих в эту группу репликации.

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

multi_az

string

Флаг, указывающий, включен ли режим Multi-AZ для повышения отказоустойчивости.

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

Пример: "enabled"

node_groups

list / elements=dictionary

Список групп узлов в этой группе репликации.

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

node_group_id

string

Идентификатор группы узлов (сегмента).

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

node_group_members

list / elements=dictionary

Список, содержащий информацию об отдельных узлах в группе узлов (шарде).

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

cache_cluster_id

string

Идентификатор кластера, к которому принадлежит узел.

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

cache_node_id

string

Идентификатор узла в кластере.

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

current_role

string

Роль, назначенная узлу в данный момент: основной узел или реплика.

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

Пример: "primary"

preferred_availability_zone

string

Название зоны доступности, в которой находится узел.

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

read_endpoint

list / elements=dictionary

Информация, необходимая клиентским программам для подключения к узлу и выполнения операций чтения.

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

address

string

Имя хоста узла кэша в DNS.

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

port

integer

Номер порта, который прослушивает движок кэша.

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

Пример: 6379

primary_endpoint

list / elements=dictionary

Конечная точка основного узла в этой группе узлов (шарде).

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

address

string

Имя хоста узла кэша в DNS.

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

port

integer

Номер порта, который прослушивает движок кэша.

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

Пример: 6379

reader_endpoint

dictionary

Конечная точка узла кэша.

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

address

string

Имя хоста узла кэша в DNS.

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

port

integer

Номер порта, который прослушивает движок кэша.

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

Пример: 6379

status

string

Текущее состояние этой группы репликации: creating, available, modifying, deleting.

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

Пример: "available"

pending_modified_values

dictionary

Набор параметров, которые будут применены к группе репликации немедленно или во время следующего окна обслуживания.

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

replication_group_id

string

Идентификатор группы репликации.

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

Пример: "replication-001"

snapshot_retention_limit

integer

Количество дней, в течение которых ElastiCache хранит автоматические снимки кластера перед их удалением.

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

snapshot_window

string

Ежедневный временной интервал (в UTC), в течение которого ElastiCache начинает создавать снимок группы узлов (шарда).

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

Пример: "07:00-09:00"

snapshotting_cluster_id

string

Идентификатор кластера, используемого в качестве источника ежедневных снимков для группы репликации.

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

status

string

Текущее состояние этой группы репликации: creating, available, modifying, deleting, create-failed, snapshotting

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

transit_encryption_enabled

boolean

Флаг, включающий шифрование при передаче данных, если установлен в true.

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

replication_group_id

string

Идентификатор группы репликации.

Возвращается: если репликация включена

Пример: "replication-001"

security_groups

list / elements=dictionary

Список групп безопасности, связанных с ElastiCache.

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

security_group_id

string

Идентификатор группы безопасности

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

Пример: "sg-abcd1234"

status

string

Статус группы безопасности

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

Пример: "active"

tags

dictionary

Теги, назначенные кластеру ElastiCache

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

Пример: {"Application": "web", "Environment": "test"}

Авторы

  • Will Thames (@willthames)

Ссылки на коллекцию

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

© 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/elasticache_info_module.html

Spec-Zone.ru

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