AWS::Serverless::SimpleTable - AWS Serverless Application Model
構文プロパティ戻り値例

AWS::Serverless::SimpleTable

単一属性のプライマリキーで DynamoDB テーブルを作成します。これは、データへのアクセスがプライマリキー経由でのアクセスに限定されている場合に役立ちます。

より高度な機能については、CloudFormation で AWS::DynamoDB::Table リソースを使用します。これらのリソースは AWS SAM で使用できます。これらは包括的であり、key schema や resource policy のカスタマイズなど、さらなるカスタマイズを提供します。

注記

AWS CloudFormation にデプロイすると、AWS SAM は、AWS SAM リソースを CloudFormation リソースに変換します。詳細については、「AWS SAM 向けに生成された CloudFormation リソース」を参照してください。

構文

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

プロパティ

PointInTimeRecoverySpecification

ポイントインタイムリカバリを有効にするための設定。

タイプ: PointInTimeRecoverySpecification

必須: いいえ

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

PrimaryKey

テーブルのプライマリキーとして使用される属性の名前とタイプです。指定しない場合、プライマリキーは値が id の String になります。

注記

このプロパティの値は、このリソースが作成された後で変更することはできません。

タイプ: PrimaryKeyObject

必須: いいえ

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

ProvisionedThroughput

読み取りおよび書き込みスループットのプロビジョニング情報です。

ProvisionedThroughput が指定されていない場合、BillingMode は PAY_PER_REQUEST として指定されます。

タイプ: ProvisionedThroughputObject

必須: いいえ

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

SSESpecification

サーバー側の暗号化を有効にする設定を指定します。

タイプ: SSESpecification

必須: いいえ

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

TableName

DynamoDB テーブルの名前です。

型: 文字列

必須: いいえ

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

Tags

この SimpleTable に追加されるタグを指定するマップ (文字列対文字列) です。タグの有効なキーと値の詳細については、AWS CloudFormation ユーザーガイドのリソースタグを参照してください。

タイプ: マップ

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::DynamoDB::Table リソースの Tags プロパティに似ています。SAM の Tags プロパティは、キーバリューペアで構成されています。CloudFormation では、タグオブジェクトのリストで構成されています。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、基盤となる DynamoDB テーブルのリソース名 が返されます。

Ref 関数の使用方法の詳細については、AWS CloudFormation ユーザーガイドの「Ref」を参照してください。

例

SimpleTableExample

SimpleTable の例

YAML

Properties:
  TableName: my-table
  PrimaryKey:
    Name: MyPrimaryKey
    Type: String
  ProvisionedThroughput:
    ReadCapacityUnits: 5
    WriteCapacityUnits: 5
  Tags:
    Department: Engineering
    AppType: Serverless