DynamoDb

Konfigurieren Sie eine Amazon DynamoDB-Tabelle als Datenquelle für Ihren GraphQL API-Resolver.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

YAML

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

Eigenschaften

DeltaSync

Beschreibt eine Delta Sync-Konfiguration.

Typ: DeltaSyncConfig

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die DeltaSyncConfig Eigenschaft eines AWS::AppSync::DataSource DynamoDBConfig Objekts übergeben.

Description

Die Beschreibung Ihrer Datenquelle.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Description Eigenschaft einer AWS::AppSync::DataSource Ressource übergeben.

LogicalId

Der eindeutige Name Ihrer Datenquelle.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Name Eigenschaft einer AWS::AppSync::DataSource Ressource übergeben.

Name

Der Name Ihrer Datenquelle. Geben Sie diese Eigenschaft an, um den LogicalId Wert zu überschreiben.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Name Eigenschaft einer AWS::AppSync::DataSource Ressource übergeben.

Permissions

Erteilen Sie Berechtigungen für Ihre Datenquelle mithilfe vonAWS SAM Konnektoren. Sie können jeden der folgenden Werte in einer Liste angeben:

• Read— Erlauben Sie Ihrem Resolver, Ihre Datenquelle zu lesen.

• Write— Erlauben Sie Ihrem Resolver, in Ihre Datenquelle zu schreiben.

AWS SAM verwendet eine AWS::Serverless::Connector Ressource, die bei der Bereitstellung transformiert wird, um Ihre Berechtigungen bereitzustellen. Weitere Informationen zu generierten Ressourcen finden Sie unterAWS CloudFormation -Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector.

Anmerkung

Sie können Permissions oder ServiceRoleArn angeben, aber nicht beides. Wenn keines der beiden angegeben ist, AWS SAM werden Standardwerte von Read und generiertWrite. Um den Zugriff auf Ihre Datenquelle zu widerrufen, entfernen Sie das DynamoDB-Objekt aus Ihrer AWS SAM Vorlage.

Typ: Liste

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent. Sie ähnelt der Permissions Eigenschaft einer AWS::Serverless::Connector Ressource.

Region

Die AWS-Region Ihrer DynamoDB-Tabelle. Wenn Sie es nicht angeben, AWS SAM verwendet. AWS::Region

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die AwsRegion Eigenschaft eines AWS::AppSync::DataSource DynamoDBConfig Objekts übergeben.

ServiceRoleArn

Die AWS Identity and Access Management (IAM-) Dienstrolle ARN für die Datenquelle. Das System übernimmt diese Rolle beim Zugriff auf die Datenquelle.

Sie können Permissions oder ServiceRoleArn angeben, aber nicht beides.

Typ: Zeichenfolge

Erforderlich: Nein. Wenn nicht angegeben, wird der Standardwert für AWS SAM angewendetPermissions.

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die ServiceRoleArn Eigenschaft einer AWS::AppSync::DataSource Ressource übergeben.

TableArn

Der ARN für die DynamoDB-Tabelle.

Typ: Zeichenfolge

Erforderlich: Bedingt. Wenn Sie es nicht angebenServiceRoleArn, TableArn ist es erforderlich.

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

TableName

Der Name der Tabelle.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die TableName Eigenschaft eines AWS::AppSync::DataSource DynamoDBConfig Objekts übergeben.

UseCallerCredentials

Legt festtrue, dass IAM mit dieser Datenquelle verwendet wird.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die UseCallerCredentials Eigenschaft eines AWS::AppSync::DataSource DynamoDBConfig Objekts übergeben.

Versioned

Auf Konflikterkennung, Konfliktlösung und Synchronisation mit dieser Datenquelle eingestellt. true

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Versioned Eigenschaft eines AWS::AppSync::DataSource DynamoDBConfig Objekts übergeben.