AWS::DynamoDB::Table GlobalSecondaryIndex

グローバルセカンダリインデックスのプロパティを表します。

構文

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

JSON

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

YAML

  ContributorInsightsSpecification: 
    ContributorInsightsSpecification
  IndexName: String
  KeySchema: 
    - KeySchema
  OnDemandThroughput: 
    OnDemandThroughput
  Projection: 
    Projection
  ProvisionedThroughput: 
    ProvisionedThroughput

プロパティ

ContributorInsightsSpecification

指定されたグローバルセカンダリインデックスの Contributor Insights CloudWatch を有効または無効にするために使用される設定。

必須: いいえ

タイプ : ContributorInsights仕様

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

IndexName

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

必須: はい

タイプ: 文字列

パターン: [a-zA-Z0-9_.-]+

最小: 3

最大: 255

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

KeySchema

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

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

• RANGE - ソートキー

注記

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

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

必須: はい

タイプ : の配列 KeySchema

最小: 1

最大: 2

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

OnDemandThroughput

指定されたグローバルセカンダリインデックスの読み取りおよび書き込みユニットの最大数。このパラメータを使用する場合は、MaxReadRequestUnits、MaxWriteRequestUnits、またはその両方を指定する必要があります。

必須: いいえ

タイプ： OnDemandスループット

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

Projection

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

必須: はい

Type: Projection

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

ProvisionedThroughput

指定されたグローバルセカンダリインデックスのプロビジョニングされたスループット設定を表します。

プロビジョニングされたスループットの現在の最小値と最大値については、「Amazon DynamoDB デベロッパーガイド」の「サービス、アカウント、テーブルのクォータ」を参照してください。

必須: いいえ

タイプ： ProvisionedThroughput

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