Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.GlobalSecondaryIndexProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTable.GlobalSecondaryIndexProperty.Jsii$Proxy
Enclosing class:
CfnTable
@Stability(Stable) public static interface CfnTable.GlobalSecondaryIndexProperty extends software.amazon.jsii.JsiiSerializable
Represents the properties of a global secondary index.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 GlobalSecondaryIndexProperty globalSecondaryIndexProperty = GlobalSecondaryIndexProperty.builder()
         .indexName("indexName")
         .keySchema(List.of(KeySchemaProperty.builder()
                 .attributeName("attributeName")
                 .keyType("keyType")
                 .build()))
         .projection(ProjectionProperty.builder()
                 .nonKeyAttributes(List.of("nonKeyAttributes"))
                 .projectionType("projectionType")
                 .build())
         // the properties below are optional
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 .build())
         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                 .readCapacityUnits(123)
                 .writeCapacityUnits(123)
                 .build())
         .build();

  • Method Details

    • getIndexName

      @Stability(Stable) @NotNull String getIndexName()
      The name of the global secondary index.

      The name must be unique among all other indexes on this table.

    • getKeySchema

      @Stability(Stable) @NotNull Object getKeySchema()
      The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .

      The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

    • getProjection

      @Stability(Stable) @NotNull Object getProjection()
      Represents attributes that are copied (projected) from the table into the global secondary index.

      These are in addition to the primary key attributes and index key attributes, which are automatically projected.

    • getContributorInsightsSpecification

      @Stability(Stable) @Nullable default Object getContributorInsightsSpecification()
      The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index.

    • getProvisionedThroughput

      @Stability(Stable) @Nullable default Object getProvisionedThroughput()
      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide .

    • builder

      @Stability(Stable) static CfnTable.GlobalSecondaryIndexProperty.Builder builder()
      Returns:
      a CfnTable.GlobalSecondaryIndexProperty.Builder of CfnTable.GlobalSecondaryIndexProperty