community.aws.dynamodb_table_info 模块 – 返回 Dynamo DB 表的信息

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.dynamodb_table_info。

community.aws 7.2.0 中的新增功能

概要

• 返回有关 Dynamo DB 表的信息，包括表的当前状态、创建时间、主键模式以及表上的任何索引。

要求

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

• 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 后的某个版本中删除。
name 字符串 / 必需	要描述的表的名称。
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 保持一致，别名 aws_secret_access_key 已在 5.1.0 版本中添加。 别名 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。

示例

- name: Return information about the DynamoDB table named 'my-table'
  community.aws.dynamodb_table_info:
    name: my-table

返回值

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

键	描述
table 复杂类型	describe API 调用返回的表参数。 返回值：成功
archival_summary 复杂类型	包含有关表归档的信息。 返回值：如有，在表上
archival_backup_arn 字符串	表归档到的备份的 Amazon 资源名称 (ARN)，在归档原因中适用。 返回值：始终返回
archival_date_time 字符串	DynamoDB 启动表归档的日期和时间，采用 UNIX 时间戳格式。 返回值：始终返回
archival_reason 字符串	DynamoDB 归档表的原因。 返回值：始终返回 示例："INACCESSIBLE_ENCRYPTION_CREDENTIALS"
attribute_definitions 复杂类型	用于描述表和索引的关键架构的属性列表。 返回值：始终返回
attribute_name 字符串	属性名称。 返回值：始终返回
attribute_type 字符串	属性的数据类型，S（字符串）、N（数字）和 B（二进制）。 返回值：始终返回
billing_mode 字符串	控制如何对读取和写入吞吐量收费以及如何管理容量。 返回值：始终返回
creation_date_time 字符串	表创建的日期和时间，采用 UNIX 时间戳格式。 返回值：始终返回
deletion_protection_enabled 布尔值	指示是否在表上启用 (true) 或禁用 (false) 删除保护。 返回值：始终返回 示例：true
global_secondary_indexes 列表 / 元素=字典	表的全局二级索引。 返回值：如有，在表上
global_table_version 字符串	如果表跨 AWS 区域复制，则表示正在使用的全局表版本。 返回值：如果表已复制
item_count 整数	指定表中的项目数。 返回值：始终返回
key_schema 复杂类型	指定构成表主键或索引的关键属性的属性列表。 返回值：始终返回
attribute_name 字符串	关键属性的名称。 返回值：始终返回
key_type 字符串	此关键属性将承担的角色，“HASH” 用于分区键，“RANGE” 用于排序键 返回值：始终返回
latest_stream_arn 字符串	唯一标识此表最新流的 Amazon 资源名称 (ARN)。 返回值：表上如有
latest_stream_label 字符串	此流的 ISO 8601 格式的时间戳。 返回值：表上如有
local_secondary_indexes 列表 / 元素=字典	表示表上的一个或多个本地二级索引。 返回值：如有，在表上
provisioned_throughput 字典	表的预配吞吐量设置。 返回值：始终返回 示例：{"number_of_decreases_today": 0, "read_capacity_units": 1, "write_capacity_units": 1}
replicas 列表 / 元素=字典	表示表的副本。 返回值：表上如有
restore_date_time 字符串	时间点或源备份时间。 返回值：如有，在表上
restore_in_progress 布尔值	指示是否正在进行恢复。 返回值：如有，在表上
source_backup_arn 字符串	从中恢复表的备份的 Amazon 资源名称 (ARN)。 返回值：如有，在表上
source_table_arn 字符串	正在恢复的备份的源表的 ARN。 返回值：如有，在表上
sse_description 字典	指定表上服务器端加密状态的描述。 返回值：如有，在表上 示例：{}
stream_specification 复杂类型	表的当前 DynamoDB Streams 配置。 返回值：如有，在表上
stream_enabled 布尔值	指示是否在表上启用 (true) 或禁用 (false) DynamoDB Streams。 返回值：始终返回 示例：true
stream_view_type 字符串	修改表中的项目时，stream_view_type 决定为此表写入流中的哪些信息。 返回值：始终返回 示例："KEYS_ONLY"
table_arn 字符串	唯一标识表的 Amazon 资源名称 (ARN)。 返回值：始终返回
table_class 字符串	指定表的表类。 返回值：表上如有 示例："STANDARD_INFREQUENT_ACCESS"
table_id 字符串	为其创建备份的表的唯一标识符。 返回值：始终返回
table_name 字符串	表的名称。 返回值：始终返回
table_size_bytes 整数	指定表的总大小（以字节为单位）。 返回值：始终返回
table_status 字符串	表的当前状态。 返回值：始终返回 示例："ACTIVE"
tags 字典	与 DynamoDB 表关联的标签字典。 返回值：始终返回

作者

• Aubin Bikouo (@abikouo)

资源链接

• 问题跟踪器
• 代码仓库
• 沟通