DynamoDb - AWS Serverless Application Model
構文プロパティ

DynamoDb

GraphQL API リゾルバーのデータソースとして Amazon DynamoDB テーブルを設定します。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

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

プロパティ

DeltaSync

デルタ同期の構成について説明します。

Type: DeltaSyncConfig

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource DynamoDBConfig オブジェクトの DeltaSyncConfig プロパティに直接渡されます。

Description

データソースの説明です。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource リソースの Description プロパティに直接渡されます。

LogicalId

データソースの一意の名前です。

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource リソースの Name プロパティに直接渡されます。

Name

データソースの名前です。このプロパティを指定して、LogicalId 値を上書きします。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource リソースの Name プロパティに直接渡されます。

Permissions

AWS SAM コネクタ を使用して、データソースに許可をプロビジョニングします。リストには、以下の値のいずれかを指定できます。

  • Read – データソースの読み取りをリゾルバーに許可します。

  • Write – データソースの書き込みをリゾルバーに許可します。

AWS SAM は、デプロイ時に変換された AWS::Serverless::Connector リソースを使用して、許可をプロビジョニングします。生成されたリソースについては、「AWS::Serverless::Connector を指定したときに生成された CloudFormation リソース」を参照してください。

注記

Permissions または ServiceRoleArn を指定できます。両方を指定することはできません。どちらも指定されていない場合、AWS SAM は Read および Write のデフォルト値を生成します。データソースへのアクセスを取り消すには、AWS SAM テンプレートから DynamoDB オブジェクトを削除します。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。これは、AWS::Serverless::Connector リソースの Permissions プロパティに似ています。

Region

DynamoDB テーブルの AWS リージョン です。指定しない場合、AWS SAM は AWS::Region を使用します。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource DynamoDBConfig オブジェクトの AwsRegion プロパティに直接渡されます。

ServiceRoleArn

データソースの AWS Identity and Access Management (IAM) サービスロール ARN です。システムは、データソースにアクセスするときにこのロールを引き受けます。

Permissions または ServiceRoleArn を指定できます。両方を指定することはできません。

タイプ: 文字列

必須: いいえ。指定されていない場合、AWS SAM は Permissions のデフォルト値を適用します。

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource リソースの ServiceRoleArn プロパティに直接渡されます。

TableArn

DynamoDB テーブルの ARN です。

タイプ: 文字列

必須: 条件的。ServiceRoleArn を指定しない場合は、TableArn が必要になります。

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

TableName

テーブルの名前。

タイプ: 文字列

必須: はい

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource DynamoDBConfig オブジェクトの TableName プロパティに直接渡されます。

UseCallerCredentials

true に設定して、このデータソースで IAM を使用します。

タイプ: ブール

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource DynamoDBConfig オブジェクトの UseCallerCredentials プロパティに直接渡されます。

Versioned

true に設定して、このデータソースで Conflict Detection、Conflict Resolution、および Sync を使用します。

タイプ: ブール

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::AppSync::DataSource DynamoDBConfig オブジェクトの Versioned プロパティに直接渡されます。