Annotation Type DynamoDBIndexHashKey


@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface DynamoDBIndexHashKey
Annotation for marking a property in a class as the attribute to be used as the hash key for one or more global secondary indexes on a DynamoDB table. Applied to the getter method or the class field for the index hash key property. If the annotation is applied directly to the class field, the corresponding getter and setter must be declared in the same class.

This annotation is required if this attribute will be used as index key for item queries.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Optional parameter when the name of the attribute as stored in DynamoDB should differ from the name used by the getter / setter.
    Parameter for the name of the global secondary index.
    Parameter for the names of the global secondary indexes.
  • Element Details

    • attributeName

      String attributeName
      Optional parameter when the name of the attribute as stored in DynamoDB should differ from the name used by the getter / setter.
      Default:
      ""
    • globalSecondaryIndexName

      String globalSecondaryIndexName
      Parameter for the name of the global secondary index.

      This is required if this attribute is the index key for only one global secondary index.

      Default:
      ""
    • globalSecondaryIndexNames

      String[] globalSecondaryIndexNames
      Parameter for the names of the global secondary indexes. This is required if this attribute is the index key for multiple global secondary indexes.
      Default:
      {}