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

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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания предпочтения.

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

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

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

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

aws_config

словарь

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

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

debug_botocore_endpoint_logs

логический

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

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

Варианты:

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

endpoint_url

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

строка

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

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

name

строка

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

profile

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

строка

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

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

Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания предпочтения.

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

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды 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.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

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

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

Варианты:

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

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

ID кластера кеша.

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

Пример: "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

ID узла кеша.

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

Пример: "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

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

Returned: always

Sample: []

cache_parameter_group_name

string

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

Returned: always

Sample: "default.redis3.2"

parameter_apply_status

string

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

Returned: always

Sample: "in-sync"

cache_security_groups

list / elements=string

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

Returned: always

Sample: ["sg-abcd1234"]

cache_subnet_group_name

string

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

Returned: always

Sample: "abcd-subnet-group"

client_download_landing_page

string

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

Returned: always

Sample: "https://console.aws.amazon.com/elasticache/home#client-download:"

engine

string

Движок, используемый ElastiCache.

Returned: always

Sample: "redis"

engine_version

string

Версия движка ElastiCache.

Returned: always

Sample: "3.2.4"

notification_configuration

dictionary

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

Returned: if notifications are enabled

topic_arn

string

ARN темы назначения уведомлений.

Returned: if notifications are enabled

Sample: "arn:aws:sns:*:123456789012:my_topic"

topic_name

string

Имя темы назначения уведомлений.

Returned: if notifications are enabled

Sample: "MyTopic"

num_cache_nodes

integer

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

Returned: always

Sample: 1

pending_modified_values

dictionary

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

Returned: always

preferred_availability_zone

string

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

Returned: always

Sample: "ap-southeast-2b"

preferred_maintenance_window

string

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

Returned: always

Sample: "sat:12:00-sat:13:00"

replication_group

dictionary

added in community.aws 4.1.0

Информация о связанной группе репликации.

Returned: if replication is enabled

arn

string

ARN (Amazon Resource Name) группы репликации.

Returned: always

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

ID ключа 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

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

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

cache_node_id

string

ID узла в его кластере.

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

current_role

string

Роль, которая в настоящее время назначена узлу - primary или replica.

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

Пример: "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"}