community.aws.elasticache 模块 – 管理 Amazon ElastiCache 中的缓存集群

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

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

community.aws 1.0.0 中的新功能

概要 

管理 Amazon 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_access_key_id 别名在 5.1.0 版本中添加，以便与 AWS botocore SDK 保持一致。 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。
cache_engine_version 字符串	缓存引擎的版本号。默认值： `""`
cache_parameter_group 别名：parameter_group 字符串	要与此缓存集群关联的缓存参数组的名称。如果省略此参数，将使用指定引擎的默认缓存参数组。默认值： `""`
cache_port 整数	每个缓存节点将接受连接的端口号。
cache_security_groups 列表 / 元素=字符串	要与此缓存集群关联的缓存安全组名称列表。如果您的缓存位于 VPC 内，请不要使用！在这种情况下，请改用 security_group_ids！默认值： `[]`
cache_subnet_group 字符串	要关联的子网组名称。仅当在 VPC 内时才使用。如果在 VPC 内，则为必需。默认值： `""`
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 之后的版本中删除。
engine 字符串	要使用的缓存引擎的名称。支持的值为 `redis` 和 `memcached`。默认值： `"memcached"`
hard_modify 布尔值	是否在必要时销毁并重新创建现有的缓存集群以修改其状态。默认为 `false`。选择 `false` `true`
name 字符串 / 必需	缓存集群标识符。
node_type 字符串	缓存集群中节点的计算和内存容量。默认值： `"cache.t2.small"`
num_nodes 整数	缓存集群将拥有的初始缓存节点数。当 state=present 时为必需。默认值： `1`
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 secret access key。有关访问令牌的更多信息，请参阅 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 版本中添加，以便与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
security_group_ids 列表 / 元素=字符串	要与此缓存集群关联的 VPC 安全组 ID 列表。仅在 VPC 内部使用。默认值： `[]`
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 版本中添加，参数在 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 之后的版本中删除。
state 字符串 / 必需	`absent` 或 `present` 是幂等操作，将根据需要创建或销毁缓存集群。 `rebooted` 将重新启动集群，导致短暂中断。选择 `"present"` `"absent"` `"rebooted"`
validate_certs 布尔值	设置为 `false` 时，将不验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。选择 `false` `true` ← (默认值)
wait 布尔值	等待缓存集群结果返回。选择 `false` `true` ← (默认值)
zone 字符串	将在其中创建缓存集群的 EC2 可用区。

注释 

注意

注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是“主机”上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能会从其在 Ansible “主机” 上下文中的配置文件 (通常是 ~/.aws/credentials) 中读取凭据和其他设置 (如区域) 的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Basic example
  community.aws.elasticache:
    name: "test-please-delete"
    state: present
    engine: memcached
    cache_engine_version: 1.4.14
    node_type: cache.m3.small
    num_nodes: 1
    cache_port: 11211
    cache_security_groups:
      - default
    zone: us-east-1d


- name: Ensure cache cluster is gone
  community.aws.elasticache:
    name: "test-please-delete"
    state: absent

- name: Reboot cache cluster
  community.aws.elasticache:
    name: "test-please-delete"
    state: rebooted

作者

Jim Dalton (@jsdalton)