AWS::DynamoDB::Table LocalSecondaryIndex

ローカルセカンダリインデックスのプロパティを表します。ローカルセカンダリインデックスは、親テーブルが作成されたときにのみ作成できます。

構文

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

JSON

{
  "IndexName" : String,
  "KeySchema" : [ KeySchema, ... ],
  "Projection" : Projection
}

YAML

  IndexName: String
  KeySchema: 
    - KeySchema
  Projection: 
    Projection

プロパティ

IndexName

ローカルセカンダリインデックスの名前。名前は、このテーブルの他のすべてのインデックスにおいて一意である必要があります。

必須: はい

タイプ: 文字列

Pattern: [a-zA-Z0-9_.-]+

最小: 3

最大: 255

アップデートに関する要件: アップデートはサポートされていません。

KeySchema

ローカルセカンダリインデックスの完全なキースキーマ (属性名とキーのタイプとから成る 1 つまたは複数のペア):

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

• RANGE - ソートキー

注記

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

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

必須: はい

タイプ: KeySchema の配列

最小: 1

最大: 2

アップデートに関する要件: アップデートはサポートされていません。

Projection

ソーステーブルからローカルセカンダリインデックスにコピー (射影) される属性を表します。自動的に射影されるプライマリキー属性とインデックスキー属性とは別に、これらが追加されます。

必須: はい

Type: Projection

アップデートに関する要件: アップデートはサポートされていません。

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

宣言されたローカルセカンダリインデックスの例については、AWS::DynamoDB::Table」を参照してください。