DynamoDb

Configurez une table Amazon DynamoDB comme source de données pour votre résolveur d'API GraphQL.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

DeltaSync

Décrit une configuration Delta Sync.

Type : DeltaSyncConfig

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la DeltaSyncConfig propriété d'un AWS::AppSync::DataSource DynamoDBConfig objet.

Description

Description de la source de données.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Description propriété d'une AWS::AppSync::DataSource ressource.

LogicalId

Nom unique de la source de données.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Name propriété d'une AWS::AppSync::DataSource ressource.

Name

Nom de la source de données. Spécifiez cette propriété pour remplacer la valeur LogicalId.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Name propriété d'une AWS::AppSync::DataSource ressource.

Permissions

Accordez des autorisations à votre source de données à l'aide de Connecteurs AWS SAM . Vous pouvez fournir une entrée des façons suivantes :

• Read— Autorisez votre résolveur à lire votre source de données.

• Write— Autorisez votre résolveur à écrire dans votre source de données.

AWS SAM utilise une AWS::Serverless::Connector ressource qui est transformée lors du déploiement pour fournir vos autorisations. Pour en savoir plus sur les ressources générées, consultez Ressources AWS CloudFormation générées lorsque vous spécifiez AWS::Serverless::Connector.

Note

Vous pouvez spécifier Permissions ou ServiceRoleArn, mais pas les deux. Si aucune des deux n'est spécifiée, AWS SAM générera les valeurs par défaut de Read etWrite. Pour révoquer l'accès à votre source de données, supprimez l'objet DynamoDB de votre modèle. AWS SAM

Type: liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent. Elle est similaire à la propriétéPermissions d'une ressource AWS::Serverless::Connector.

Region

Le Région AWS de votre table DynamoDB. Si vous ne le spécifiez pas, AWS SAM utiliseAWS::Region.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la AwsRegion propriété d'un AWS::AppSync::DataSource DynamoDBConfig objet.

ServiceRoleArn

L'ARN du rôle de service AWS Identity and Access Management (IAM) pour la source de données. Le système assume ce rôle lors de l'accès à la source de données.

Vous pouvez spécifier Permissions ou ServiceRoleArn, mais pas les deux.

Type : chaîne

Nécessaire : Non Si elle n'est pas spécifiée, AWS SAM applique la valeur par défaut pourPermissions.

AWS CloudFormation compatibilité : cette propriété est transmise directement à la ServiceRoleArn propriété d'une AWS::AppSync::DataSource ressource.

TableArn

L'ARN de la table DynamoDB.

Type : chaîne

Obligatoire : selon les conditions. Si vous ne spécifiez pas ServiceRoleArn, TableArn est obligatoire.

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

TableName

Nom de la table.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la TableName propriété d'un AWS::AppSync::DataSource DynamoDBConfig objet.

UseCallerCredentials

Définir sur true pour utiliser IAM avec cette source de données.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la UseCallerCredentials propriété d'un AWS::AppSync::DataSource DynamoDBConfig objet.

Versioned

Définir sur true pour utiliser la détection et la résolution des conflits et synchroniser avec cette source de données.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Versioned propriété d'un AWS::AppSync::DataSource DynamoDBConfig objet.