dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.items/KeyAttrSpec

KeyAttrSpec

interface KeyAttrSpec<K>

Defines the specification for a single key attribute, including its name and type

Type Parameters

K

The Kotlin type of the attribute

Types

object Companion

Properties

abstract val name: String

The DynamoDB name of the key attribute

abstract val type: ScalarAttributeType

The DynamoDB type of the attribute

Functions

fromFieldInItem

abstract fun fromFieldInItem(item: Item): K

Extracts a key value from the DynamoDB Item attribute keyed by name

abstract fun toField(value: K): Pair<String, AttributeValue>

Creates a DynamoDB key-value pair for an attribute as a Pair<String, AttributeValue>, suitable for use in an Item instance.