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 选项组的信息。

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

要求

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

• 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 integer	响应中包含的最大记录数。 默认值： 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 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 之后的版本中删除。
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 之后的版本中删除。
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 complex	可用的 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 complex	指示选项组中可用的选项。 返回： 始终
db_security_group_memberships complex	如果该选项需要访问端口，则此数据库安全组允许访问该端口。 返回： 始终 示例： "list"
db_security_group_name 字符串	数据库安全组的名称。 返回： 始终 示例： "mydbsecuritygroup"
status 字符串	数据库安全组的状态。 返回： 始终 示例： "available"
option_description 字符串	该选项的描述。 返回： 始终 示例： "Innodb Memcached for MySQL"
option_name 字符串	该选项的名称。 返回： 始终 示例： "MEMCACHED"
option_settings complex	该选项的名称。 返回： 始终
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 integer	如果需要，为此选项配置要使用的端口。 返回： 始终 示例： 11211
vpc_security_group_memberships list / elements=dictionary	如果该选项需要访问端口，则此 VPC 安全组允许访问该端口。 返回： 始终
status 字符串	VPC 安全组的状态。 返回： 始终 示例： "available"
vpc_security_group_id 字符串	VPC 安全组的名称。 返回： 始终 示例： "sg-0cd636a23ae76e9a4"
tags 字典	与 RDS 选项组关联的标签。 返回： 始终 示例: {"Ansible": "Test"}
vpc_id 字符串	如果存在，此选项组只能应用于此字段指示的 VPC 中的实例。 返回： 始终 示例: "vpc-bf07e9d6"

作者

• Alina Buzachis (@alinabuzachis)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通