community.aws.elasticache_info 模块 – 获取 AWS ElastiCache 集群的信息

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅要求 了解详细信息。

要在 playbook 中使用它，请指定：community.aws.elasticache_info。

community.aws 1.0.0 中的新增功能

概要

• 从 AWS ElastiCache 集群检索信息。

要求

在执行此模块的主机上需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 捆绑包的位置。 也可以使用 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 回调输出到 playbook 期间制作的总列表。 也可以使用 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 之后的版本中移除。
名称 字符串	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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 已弃用 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 选项互斥。 在 3.2.0 版本中添加了别名 aws_session_token 和 session_token，并在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。 已弃用 security_token、aws_security_token 和 access_token 别名，并将在 2024-12-01 之后的版本中移除。 已弃用对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持，并将在 2024-12-01 之后的版本中移除。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 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 列表 / 元素=字典	ElastiCache 集群列表。 返回： 始终
arn 字符串	缓存集群的 ARN。 返回： 始终 示例： "arn:aws:elasticache:us-east-1:123456789012:cluster:ansible-test"
auto_minor_version_upgrade 布尔值	是否自动升级到次要版本。 返回： 始终 示例： true
cache_cluster_create_time 字符串	创建集群的日期和时间。 返回： 始终 示例： "2017-09-15T05:43:46.038000+00:00"
cache_cluster_id 字符串	缓存集群的 ID。 返回： 始终 示例： "abcd-1234-001"
cache_cluster_status 字符串	ElastiCache 集群的状态。 返回： 始终 示例： "available"
cache_node_type 字符串	ElastiCache 节点的实例类型。 返回： 始终 示例： "cache.t2.micro"
cache_nodes 列表 / 元素=字典	集群中的 ElastiCache 节点列表。 返回： 始终
cache_node_create_time 字符串	创建节点的日期和时间。 返回： 始终 示例： "2017-09-15T05:43:46.038000+00:00"
cache_node_id 字符串	缓存节点的 ID。 返回： 始终 示例： "0001"
cache_node_status 字符串	缓存节点的状态。 返回： 始终 示例： "available"
customer_availability_zone 字符串	创建缓存节点的可用区。 返回： 始终 示例： "ap-southeast-2b"
endpoint 字典	缓存节点的连接详细信息。 返回： 始终
address 字符串	缓存节点端点的 URL。 返回： 始终 示例： "abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com"
port 整数	缓存节点端点的端口。 返回： 始终 示例： 6379
parameter_group_status 字符串	缓存参数组的状态。 返回： 始终 示例： "in-sync"
cache_parameter_group 字典	缓存参数组的内容。 返回： 始终
cache_node_ids_to_reboot 列表 / 元素=字符串	需要重新启动以应用参数更改的缓存节点。 返回： 始终 示例： []
cache_parameter_group_name 字符串	缓存参数组的名称。 返回： 始终 示例： "default.redis3.2"
parameter_apply_status 字符串	参数更新的状态。 返回： 始终 示例： "in-sync"
cache_security_groups 列表 / 元素=字符串	缓存使用的安全组。 返回： 始终 示例： ["sg-abcd1234"]
cache_subnet_group_name 字符串	缓存使用的 ElastiCache 子网组。 返回： 始终 示例： "abcd-subnet-group"
client_download_landing_page 字符串	客户端下载网页的 URL。 返回： 始终 示例： "https://console.aws.amazon.com/elasticache/home#client-download:"
engine 字符串	ElastiCache 使用的引擎。 返回： 始终 示例： "redis"
engine_version 字符串	ElastiCache 引擎的版本。 返回： 始终 示例： "3.2.4"
notification_configuration 字典	通知的配置。 返回： 如果启用了通知
topic_arn 字符串	通知目标主题的 ARN。 返回： 如果启用了通知 示例： "arn:aws:sns:*:123456789012:my_topic"
topic_name 字符串	通知目标主题的名称。 返回： 如果启用了通知 示例： "MyTopic"
num_cache_nodes 整数	缓存节点数量。 返回： 始终 示例： 1
pending_modified_values 字典	等待修改的值。 返回： 始终
preferred_availability_zone 字符串	首选可用区。 返回： 始终 示例： "ap-southeast-2b"
preferred_maintenance_window 字符串	首选维护窗口的时间段。 返回： 始终 示例： "sat:12:00-sat:13:00"
replication_group 字典 在 community.aws 4.1.0 中添加	关于关联的复制组的信息。 返回：如果启用了复制
arn 字符串	复制组的 ARN (Amazon Resource Name)。 返回： 始终
at_rest_encryption_enabled 布尔值	一个标志，设置为 true 时启用静态加密。 返回： 始终
auth_token_enabled 布尔值	一个标志，指示在发出 Redis 命令时是否启用使用 AuthToken (密码)。 返回： 始终
automatic_failover 字符串	指示此 Redis 复制组的自动故障转移状态。 返回： 始终 示例： "enabled"
cache_node_type 字符串	复制组中每个节点的计算和内存容量节点类型的名称。 返回： 始终 示例： "cache.t3.medium"
cluster_enabled 布尔值	一个标志，指示此复制组是否启用了集群。 返回： 始终
description 字符串	用户提供的复制组描述。 返回： 始终
global_replication_group_info 字典	全局数据存储的名称以及此复制组在全局数据存储中的角色。 返回： 始终
global_replication_group_id 字符串	全局数据存储的名称。 返回： 始终
global_replication_group_member_role 字符串	复制组在全局数据存储中的角色。可以是 primary 或 secondary。 返回： 始终
kms_key_id 字符串	用于加密集群中磁盘的 KMS 密钥的 ID。 返回： 始终
member_clusters 列表 / 元素=字符串	作为此复制组一部分的所有缓存集群的名称。 返回： 始终
multi_az 字符串	一个标志，指示是否启用了多可用区以增强容错能力。 返回： 始终 示例： "enabled"
node_groups 列表 / 元素=字典	此复制组中的节点组列表。 返回： 始终
node_group_id 字符串	节点组（分片）的标识符。 返回： 始终
node_group_members 列表 / 元素=字典	一个列表，其中包含有关节点组（分片）中各个节点的信息。 返回： 始终
cache_cluster_id 字符串	该节点所属的集群的 ID。 返回： 始终
cache_node_id 字符串	节点在其集群内的 ID。 返回： 始终
current_role 字符串	当前分配给该节点的角色 - primary 或 replica。 返回： 始终 示例： "primary"
preferred_availability_zone 字符串	节点所在的可用区的名称。 返回： 始终
read_endpoint 列表 / 元素=字典	客户端程序连接到节点进行读取操作所需的信息。 返回： 始终
address 字符串	缓存节点的 DNS 主机名。 返回： 始终
port 整数	缓存引擎正在监听的端口号。 返回： 始终 示例： 6379
primary_endpoint 列表 / 元素=字典	此节点组（分片）中主节点的端点。 返回： 始终
address 字符串	缓存节点的 DNS 主机名。 返回： 始终
port 整数	缓存引擎正在监听的端口号。 返回： 始终 示例： 6379
reader_endpoint 字典	缓存节点的端点。 返回： 始终
address 字符串	缓存节点的 DNS 主机名。 返回： 始终
port 整数	缓存引擎正在监听的端口号。 返回： 始终 示例： 6379
status 字符串	此复制组的当前状态 - creating、available、modifying、deleting。 返回： 始终 示例： "available"
pending_modified_values 字典	一组将应用于复制组的设置，可以立即应用或在下一个维护窗口期间应用。 返回： 始终
replication_group_id 字符串	复制组 ID。 返回： 始终 示例： "replication-001"
snapshot_retention_limit 整数	ElastiCache 保留自动集群快照的天数，之后将删除它们。 返回： 始终
snapshot_window 字符串	ElastiCache 开始每日拍摄节点组（分片）快照的每日时间范围（UTC）。 返回： 始终 示例： "07:00-09:00"
snapshotting_cluster_id 字符串	用作复制组每日快照源的集群 ID。 返回： 始终
status 字符串	此复制组的当前状态 - creating、available、modifying、deleting、create-failed、snapshotting 返回： 始终
transit_encryption_enabled 布尔值	一个标志，设置为 true 时启用传输中加密。 返回： 始终
replication_group_id 字符串	复制组 ID。 返回：如果启用了复制 示例： "replication-001"
security_groups 列表 / 元素=字典	与 ElastiCache 关联的安全组列表。 返回： 始终
security_group_id 字符串	安全组 ID 返回： 始终 示例： "sg-abcd1234"
status 字符串	安全组的状态 返回： 始终 示例： "active"
tags 字典	应用于 ElastiCache 集群的标签 返回： 始终 示例： {"Application": "web", "Environment": "test"}

作者

• Will Thames (@willthames)

集合链接

• 问题跟踪器
• 存储库 (源代码)
• 通信