AWS::Serverless::SimpleTable - AWS Serverless Application Model

AWS::Serverless::SimpleTable

创建具有单个属性主键的 DynamoDB 表。当只需要通过主键访问数据时,它很有用。

要获得更多高级功能,请使用 CloudFormation 中的 AWS::DynamoDB::Table 资源。这些资源可以在 AWS SAM 中使用。它们内容全面,并支持进一步定制,包括 key schemaresource policy 定制。

注意

部署到 AWS CloudFormation 时,AWS SAM 会将您的 AWS SAM 资源转换为 CloudFormation 资源。有关更多信息,请参阅 为 AWS SAM 生成的 CloudFormation 资源

语法

要在您的 AWS Serverless Application Model (AWS SAM) 模板中声明此实体,请使用以下语法。

属性

PointInTimeRecoverySpecification

用于启用时间点恢复的设置。

类型PointInTimeRecoverySpecification

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::DynamoDB::Table 资源的 PointInTimeRecoverySpecification 属性。

PrimaryKey

用作表主键的属性名称和类型。如果未提供,则主键将为 String,值为 id

注意

创建此资源后,无法修改此属性的值。

类型PrimaryKeyObject

必需:否

CloudFormation 兼容性:此属性为 AWS SAM 独有,没有 CloudFormation 等效属性。

ProvisionedThroughput

读取和写入吞吐量配置信息。

如果未指定 ProvisionedThroughput,则将 BillingMode 指定为 PAY_PER_REQUEST

类型ProvisionedThroughputObject

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::DynamoDB::Table 资源的 ProvisionedThroughput 属性。

SSESpecification

指定用于启用服务器端加密的设置。

类型SSESpecification

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::DynamoDB::Table 资源的 SSESpecification 属性。

TableName

DynamoDB 表的名称。

类型:字符串

必需:否

CloudFormation 兼容性:此属性直接传递给 AWS::DynamoDB::Table 资源的 TableName 属性。

Tags

指定要添加到此 SimpleTable 的标签的映射(字符串到字符串)。有关标签的有效键和值的详细信息,请参阅《AWS CloudFormation 用户指南》中的资源标签

类型:映射

必需:否

CloudFormation 兼容性:此属性类似于 AWS::DynamoDB::Table 资源的 Tags 属性。SAM 中的“标签”属性由“键:值”对组成;在 CloudFormation 中,它由标签对象列表组成。

返回值

Ref

当该资源的逻辑 ID 提供给 Ref 内置函数时,它将返回底层 DynamoDB 表的资源名称。

有关使用 Ref 函数的更多信息,请参阅《AWS CloudFormation 用户指南》中的 Ref

示例

SimpleTableExample

SimpleTable 示例

YAML

Properties: TableName: my-table PrimaryKey: Name: MyPrimaryKey Type: String ProvisionedThroughput: ReadCapacityUnits: 5 WriteCapacityUnits: 5 Tags: Department: Engineering AppType: Serverless