amazon.aws.rds_subnet_group 模块 – 管理 RDS 数据库子网组

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 创建、修改和删除 RDS 数据库子网组。

• 此模块最初在 1.0.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 保持一致，aws_access_key_id 别名是在 5.1.0 版本中添加的。 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
描述 字符串	数据库子网组描述。 当 state=present 时必需。
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 之后的一个版本中删除。
名称 字符串 / 必需	数据库子网组标识符。
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 选项互斥。
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 ← (默认)
区域 (region) 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略区域。 也可以使用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 之后发布的版本中移除。
状态 (state) 字符串 / 必需	指定子网是否存在。 选项 "present" "absent"
子网 (subnets) 列表 / 元素=字符串	构成数据库子网组的子网 ID 列表。 当state=present时，此参数为必填项。
标签 (tags) 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置tags参数，则不会修改标签。
验证证书 (validate_certs) 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，建议考虑改用aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 对tags和purge_tags的支持已在 3.2.0 版本中添加。

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

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

示例

- name: Add or change a subnet group
  amazon.aws.rds_subnet_group:
    state: present
    name: norwegian-blue
    description: My Fancy Ex Parrot Subnet Group
    subnets:
      - subnet-aaaaaaaa
      - subnet-bbbbbbbb

- name: Add or change a subnet group and associate tags
  amazon.aws.rds_subnet_group:
    state: present
    name: norwegian-blue
    description: My Fancy Ex Parrot Subnet Group
    subnets:
      - subnet-aaaaaaaa
      - subnet-bbbbbbbb
    tags:
      tag1: Tag1
      tag2: Tag2

- name: Remove a subnet group
  amazon.aws.rds_subnet_group:
    state: absent
    name: norwegian-blue

返回值

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

键	描述
changed 布尔值	如果成功列出 RDS 子网组，则为 True。 返回值：始终 示例：false
subnet_group 复杂类型	DB 子网组值的字典， 返回值：state=present
db_subnet_group_arn 字符串	DB 子网组的 ARN。 返回值：state=present 示例："arn:aws:rds:eu-north-1:123456789012:subgrp:ansible-test-13950442"
db_subnet_group_description 字符串	DB 子网组的描述。 返回值：state=present 示例："Simple description."
db_subnet_group_name 字符串	DB 子网组的名称。 返回值：state=present 示例："ansible-test-mbp-13950442"
描述 字符串	DB 子网组的描述（为向后兼容性而保留）。 返回值：state=present 示例："Simple description."
名称 字符串	DB 子网组的名称（为向后兼容性而保留）。 返回值：state=present 示例："ansible-test-mbp-13950442"
status 字符串	DB 子网组的状态（为向后兼容性而保留）。 返回值：state=present 示例："Complete"
subnet_group_status 字符串	DB 子网组的状态。 返回值：state=present 示例："Complete"
subnet_ids 列表 / 元素=字符串	包含子网 ID 列表。 返回值：state=present 示例：["subnet-08c94870f4480797e"]
子网 (subnets) 列表 / 元素=字符串	包含子网元素列表（@see https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.describe_db_subnet_groups）。 返回值：state=present
subnet_availability_zone 字典 在 community.aws 3.2.0 中添加	包含可用区信息。 返回值：state=present 示例：{"name": "eu-north-1b"}
subnet_identifier 字符串 在 community.aws 3.2.0 中添加	子网的标识符。 返回值：state=present 示例："subnet-08c94870f4480797e"
subnet_outpost 字典 在 community.aws 3.2.0 中添加	此值指定 Outpost。 返回值：state=present 示例：{}
subnet_status 字符串 在 community.aws 3.2.0 中添加	子网的状态。 返回值：state=present 示例："Active"
tags 字典 在 community.aws 3.2.0 中添加	与子网组关联的标签。 返回值：state=present 示例：{"tag1": "Tag1", "tag2": "Tag2"}
vpc_id 字符串	DB 子网组的 VPC ID。 返回值：state=present 示例："vpc-0acb0ba033ff2119c"

作者

• Scott Anderson (@tastychutney)

• Alina Buzachis (@alinabuzachis)

集合链接

• 问题追踪器
• 代码库 (源代码)
• 通信