DynamoDb - AWS Serverless Application Model
SintaxisPropiedades

DynamoDb

Configura una tabla de Amazon DynamoDB como origen de datos para su solucionador de API de GraphQL.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

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

Propiedades

DeltaSync

Describe una configuración de Delta Sync.

Type: DeltaSyncConfig

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad DeltaSyncConfig de un objeto de AWS::AppSync::DataSource DynamoDBConfig.

Description

La descripción de su origen de datos.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Description de un recurso AWS::AppSync::DataSource.

LogicalId

El nombre único de su origen de datos.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::AppSync::DataSource.

Name

El nombre de su origen de datos. Especifica esta propiedad para anular el valor LogicalId.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::AppSync::DataSource.

Permissions

Aprovisione permisos a su origen de datos utilizando Conectores AWS SAM . Puedes proporcionar cualquiera de los siguientes valores en una lista:

  • Read – Permita que su solucionador lea su origen de datos.

  • Write – Permita que su solucionador escriba su origen de datos.

AWS SAM utiliza un recurso de AWS::Serverless::Connector que se transforma en el momento de la implementación para aprovisionar sus permisos. Para más información sobre los recursos generados, consulta CloudFormation recursos generados cuando se especifica AWS::Serverless::Connector.

nota

Puedes especificar Permissions o ServiceRoleArn, pero no ambos. Si no se especifica ninguno, AWS SAM generará los valores predeterminados de Read y Write. Para revocar el acceso al origen de datos, elimine el objeto DynamoDB de la plantilla de AWS SAM.

Tipo: lista

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation. Es similar a la propiedad Permissions de un recurso AWS::Serverless::Connector.

Region

La Región de AWS de su tabla de DynamoDB. Si no se especifica, AWS SAM utiliza AWS::Region.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad AwsRegion de un objeto de AWS::AppSync::DataSource DynamoDBConfig.

ServiceRoleArn

El ARN del rol de servicio (IAM) de AWS Identity and Access Management para el origen de datos. El sistema adopta este rol al acceder al origen de datos.

Puedes especificar Permissions o ServiceRoleArn, pero no ambos.

Tipo: cadena

Obligatorio: no. Si no se especifica, AWS SAM aplica el valor predeterminado para Permissions.

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad ServiceRoleArn de un recurso AWS::AppSync::DataSource.

TableArn

El ARN para la tabla de DynamoDB

Tipo: cadena

Obligatorio: condicional. Si no se especifica el ServiceRoleArn, la TableArn es obligatoria.

Compatibilidad con CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente CloudFormation.

TableName

El nombre de la tabla.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad TableName de un objeto de AWS::AppSync::DataSource DynamoDBConfig.

UseCallerCredentials

Establécelo en true para utilizar IAM con este origen de datos.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad UseCallerCredentials de un objeto de AWS::AppSync::DataSource DynamoDBConfig.

Versioned

Establécelo en true para utilizar Detección de conflictos, resolución de conflictos y sincronización con este origen de datos.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Versioned de un objeto de AWS::AppSync::DataSource DynamoDBConfig.