amazon.aws.aws_rds 清单 – RDS 实例清单源
注意
此清单插件是 amazon.aws 集合（版本 9.0.0）的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要满足其他要求才能使用此清单插件，请参阅 要求 了解详情。
要在 playbook 中使用它，请指定：amazon.aws.aws_rds。
概要
从 Amazon Web Services RDS 获取实例和集群。
使用以 aws_rds.(yml|yaml) 结尾的 YAML 配置文件。
要求
以下要求需要在执行此清单的本地控制器节点上满足。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 配置
|
|
要执行查找的 IAM 角色的 ARN。 您仍然应该提供具有足够权限执行 AssumeRole 操作的 AWS 凭证。 |
|
切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能工作。 选项
配置
|
|
缓存连接数据或路径，请阅读缓存插件文档了解具体信息。 配置
|
|
用于清单源数据的缓存插件。 默认: 配置
|
|
用于缓存插件文件/表的前缀。 默认: 配置
|
|
缓存持续时间，以秒为单位。 默认值： 配置
|
|
从 Jinja2 表达式创建变量。 默认值： |
|
过滤器值对的字典。此处列出了可用的过滤器 https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html#options。如果按 db-cluster-id 进行过滤，并且 include_clusters 为 True，它也将应用于集群。 默认值： |
|
根据 Jinja2 条件将主机添加到组。 默认值： |
|
来自 AWS 的主机变量名称的前缀。 |
|
来自 AWS 的主机变量名称的后缀。 |
|
是否查询 Aurora 集群以及实例。 选项
|
|
根据变量的值将主机添加到组。 默认值： |
|
当主机变量的值为空字符串时的默认值。 此选项与 |
|
用于生成组的输入字典中的键。 |
|
键组的父组。 |
|
键组名称将以此前缀开头。 默认值： |
|
用于构建键组名称的分隔符。 默认值： |
|
将此选项设置为 此选项与 选项
|
|
与 默认情况下，没有提供前缀或分隔符的键组的名称将以下划线开头。 这是因为默认前缀是 如果未提供前缀，则将此选项设置为 如果组名称是从映射派生的，则仍使用分隔符连接项目。 要完全不在组名称中使用分隔符，请将键组的分隔符设置为空字符串。 选项
|
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 boto_profile 别名已弃用，将在 2024-12-01 之后的版本中删除。 配置
|
|
要使用的 AWS 区域。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 配置
|
|
要在其中描述 RDS 实例和集群的区域列表。此处列出了可用的区域 https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html。 默认值： |
|
AWS 秘密访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 secret_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 配置
|
|
用于临时凭据的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 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 之后的版本中删除。 配置
|
|
要添加到清单的实例/集群的所需状态列表。设置为 [‘all’] 作为查找所有内容的简写。 默认值： |
|
如果 由于可以在表达式中使用事实，因此它们可能并非始终可用，默认情况下我们会忽略这些错误。 选项
|
|
默认情况下，如果遇到 AccessDenied 异常，此插件将失败。您可以在清单配置文件中将 strict_permissions 设置为 False，这将允许正常跳过这些限制。 选项
|
|
将额外变量合并到可用于组合的变量中（优先级最高）。 选项
配置
|
备注
注意
Ansible 2.10 之前的版本应该使用完全限定的插件名称 'amazon.aws.aws_rds'。
注意： 对于模块，环境变量和配置文件是从 Ansible '主机' 上下文中读取的，而不是从 '控制器' 上下文中读取的。因此，文件可能需要显式地复制到 '主机'。对于查找和连接插件，环境变量和配置文件是从 Ansible '控制器' 上下文中读取的，而不是从 '主机' 上下文中读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible '主机' 上下文中的配置文件中读取凭据和其他设置的默认值，例如区域（通常是
~/.aws/credentials）。 更多信息请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
plugin: aws_rds
regions:
- us-east-1
- ca-central-1
keyed_groups:
- key: 'db_parameter_groups|json_query("[].db_parameter_group_name")'
prefix: rds_parameter_group
- key: engine
prefix: rds
- key: tags
- key: region
hostvars_prefix: aws_
hostvars_suffix: _rds