dynamodb-mapper-annotations/aws.sdk.kotlin.hll.dynamodbmapper

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbAttribute(val name: String)

Specifies the attribute name for a property in a DynamoDbItem-annotated class/interface. If this annotation is not included then the attribute name matches the property name.

DynamoDbAttributeConverter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbAttributeConverter(val converter: KClass<out ValueConverter<*>>)

Specifies the type of ValueConverter to be used when processing this attribute.

DynamoDbCounter

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbCounter

Specifies that this property should be used as a counter field, incrementing each time an item is persisted to DynamoDB.

DynamoDbIgnore

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbIgnore

Specifies that this property should be ignored during mapping.

DynamoDbItem

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DynamoDbItem(val converter: KClass<out ItemConverter<*>> = AutoGeneratedConverter::class)

Specifies that this class/interface describes an item type in a table. All public properties of this type will be mapped to attributes unless they are explicitly ignored.

DynamoDbMappable

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS])

annotation class DynamoDbMappable(val converter: KClass<out ItemConverter<*>> = AutoGeneratedConverter::class)

Specifies that this class/interface can be mapped to/from a set of DynamoDB attributes (an item). An ItemConverter will be generated for the annotated type, allowing it to be used as a nested attribute within another DynamoDbMappable or DynamoDbItem type. Unlike DynamoDbItem, a type annotated only with DynamoDbMappable does not describe a table item and therefore does not require (or permit) primary key, TTL, or counter annotations.

DynamoDbPartitionKey

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbPartitionKey

Specifies that this property is the primary key for the item. Every top-level DynamoDbItem to be used in a table must have exactly one partition key.

DynamoDbSortKey

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbSortKey

Specifies that this property is the sort key for the item. Every top-level DynamoDbItem to be used in a table may have at most one sort key.

DynamoDbTtlSeconds

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class DynamoDbTtlSeconds(val lifetime: Long)

Specifies that this property is used to track the item's time-to-live (TTL). https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html