AWS::DynamoDB::Table KeySchema - AWS CloudFormation

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS::DynamoDB::Table KeySchema

キースキーマの 1 つの要素を表します。キースキーマは、テーブルのプライマリキーを構成する属性、またはインデックスのキー属性を指定します。

KeySchemaElement は、プライマリキーの 1 つの属性のみを表します。たとえば、シンプルなプライマリキーは、1 つの KeySchemaElement (パーティションキー用) で表されます。複合プライマリキーでは、パーティションキー用に 1 つの KeySchemaElement が必要であり、ソートキー用にもう 1 つの KeySchemaElement が必要です。

KeySchemaElement は、(入れ子の属性ではなく) スカラーの最上位属性である必要があります。データ型は、文字列型、数値型、またはバイナリ型のいずれかである必要があります。属性をリストまたはマップ内で入れ子にすることはできません。

構文

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

JSON

{ "AttributeName" : String, "KeyType" : String }

YAML

AttributeName: String KeyType: String

プロパティ

AttributeName

キー属性の名前。

必須: はい

タイプ: 文字列

最小: 1

最大: 255

アップデートに関する要件: 中断はありません

KeyType

キー属性が担うロール:

  • HASH - パーティションキー

  • RANGE - ソートキー

注記

項目のパーティションキーは、そのハッシュ属性とも呼ばれます。「ハッシュ属性」という用語は、DynamoDB が内部のハッシュ関数を使用し、パーティションキーの値に基づいてパーティション間でデータ項目を均等に分散することに由来しています。

項目のソートキーは、範囲属性とも呼ばれます。「範囲属性」という用語は、ソートキー値で並べ替えられた順に、DynamoDB が同じパーティションキーを持つ項目どうしを物理的に近くに保存する方法に由来しています。

必須: はい

型: 文字列

許可される値: HASH | RANGE

アップデートに関する要件: 中断はありません

以下の資料も参照してください。

宣言されたキースキーマの例については、「AWS::DynamoDB::Table」を参照してください。