DynamoEntityConfig
type DynamoEntityConfig<Schema> = object;Configuration type for creating a DynamoEntity.
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
The Zod schema representing the entity’s structure.
Properties
Section titled “Properties”globalSecondaryIndexes?
Section titled “globalSecondaryIndexes?”optional globalSecondaryIndexes: GlobalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;Mapping of global secondary index names to their key builders.
localSecondaryIndexes?
Section titled “localSecondaryIndexes?”optional localSecondaryIndexes: LocalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;Mapping of local secondary index names to their key builders.
partitionKey?
Section titled “partitionKey?”optional partitionKey: DynamoKeyBuilder<EntitySchema<Schema>>;Key builder function to build the partition key from an entity item.
schema
Section titled “schema”schema: Schema;The Zod schema defining the entity’s structure.
sortKey?
Section titled “sortKey?”optional sortKey: DynamoKeyBuilder<EntitySchema<Schema>>;Key builder function to build the sort key from an entity item.
table: DynamoTable;The DynamoTable instance associated with the entity.