community.aws.elasticache_snapshot 模块 – 管理 Amazon ElastiCache 中的缓存快照

注意

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

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

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

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

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 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。

bucket

字符串

导出快照的 s3 存储桶。

cluster_id

字符串

用于制作快照的复制组中现有缓存集群的名称。

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 之后的版本中删除。

name

字符串 / 必需

我们要创建、复制或删除的快照的名称。

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 之后的版本中删除。

replication_id

字符串

用于制作快照的现有复制组的名称。

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 选项互斥。

别名 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

字符串 / 必需

将创建、销毁或复制快照的操作。

选择

  • "present"

  • "absent"

  • "copy"

target

字符串

快照副本的名称。

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。

示例

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

- name: 'Create a snapshot'
  community.aws.elasticache_snapshot:
    name: 'test-snapshot'
    state: 'present'
    cluster_id: '{{ cluster }}'
    replication_id: '{{ replication }}'

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

changed

布尔值

如果已创建、删除或复制快照

返回： 总是

示例： {"changed": true}

response_metadata

字典

关于快照的响应元数据

返回： 总是

示例： {"http_headers": {"content-length": 1490, "content-type": "text/xml", "date": "Tue, 07 Feb 2017 16:43:04 GMT", "x-amzn-requestid": "7f436dea-ed54-11e6-a04c-ab2372a1f14d"}, "http_status_code": 200, "request_id": "7f436dea-ed54-11e6-a04c-ab2372a1f14d", "retry_attempts": 0}

snapshot

字典

快照数据

返回： 总是

示例： {"auto_minor_version_upgrade": true, "cache_cluster_create_time": "2017-02-01T17:43:58.261000+00:00", "cache_cluster_id": "test-please-delete", "cache_node_type": "cache.m1.small", "cache_parameter_group_name": "default.redis3.2", "cache_subnet_group_name": "default", "engine": "redis", "engine_version": "3.2.4", "node_snapshots": {"cache_node_create_time": "2017-02-01T17:43:58.261000+00:00", "cache_node_id": 1, "cache_size": null}, "num_cache_nodes": 1, "port": 11211, "preferred_availability_zone": "us-east-1d", "preferred_maintenance_window": "wed:03:00-wed:04:00", "snapshot_name": "deletesnapshot", "snapshot_retention_limit": 0, "snapshot_source": "manual", "snapshot_status": "creating", "snapshot_window": "10:00-11:00", "vpc_id": "vpc-c248fda4"}

作者

  • Sloane Hertel (@s-hertel)