DynamoDb - AWS Serverless Application Model
SintaxePropriedades

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DynamoDb

Configure uma tabela do Amazon DynamoDB como fonte de dados para seu resolvedor de GraphQL API.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

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

Propriedades

DeltaSync

Descreve uma configuração de sincronização delta.

Tipo: DeltaSyncConfig

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a DeltaSyncConfig propriedade de um AWS::AppSync::DataSource DynamoDBConfig objeto.

Description

A descrição da sua fonte de dados.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Description propriedade de um AWS::AppSync::DataSource recurso.

LogicalId

O nome exclusivo de sua fonte de dados.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Name propriedade de um AWS::AppSync::DataSource recurso.

Name

O nome da sua fonte de dados. Especifique essa propriedade para substituir o valor LogicalId.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Name propriedade de um AWS::AppSync::DataSource recurso.

Permissions

Provisione permissões para sua fonte de dados usando conectores do AWS SAM . Você pode fornecer qualquer um dos seguintes valores em uma lista:

  • Read - Permite que seu resolvedor leia sua fonte de dados.

  • Write - Permite que seu resolvedor grave em sua fonte de dados.

AWS SAM usa um AWS::Serverless::Connector recurso que é transformado na implantação para provisionar suas permissões. Para saber mais sobre os recursos gerados, consulte Os recursos AWS CloudFormation gerados quando você especifica AWS::Serverless::Connector.

nota

Você pode especificar Permissions ou ServiceRoleArn, mas não ambos. Se nenhum for especificado, AWS SAM gerará valores padrão de Read Write e. Para revogar o acesso à sua fonte de dados, remova o objeto DynamoDB do seu modelo. AWS SAM

Tipo: lista

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente. É semelhante à propriedade Permissions de um recurso AWS::Serverless::Connector.

Region

A Região da AWS da sua tabela do DynamoDB. Se você não especificar, AWS SAM usaAWS::Region.

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a AwsRegion propriedade de um AWS::AppSync::DataSource DynamoDBConfig objeto.

ServiceRoleArn

O ARN da função de serviço AWS Identity and Access Management (IAM) da fonte de dados. O sistema assume essa função ao acessar a fonte de dados.

Você pode especificar Permissions ou ServiceRoleArn, mas não ambos.

Tipo: string

Obrigatório: Não. Se não for especificado, AWS SAM aplica o valor padrão paraPermissions.

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a ServiceRoleArn propriedade de um AWS::AppSync::DataSource recurso.

TableArn

O ARN da tabela do DynamoDB.

Tipo: string

Obrigatório: condicional. Se você não especificar o ServiceRoleArn, o TableArn será necessário.

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

TableName

O nome da tabela.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a TableName propriedade de um AWS::AppSync::DataSource DynamoDBConfig objeto.

UseCallerCredentials

Defina como true para usar o IAM com essa fonte de dados.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a UseCallerCredentials propriedade de um AWS::AppSync::DataSource DynamoDBConfig objeto.

Versioned

Defina como true para usar a Detecção de conflitos, resolução de conflitos e sincronização com esta fonte de dados.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Versioned propriedade de um AWS::AppSync::DataSource DynamoDBConfig objeto.