DynamoTableConfig
type DynamoTableConfig = object;Configuration type for creating a DynamoTable.
The table is assumed to have a primary key composed of a partition key named "PK" and
a sort key named "SK" by default, unless overridden in the keyNames property.
Template
Section titled “Template”The Zod schema representing the entity’s structure.
Properties
Section titled “Properties”documentClient
Section titled “documentClient”documentClient: DynamoDBDocumentClient;The DynamoDB Document Client instance to use for operations.
keyNames?
Section titled “keyNames?”optional keyNames: object;Key names object for the table’s primary key and secondary indexes.
globalSecondaryIndexes?
Section titled “globalSecondaryIndexes?”optional globalSecondaryIndexes: NamedGlobalSecondaryIndexKeyNames;localSecondaryIndexes?
Section titled “localSecondaryIndexes?”optional localSecondaryIndexes: NamedLocalSecondaryIndexKeyNames;partitionKey
Section titled “partitionKey”partitionKey: string;sortKey?
Section titled “sortKey?”optional sortKey: string | null;tableName
Section titled “tableName”tableName: string;The name of the DynamoDB table.