amazon.aws.rds_option_group 模块 – 管理 RDS 选项组的创建、修改和删除

注意

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

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

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

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

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 之后的一个版本中删除。
apply_immediately 布尔值	指示是否应立即应用更改，或在下一个维护窗口期间应用更改。 选项 false ← (默认) true
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 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 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 字符串	指定此选项组应与其关联的引擎的主版本。
option_group_description 字符串	选项组的描述。
option_group_name 字符串 / 必需	指定要创建的选项组的名称。
options 列表 / 元素=字典	此列表中的选项将添加到选项组。 如果已存在，则使用指定的配置来更新现有配置。 如果没有提供任何选项，则会删除所有现有选项。
db_security_group_memberships 列表 / 元素=字符串	此选项使用的 DBSecurityGroupMembership 名称字符串列表。
option_name 字符串	要包含在组中的选项的配置。
option_settings 列表 / 元素=字典	要包含在选项组中的选项设置。
allowed_values 字符串	选项设置的允许值。
apply_type 字符串	特定于 DB 引擎的参数类型。
data_type 字符串	选项设置的数据类型。
default_value 字符串	选项设置的默认值。
description 字符串	选项设置的描述。
is_collection 布尔值	指示选项设置是否是集合的一部分。 选项 false true
is_modifiable 布尔值	一个布尔值，当值为 true 时，表示选项设置可以从默认值修改。 选项 false true
名称 字符串	具有可设置选项的选项名称。
值 字符串	选项设置的当前值。
选项版本 字符串	选项的版本。
端口 整数	选项的可选端口。
vpc_security_group_memberships 列表 / 元素=字符串	用于此选项的 VpcSecurityGroupMembership 名称字符串列表。
配置文件 别名：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 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 且设置了 tags，则将从资源中清除现有标签，以完全匹配 tags 参数定义的内容。 如果未设置 tags 参数，则即使 purge_tags=True，也不会修改标签。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，在 purge_tags 参数中将忽略它们。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
区域 别名：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 之后的一个版本中删除。
密钥 别名：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 之后的一个版本中删除。
会话令牌 别名：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 之后的一个版本中删除。
状态 字符串 / 必需	指定选项组应为 present 还是 absent。 选项 "存在" "不存在"
标签 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)
等待 布尔值	是否等待集群可用或删除。 选项 false true ← (默认)

注释

注意

• 警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文读取的，而不是“控制器”上下文。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文读取的，而不是“主机”上下文。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Create an RDS Mysql Option group
- name: Create an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
    options:
      - option_name: MEMCACHED
        port: 11211
        vpc_security_group_memberships:
          - "sg-d188c123"
        option_settings:
          - name: MAX_SIMULTANEOUS_CONNECTIONS
            value: "20"
          - name: CHUNK_SIZE_GROWTH_FACTOR
            value: "1.25"
  register: new_rds_mysql_option_group

# Remove currently configured options for an option group by removing options argument
- name: Create an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
  register: rds_mysql_option_group

- name: Create an RDS Mysql option group using tags
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
    tags:
      Tag1: tag1
      Tag2: tag2
  register: rds_mysql_option_group

# Delete an RDS Mysql Option group
- name: Delete an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: absent
    option_group_name: test-mysql-option-group
  register: deleted_rds_mysql_option_group

返回值

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

键	描述
allows_vpc_and_non_vpc_instance_memberships 布尔值	指示此选项组是否可以同时应用于 VPC 实例和非 VPC 实例。 返回：始终 示例： false
已更改 布尔值	如果选项组已更改。 返回：始终 示例： true
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 安全组允许访问该端口。 返回：始终
db_security_group_name 字符串	DB 安全组的名称。 返回：始终 示例： "mydbsecuritygroup"
状态 字符串	DB 安全组的状态。 返回：始终 示例： "available"
option_description 字符串	选项的描述。 返回：始终 示例： "Innodb Memcached for MySQL"
option_name 字符串	选项的名称。 返回：始终 示例： "MEMCACHED"
option_settings 列表 / 元素=字符串	选项的名称。 返回：始终
allowed_values 字符串	选项设置的允许值。 返回：始终 示例： "1-2048"
apply_type 字符串	特定于 DB 引擎的参数类型。 返回：始终 示例： "STATIC"
data_type 字符串	选项设置的数据类型。 返回：始终 示例： "INTEGER"
default_value 字符串	选项设置的默认值。 返回：始终 示例： "1024"
description 字符串	选项设置的描述。 返回：始终 示例： "memcached 的详细级别"
is_collection 布尔值	指示选项设置是否是集合的一部分。 返回：始终 示例： true
is_modifiable 布尔值	布尔值，为真时表示可以修改默认选项设置。 返回：始终 示例： true
名称 字符串	具有可设置选项的选项名称。 返回：始终 示例： "INNODB_API_ENABLE_MDL"
值 字符串	选项设置的当前值。 返回：始终 示例： "0"
永久的 布尔值	指示此选项是否永久有效。 返回：始终 示例： true
持久的 布尔值	指示此选项是否持久有效。 返回：始终 示例： true
端口 整数	如果需要，此选项使用的配置端口。 返回：始终 示例： 11211
vpc_security_group_memberships 列表 / 元素=字典	如果选项需要访问端口，则此VPC安全组允许访问该端口。 返回：始终
状态 字符串	VPC安全组的状态。 返回：始终 示例： "available"
vpc_security_group_id 字符串	VPC安全组的名称。 返回：始终 示例： "sg-0cd636a23ae76e9a4"
标签 字典	与RDS选项组关联的标签。 返回：始终 示例： {"Ansible": "Test"}
vpc_id 字符串	如果存在，此选项组只能应用于此字段指示的VPC中的实例。 返回：始终 示例： "vpc-bf07e9d6"

作者

• Nick Aslanidis (@naslanidis)

• Will Thames (@willthames)

• Alina Buzachis (@alinabuzachis)

资源链接

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