amazon.aws.rds_option_group_info 模块 – rds_option_group_info 模块

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。要使用此模块，您需要其他要求，请参阅 要求 以了解详情。

要在 playbook 中使用它，请指定：amazon.aws.rds_option_group_info。

amazon.aws 5.0.0 中的新增功能

概要

• 收集有关 RDS 选项组的信息。

• 此模块最初添加到 community.aws 的 2.1.0 版本中。

要求

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

• 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 之后的一个版本中删除。
engine_name 字符串	将选项组列表过滤为仅包含与特定数据库引擎关联的组。 默认值： ""
major_engine_version 字符串	将选项组列表过滤为仅包含与特定数据库引擎版本关联的组。 如果指定，则还必须指定 engine_name。 默认值： ""
marker 字符串	如果指定此参数，则响应仅包含超过标记的记录，直到 max_records 指定的值。 允许的值介于 20 和 100 之间。
max_records 整数	要包含在响应中的最大记录数。 默认值： 100
option_group_name 字符串	要描述的选项组的名称。 不能与engine_name或major_engine_version一起使用。 默认值： ""
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。

示例

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

- name: List an option group
  amazon.aws.rds_option_group_info:
    option_group_name: test-mysql-option-group
  register: option_group

- name: List all the option groups
  amazon.aws.rds_option_group_info:
    region: ap-southeast-2
    profile: production
  register: option_group

返回值

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

键	描述
changed 布尔值	如果 RDS 选项组列表成功，则为 True。 返回：始终 示例： false
result 复杂	可用的 RDS 选项组。 返回：始终
allows_vpc_and_non_vpc_instance_memberships 布尔值	指示此选项组是否可以应用于 VPC 和非 VPC 实例。 返回：始终 示例： false
engine_name 字符串	指示可以为此选项组应用的引擎的名称。 返回：始终 示例： "mysql"
major_engine_version 字符串	指示与此选项组关联的主要引擎版本。 返回：始终 示例： "5.6"
option_group_arn 字符串	选项组的 Amazon 资源名称 (ARN)。 返回：始终 示例： "arn:aws:rds:ap-southeast-2:123456789012:og:ansible-test-option-group"
option_group_description 字符串	提供选项组的描述。 返回：始终 示例： "test mysql option group"
option_group_name 字符串	指定选项组的名称。 返回：始终 示例： "test-mysql-option-group"
options 复杂	指示选项组中有哪些可用选项。 返回：始终
db_security_group_memberships 复杂	如果选项需要访问端口，则此 DB 安全组允许访问该端口。 返回：始终 示例： "list"
db_security_group_name 字符串	DB 安全组的名称。 返回：始终 示例： "mydbsecuritygroup"
status 字符串	DB 安全组的状态。 返回：始终 示例： "available"
option_description 字符串	选项的描述。 返回：始终 示例： "Innodb Memcached for MySQL"
option_name 字符串	选项的名称。 返回：始终 示例： "MEMCACHED"
option_settings 复杂	选项的名称。 返回：始终
allowed_values 字符串	选项设置的允许值。 返回：始终 示例： "1-2048"
apply_type 字符串	特定于数据库引擎的参数类型。 返回：始终 示例： "STATIC"
data_type 字符串	选项设置的数据类型。 返回：始终 示例： "INTEGER"
default_value 字符串	选项设置的默认值。 返回：始终 示例： "1024"
description 字符串	选项设置的描述。 返回：始终 示例： "Verbose level for memcached."
is_collection 布尔值	指示选项设置是否属于集合的一部分。 返回：始终 示例： true
is_modifiable 布尔值	布尔值，为 true 时表示可以修改选项设置的默认值。 返回：始终 示例： true
name 字符串	具有可以设置的设置的选项的名称。 返回：始终 示例： "INNODB_API_ENABLE_MDL"
value 字符串	选项设置的当前值。 返回：始终 示例： "0"
permanent 布尔值	指示此选项是否永久存在。 返回：始终 示例： true
persistent 布尔值	指示此选项是否持久存在。 返回：始终 示例： true
port 整数	如果需要，此选项将配置使用的端口。 返回：始终 示例： 11211
vpc_security_group_memberships 列表 / 元素=字典	如果此选项需要访问端口，则此VPC安全组允许访问该端口。 返回：始终
status 字符串	VPC安全组的状态。 返回：始终 示例： "available"
vpc_security_group_id 字符串	VPC安全组的名称。 返回：始终 示例： "sg-0cd636a23ae76e9a4"
tags 字典	与RDS选项组关联的标签。 返回：始终 示例： {"Ansible": "Test"}
vpc_id 字符串	如果存在，此选项组只能应用于此字段指示的VPC中的实例。 返回：始终 示例： "vpc-bf07e9d6"

作者

• Alina Buzachis (@alinabuzachis)

资源链接

• 问题追踪器
• 代码仓库
• 通讯