DynamoDb - AWS Serverless Application Model
语法属性

DynamoDb

将 Amazon DynamoDB 表配置为 GraphQL API 解析程序的数据源。

语法

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

YAML

LogicalId:
  DeltaSync: DeltaSyncConfig
  Description: String
  Name: String
  Permissions: List
  Region: String
  ServiceRoleArn: String
  TableArn: String
  TableName: String
  UseCallerCredentials: Boolean
  Versioned: Boolean

属性

DeltaSync

描述增量同步配置。

类型：DeltaSyncConfig

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource DynamoDBConfig 对象的 DeltaSyncConfig 属性。

Description

数据源的描述。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource 资源的 Description 属性。

LogicalId

数据源的唯一名称。

类型：字符串

必需：是

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource 资源的 Name 属性。

Name

数据源的名称。指定此属性以覆盖 LogicalId 值。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource 资源的 Name 属性。

Permissions

使用 AWS SAM 连接器 配置对数据源的权限。您可以在列表中提供以下任何值：

  • Read - 允许解析程序读取数据源。

  • Write - 允许解析程序将数据写入到数据源。

AWS SAM 使用在部署时转换的 AWS::Serverless::Connector 资源来配置权限。要了解有关生成的资源的信息，请参阅在指定了 AWS::Serverless::Connector 的情况下生成的 CloudFormation 资源。

注意

您可以指定 Permissions 或 ServiceRoleArn，但不能同时指定两者。如果两者都未指定，则 AWS SAM 会生成 Read 和 Write 的默认值。要撤销对数据源的访问权限，请从 AWS SAM 模板中移除 DynamoDB 对象。

类型：列表

必需：否

CloudFormation 兼容性：此属性为 AWS SAM 独有，没有 CloudFormation 等效属性。它类似于 AWS::Serverless::Connector 资源的 Permissions 属性。

Region

DynamoDB 表的 AWS 区域。如果您不指定该项，AWS SAM 使用 AWS::Region。

类型：字符串

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource DynamoDBConfig 对象的 AwsRegion 属性。

ServiceRoleArn

数据源的 AWS Identity and Access Management (IAM) 服务角色 ARN。在访问数据源时，系统将代入此角色。

您可以指定 Permissions 或 ServiceRoleArn，但不能同时指定两者。

类型：字符串

必需：否。如果未指定，则 AWS SAM 会应用 Permissions 的默认值。

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource 资源的 ServiceRoleArn 属性。

TableArn

DynamoDB 表的 ARN。

类型：字符串

必填：条件性。如果未指定 ServiceRoleArn，则需要有 TableArn。

CloudFormation 兼容性：此属性为 AWS SAM 独有，没有 CloudFormation 等效属性。

TableName

表名称。

类型：字符串

必需：是

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource DynamoDBConfig 对象的 TableName 属性。

UseCallerCredentials

设置为 true 以将 IAM 与此数据源一起使用。

类型：布尔值

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource DynamoDBConfig 对象的 UseCallerCredentials 属性。

Versioned

设置为 true 以将冲突检测、冲突解决和同步与该数据源一起使用。

类型：布尔值

必需：否

CloudFormation 兼容性：此属性直接传递给 AWS::AppSync::DataSource DynamoDBConfig 对象的 Versioned 属性。