DynamoDb - AWS Serverless Application Model
SintaxePropriedades

DynamoDb

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

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

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.

Type: DeltaSyncConfig

Obrigatório: não

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

Description

A descrição da sua fonte de dados.

Tipo: string

Obrigatório: não

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

LogicalId

O nome exclusivo de sua fonte de dados.

Tipo: string

Obrigatório: Sim

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

Name

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

Tipo: string

Obrigatório: não

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

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 SAMusa um recurso AWS::Serverless::Connector que é transformado na implantação para provisionar suas permissões. Para saber mais sobre os recursos gerados, consulte Os recursos CloudFormation gerados quando você especifica AWS::Serverless::Connector.

nota

É possível especificar Permissions ou ServiceRoleArn, mas não ambos. Se nenhum for especificado, AWS SAM gerará valores padrão de Read eWrite. Para revogar o acesso à sua fonte de dados, remova o objeto DynamoDB do seu modelo AWS SAM.

Tipo: lista

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem 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, o AWS SAM usará AWS::Region.

Tipo: string

Obrigatório: não

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

ServiceRoleArn

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

É possível 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 para Permissions.

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

TableArn

O ARN da tabela do DynamoDB.

Tipo: string

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

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

TableName

O nome da tabela.

Tipo: string

Obrigatório: Sim

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

UseCallerCredentials

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

Tipo: booliano

Obrigatório: não

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

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

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