amazon.aws.rds_cluster 模块 – rds_cluster 模块

注意

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

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

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

要在剧本中使用它，请指定：amazon.aws.rds_cluster。

amazon.aws 5.0.0 中的新增功能

概要

• 创建、修改和删除 RDS 集群。

• 此模块最初在 3.2.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 之后的发行版中删除。
allocated_storage 整数 amazon.aws 5.5.0 中新增	分配给多可用区数据库集群中每个数据库实例的存储量（以 GiB 为单位）。 此设置是创建多可用区数据库集群所必需的。
apply_immediately 布尔值	一个值，指定是否应尽快应用使用 new_db_cluster_identifier 和 master_user_password 修改集群的操作，而不管 preferred_maintenance_window 设置如何。如果为 false，则会在下一个维护窗口期间应用更改。 选项 false ← (默认) true
availability_zones 别名：zones、az 列表 / 元素=字符串	数据库集群中的实例可以在其中创建的 EC2 可用区列表。在创建集群或从 S3 或快照恢复时可以使用。
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。
backtrack_to 字符串	要将数据库集群回溯到的时间的 ISO 8601 格式的时间戳，例如“2017-07-08T18:00Z”。
backtrack_window 整数	目标回溯窗口（以秒为单位）。要禁用回溯，请将此值设置为 0。 如果指定，此值必须设置为 0 到 259,200 (72 小时) 之间的数字。
backup_retention_period 整数	保留自动备份的天数（必须在 1 到 35 之间）。在创建新集群、从 S3 恢复或修改集群时可以使用。 默认值： 1
character_set_name 字符串	要与 DB 集群关联的字符集。
copy_tags_to_snapshot 布尔值	指示是否将 DB 集群的所有标签复制到 DB 集群的快照。默认是不复制。 选项 false true
creation_source 字符串	如果从模板（现有集群、S3 存储桶或快照）创建，则使用哪个源。 选项 "snapshot" "s3" "cluster"
database_name 别名：db_name 字符串	数据库的名称。如果没有提供名称，Amazon RDS 将不会创建数据库。
db_cluster_identifier 别名：cluster_id、id、cluster_name 字符串 / 必需	DB 集群（小写）标识符。标识符必须包含 1 到 63 个字母、数字或连字符，第一个字符必须是字母，并且不能以连字符结尾或包含连续的连字符。
db_cluster_instance_class 字符串 amazon.aws 5.5.0 中新增	多可用区 DB 集群中每个 DB 实例的计算和内存容量，例如 db.m6gd.xlarge。 并非所有 DB 实例类都可以在所有 Amazon Web Services 区域或所有数据库引擎中使用。 有关数据库实例类别及其引擎可用性的完整列表，请访问 https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html。 此设置是创建多可用区数据库集群所必需的。
db_cluster_parameter_group_name 字符串	要与此数据库集群关联的数据库集群参数组的名称。如果在创建集群时省略此参数，则使用指定数据库引擎和版本的默认数据库集群参数组。
db_subnet_group_name 字符串	如果不使用默认值，则要与此数据库集群关联的数据库子网组。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析任务期间进行的唯一（而不是全部）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调函数将输出到 playbook 期间进行的全部列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
deletion_protection 布尔值	指示数据库集群是否启用了删除保护的值。启用删除保护后，无法删除数据库。默认情况下，删除保护处于禁用状态。 选项 false true
domain 字符串	要在其中创建数据库集群的 Active Directory 目录 ID。
domain_iam_role_name 字符串	指定在对目录服务进行 API 调用时要使用的 IAM 角色的名称。
enable_cloudwatch_logs_exports 列表 / 元素=字符串	需要启用以导出到 CloudWatch Logs 的日志类型列表。 引擎 aurora-mysql 支持 audit、error、general 和 slowquery。 引擎 aurora-postgresql 支持 postgresql。
enable_global_write_forwarding 布尔值	指示是否启用此数据库集群将写操作转发到 Aurora 全局数据库的主集群的值。默认情况下，不允许对在 Aurora 全局数据库中作为辅助集群的 Aurora 数据库集群执行写操作。 此值只能在属于 Aurora 全局数据库的 Aurora 数据库集群上设置。 选项 false true
enable_http_endpoint 布尔值	指示是否为 Aurora Serverless 数据库集群启用 HTTP 端点的值。默认情况下，HTTP 端点处于禁用状态。 选项 false true
enable_iam_database_authentication 布尔值	启用将 AWS 身份和访问管理 (IAM) 帐户映射到数据库帐户。如果在创建集群时省略此选项，则 Amazon RDS 会将其设置为 false。 选项 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 字符串	要为此数据库集群使用的数据库引擎的名称。创建集群需要此参数。 engine 和 engine_mode 的组合可能不受支持。 有关详细信息，请参阅 AWS 文档：Amazon RDS 文档。 当 engine=mysql 时，还必须指定 allocated_storage、iops 和 db_cluster_instance_class。 当 engine=postgres 时，还必须指定 allocated_storage、iops 和 db_cluster_instance_class。 在 amazon.aws 5.5.0 中添加了对 postgres 和 mysql 的支持。 选项 "aurora" "aurora-mysql" "aurora-postgresql" "mysql" "postgres"
engine_mode 字符串 amazon.aws 5.5.0 中新增	数据库集群的数据库引擎模式。engine 和 engine_mode 的组合可能不受支持。 有关详细信息，请参阅 AWS 文档：Amazon RDS 文档。 选项 "provisioned" "serverless" "parallelquery" "global" "multimaster"
engine_version 字符串	要使用的数据库引擎的版本号。 对于 Aurora MySQL，可以是 5.6.10a、5.7.12。 Aurora PostgreSQL 示例，9.6.3。
final_snapshot_identifier 字符串	当 skip_final_snapshot=false 时创建的新数据库集群快照的数据库集群快照标识符。
force_backtrack 布尔值	一个布尔值，指示是否应强制数据库集群在启用二进制日志记录时回溯。否则，启用二进制日志记录时会发生错误。 选项 false true
force_update_password 布尔值	设置为 true 以使用 master_user_password 更新集群密码。 由于无法比较密码以确定是否需要更新，因此默认情况下将其设置为 false 以允许幂等性。 选项 false ← (默认) true
global_cluster_identifier 字符串	成为新全局数据库集群中主集群的 Aurora 集群的全局集群 ID。
iops 整数 amazon.aws 5.5.0 中新增	最初为多可用区数据库集群中的每个数据库实例分配的预配 IOPS（每秒输入/输出操作）数量。 此设置是创建多可用区数据库集群所必需的。 必须是数据库集群存储量的 0.5 到 50 倍的倍数。
kms_key_id 字符串	AWS KMS 密钥标识符（ARN，除非您是在拥有 KMS 密钥的同一帐户中创建集群，在这种情况下可以使用 KMS 密钥别名）。 如果 replication_source_identifier 指定了加密的源，则 Amazon RDS 将使用用于加密源的密钥。 如果 storage_encrypted=true 并且未提供 replication_source_identifier，则使用默认加密密钥。
master_user_password 别名：password 字符串	主数据库用户的 8-41 个字符的密码。 密码可以包含任何可打印的 ASCII 字符，但 /、" 或 @ 除外。 要修改密码，请使用 force_update_password。使用 apply_immediately 立即更改密码，否则会在下一个维护窗口期间更新。
master_username 别名：username 字符串	数据库集群的主用户的名称。必须是 1-16 个字母或数字，并且必须以字母开头。
new_db_cluster_identifier 别名：new_cluster_id、new_id、new_cluster_name 字符串	重命名数据库集群时数据库集群的新数据库集群（小写）标识符。 标识符必须包含 1 到 63 个字母、数字或连字符，第一个字符必须是字母，并且不能以连字符结尾或包含连续的连字符。 使用 apply_immediately 立即重命名，否则会在下一个维护窗口期间更新。
option_group_name 字符串	要与此数据库集群关联的选项组。
port 整数	DB集群中实例接收连接的端口号。如果未指定，则Amazon RDS默认情况下，如果engine为aurora，则默认为3306；如果engine为aurora-postgresql，则默认为5432。
preferred_backup_window 别名：backup_window 字符串	每日时间范围（UTC），至少30分钟，如果使用backup_retention_period启用自动备份，则在此期间创建自动备份。此选项必须采用“hh24:mi-hh24:mi”格式，并且不能与preferred_maintenance_window冲突。
preferred_maintenance_window 别名：maintenance_window 字符串	每周时间范围（UTC），至少30分钟，在此期间可以进行系统维护。此选项必须采用“ddd:hh24:mi-ddd:hh24:mi”格式，其中ddd是Mon、Tue、Wed、Thu、Fri、Sat、Sun之一。
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选项互斥。
promote 布尔值	设置为true以提升只读副本集群。 选项 false ← (默认) true
purge_cloudwatch_logs_exports 布尔值	是否禁用为DB集群启用的但在enable_cloudwatch_logs_exports中未提供的Cloudwatch日志。将enable_cloudwatch_logs_exports设置为空列表以禁用所有日志。 选项 false true ← (默认)
purge_security_groups 布尔值	设置为false以保留任务中未指定但与集群关联的任何已启用安全组。 可应用于vpc_security_group_ids 选项 false true ← (默认)
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等全球服务，将忽略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之后的一个版本中删除。
remove_from_global_db 布尔值 在amazon.aws 6.5.0中添加	如果设置为true，则集群将从全局DB中删除。 当remove_from_global_db=true时，必须指定参数global_cluster_identifier、db_cluster_identifier。 选项 false true
replication_source_identifier 别名：replication_src_id 字符串	如果此DB集群作为只读副本创建，则为源DB实例或DB集群的Amazon资源名称(ARN)。
restore_to_time 字符串	要将DB集群还原到的UTC日期和时间。必须采用“2015-03-07T23:45:00Z”格式。 如果在还原集群时未提供此选项，则必须提供use_latest_restorable_time。如果restore_type为copy-on-write，则可能不会指定此选项。
restore_type 字符串	要执行的还原类型。如果未提供，Amazon RDS将使用full-copy。 选项 "full-copy" "copy-on-write"
role_arn 字符串	要与Aurora DB集群关联的IAM角色的Amazon资源名称(ARN)，例如“arn:aws:iam::123456789012:role/AuroraAccessRole”
s3_bucket_name 字符串	包含用于创建Amazon Aurora DB集群的数据的Amazon S3存储桶的名称。
s3_ingestion_role_arn 字符串	AWS身份和访问管理(IAM)角色的Amazon资源名称(ARN)，该角色授权Amazon RDS代表您访问Amazon S3存储桶。
s3_prefix 字符串	包含用于创建Amazon Aurora DB集群的数据的所有文件名的前缀。 如果您未指定SourceS3Prefix值，则将使用Amazon S3存储桶中的所有文件创建Amazon Aurora DB集群。
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之后的一个版本中删除。
serverless_v2_scaling_configuration 字典 在amazon.aws 7.3.0中添加	包含Aurora Serverless v2 DB集群的缩放配置。
max_capacity 浮点数	Aurora Serverless v2集群中DB实例的最大Aurora容量单位(ACU)数。 ACU值可以以半步增量指定，例如40、40.5、41等等。 最大可能值为128。
min_capacity 浮点数	Aurora Serverless v2集群中DB实例的最小Aurora容量单位(ACU)数。 ACU值可以以半步增量指定，例如8、8.5、9等等。 最小可能值为0.5。
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之后的一个版本中删除。
skip_final_snapshot 布尔值	是否在删除DB集群之前创建最终的DB集群快照。 如果为false，则必须提供final_snapshot_identifier。 选项 false ← (默认) true
snapshot_identifier 字符串	要从中恢复的 DB 快照或 DB 集群快照的标识符。 您可以使用名称或 ARN 来指定 DB 集群快照。但是，您只能使用 ARN 来指定 DB 快照。
source_db_cluster_identifier 字符串	要从中恢复的源 DB 集群的标识符。
source_engine 字符串	存储在 Amazon S3 存储桶中的文件的备份数据库引擎的标识符。 选项 "mysql"
source_engine_version 字符串	备份文件创建自的数据库版本。
source_region 字符串	包含 DB 集群源的区域 ID。
state 字符串	快照是否应该存在。 started 和 stopped 只能与 Aurora 集群一起使用。 对 started 和 stopped 的支持是在 6.3.0 版本中添加的。 选项 "present" ← (默认) "absent" "started" "stopped"
storage_encrypted 布尔值	DB 集群是否已加密。 选项 false true
storage_type 字符串 amazon.aws 5.5.0 中新增	指定要与 DB 集群关联的存储类型。 此设置是创建多可用区数据库集群所必需的。 对于多可用区 DB 集群，storage_type 默认值为 io1，并且需要 iops 参数的值。 对于 Aurora DB 集群，storage_type 默认值为 aurora 标准。 对于 MySQL 和 PostgreSQL DB 集群，storage_type 默认值为 io1。 对 aurora 和 aurora-iopt1 的支持是在 8.2.0 版本中添加的。 选项 "io1" "aurora" "aurora-iopt1"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
use_earliest_time_on_point_in_time_unavailable 布尔值	如果 backtrack_to 设置为早于最早回溯时间的某个时间戳，则此值会将 DB 集群回溯到最早可能的回溯时间。否则，将发生错误。 选项 false true
use_latest_restorable_time 布尔值	是否将 DB 集群恢复到最新的可恢复备份时间。只能提供 use_latest_restorable_time 和 restore_to_time 之一。 选项 false true
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_security_group_ids 列表 / 元素=字符串	要与 DB 集群关联的 EC2 VPC 安全组列表。
wait 布尔值	是否等待集群可用或删除。 选项 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: Create minimal Aurora cluster in default VPC and default subnet group
  amazon.aws.rds_cluster:
    cluster_id: "{{ cluster_id }}"
    engine: "aurora"
    password: "{{ password }}"
    username: "{{ username }}"

- name: Add a new security group without purge
  amazon.aws.rds_cluster:
    id: "{{ cluster_id }}"
    state: present
    vpc_security_group_ids:
      - sg-0be17ba10c9286b0b
    purge_security_groups: false

- name: Modify password
  amazon.aws.rds_cluster:
    id: "{{ cluster_id }}"
    state: present
    password: "{{ new_password }}"
    force_update_password: true
    apply_immediately: true

- name: Rename the cluster
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "cluster-{{ resource_prefix }}"
    new_cluster_id: "cluster-{{ resource_prefix }}-renamed"
    apply_immediately: true

- name: Delete Aurora cluster without creating a final snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "{{ cluster_id }}"
    skip_final_snapshot: true
    tags:
      Name: "cluster-{{ resource_prefix }}"
      Created_By: "Ansible_rds_cluster_integration_test"
    state: absent

- name: Restore cluster from source snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "cluster-{{ resource_prefix }}-restored"
    snapshot_identifier: "cluster-{{ resource_prefix }}-snapshot"

- name: Create an Aurora PostgreSQL cluster and attach an intance
  amazon.aws.rds_cluster:
    state: present
    engine: aurora-postgresql
    engine_mode: provisioned
    cluster_id: '{{ cluster_id }}'
    username: '{{ username }}'
    password: '{{ password }}'

- name: Attach a new instance to the cluster
  amazon.aws.rds_instance:
    id: '{{ instance_id }}'
    cluster_id: '{{ cluster_id }}'
    engine: aurora-postgresql
    state: present
    db_instance_class: 'db.t3.medium'

- name: Remove a cluster from global DB (do not delete)
  amazon.aws.rds_cluster:
    db_cluster_identifier: '{{ cluster_id }}'
    global_cluster_identifier: '{{ global_cluster_id }}'
    remove_from_global_db: true

- name: Remove a cluster from global DB and Delete without creating a final snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "{{ cluster_id }}"
    skip_final_snapshot: true
    remove_from_global_db: true
    wait: true
    state: absent

- name: Update cluster port and WAIT for remove secondary DB cluster from global DB to complete
  amazon.aws.rds_cluster:
    db_cluster_identifier: "{{ secondary_cluster_name }}"
    global_cluster_identifier: "{{ global_cluster_name }}"
    remove_from_global_db: true
    state: present
    port: 3389
    region: "{{ secondary_cluster_region }}"

- name: Update cluster port and DO NOT WAIT for remove secondary DB cluster from global DB to complete
  amazon.aws.rds_cluster:
    db_cluster_identifier: "{{ secondary_cluster_name }}"
    global_cluster_identifier: "{{ global_cluster_name }}"
    remove_from_global_db: true
    state: present
    port: 3389
    region: "{{ secondary_cluster_region }}"
    wait: false

返回值

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

键	描述
activity_stream_status 字符串	数据库活动流的状态。 返回值：始终 示例："stopped"
allocated_storage 整数	以千兆字节为单位的已分配存储大小。由于 Aurora 存储大小不是固定的，因此对于 Aurora 数据库引擎，这始终为 1。 返回值：始终 示例：1
associated_roles 列表 / 元素=字符串	与 DB 集群关联的 AWS 身份和访问管理 (IAM) 角色的字典列表。每个字典都包含 role_arn 和角色的状态。 返回值：始终 示例：[]
auto_minor_version_upgrade 布尔值	指定是否在维护期间自动将次要引擎升级应用于 DB 集群。 返回值：始终 示例：true
availability_zones 列表 / 元素=字符串	DB 集群中的实例可以在其中创建的可用区列表。 返回值：始终 示例：["us-east-1c", "us-east-1a", "us-east-1e"]
backup_retention_period 整数	保留自动 DB 快照的天数。 返回值：始终 示例：1
changed 布尔值	如果 RDS 集群已更改。 返回值：始终 示例：true
cluster_create_time 字符串	创建 DB 集群的 UTC 时间。 返回值：始终 示例："2018-06-29T14:08:58.491000+00:00"
copy_tags_to_snapshot 布尔值	指定是否将标签从 DB 集群复制到 DB 集群的快照。 返回值：始终 示例：false
cross_account_clone 布尔值	指定 DB 集群是否是不同 Amazon Web Services 帐户拥有的 DB 集群的克隆。 返回值：始终 示例：false
db_cluster_arn 字符串	DB 集群的 Amazon 资源名称 (ARN)。 返回值：始终 示例："arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo"
db_cluster_identifier 字符串	用户提供的 DB 集群标识符（小写）。 返回值：始终 示例："rds-cluster-demo"
db_cluster_members 列表 / 元素=字符串	包含有关集群中实例的信息的字典列表。每个字典都包含 db_instance_identifier、is_cluster_writer（布尔值）、db_cluster_parameter_group_status 和 promotion_tier（整数）。 返回值：始终 示例：[]
db_cluster_parameter_group 字符串	与 DB 集群关联的参数组。 返回值：始终 示例："default.aurora5.6"
db_cluster_resource_id 字符串	DB 集群的 AWS 区域唯一、不可变标识符。 返回值：始终 示例："cluster-D2MEQDN3BQNXDF74K6DQJTHASU"
db_subnet_group 字符串	与 DB 集群关联的子网组的名称。 返回值：始终 示例："default"
deletion_protection 布尔值	指示 DB 集群是否启用了删除保护。启用删除保护后，无法删除数据库。 返回值：始终 示例：false
domain_memberships 列表 / 元素=字符串	与 DB 集群关联的 Active Directory 域成员身份记录。 返回值：始终 示例：[]
earliest_restorable_time 字符串	可以使用 point-in-time 还原将数据库还原到的最早时间。 返回值：始终 示例："2018-06-29T14:09:34.797000+00:00"
endpoint 字符串	DB 集群主实例的连接端点。 返回值：始终 示例："rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com"
engine 字符串	DB 集群的数据库引擎。 返回值：始终 示例："aurora"
engine_mode 字符串	DB 集群的 DB 引擎模式。 返回值：始终 示例："provisioned"
engine_version 字符串	数据库引擎版本。 返回值：始终 示例："5.6.10a"
hosted_zone_id 字符串	创建托管区域时 Amazon Route 53 分配的 ID。 返回值：始终 示例："Z2R2ITUGPM61AM"
http_endpoint_enabled 布尔值	指示 Aurora Serverless DB 集群的 HTTP 端点是否启用的值。 返回值：始终 示例：false
iam_database_authentication_enabled 布尔值	IAM 帐户是否可以映射到数据库帐户。 返回值：始终 示例：false
latest_restorable_time 字符串	可以使用 point-in-time 还原将数据库还原到的最新时间。 返回值：始终 示例："2018-06-29T14:09:34.797000+00:00"
master_username 字符串	DB 集群的主用户名。 返回值：始终 示例："username"
multi_az 布尔值	DB 集群是否在多个可用区中具有实例。 返回值：始终 示例：false
port 整数	数据库引擎正在侦听的端口。 返回值：始终 示例：3306
preferred_backup_window 字符串	可以进行系统维护的 UTC 每周时间范围。 返回值：始终 示例："10:18-10:48"
preferred_maintenance_window 字符串	可以进行系统维护的 UTC 每周时间范围。 返回值：始终 示例："tue:03:23-tue:03:53"
read_replica_identifiers 列表 / 元素=字符串	与 DB 集群关联的只读副本 ID 字符串列表。 返回值：始终 示例：[]
reader_endpoint 字符串	DB 集群的读取器端点。 返回值：始终 示例："rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com"
serverless_v2_scaling_configuration 字典 在amazon.aws 7.3.0中添加	Aurora Serverless v2 数据库集群的缩放配置。 返回：已配置时 示例： {"max_capacity": 4.5, "min_capacity": 2.5}
状态 字符串	数据库集群的状态。 返回值：始终 示例： "available"
storage_encrypted 布尔值	数据库集群是否启用存储加密。 返回值：始终 示例：false
标签列表 列表 / 元素=字典	由键值对组成的标签列表。 返回值：始终 示例： [{"key": "Created_By", "value": "Ansible_rds_cluster_integration_test"}]
标签 字典	键值对字典。 返回值：始终 示例： {"Name": "rds-cluster-demo"}
VPC 安全组 复杂类型	数据库集群的安全组及其状态列表。 返回值：始终
状态 字符串	安全组的状态。 返回值：始终 示例： "active"
VPC 安全组 ID 字符串	集群的安全组。 返回值：始终 示例： "sg-12345678"

作者

• Sloane Hertel (@s-hertel)

• Alina Buzachis (@alinabuzachis)

资源链接

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