Package software.amazon.awssdk.enhanced.dynamodb.mapper.annotations

Annotation Type DynamoDbSecondaryPartitionKey

@SdkPublicApi @Target(METHOD) @Retention(RUNTIME) @Repeatable(DynamoDbSecondaryPartitionKeys.class) public @interface DynamoDbSecondaryPartitionKey
Denotes a partition key for a global secondary index.

You must also specify at least one index name.

The index name will be used if a table is created from this bean. For data-oriented operations like reads and writes, this name does not need to match the service-side name of the index.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    indexNames
    The names of one or more global secondary indices that this partition key should participate in.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Order
    order
    The order of this partition key attribute in composite keys (0-3).

  • Element Details

    • indexNames

      String[] indexNames
      The names of one or more global secondary indices that this partition key should participate in.

    • order

      Order order
      The order of this partition key attribute in composite keys (0-3). Required when multiple partition keys are defined.
      Default:
      UNSPECIFIED