DynamoDBDocument client instance. Must be declared before configuring the model.
Regular expression to use when checking if the hash
key has the tenant
prefixed.
The name of the hash
key.
The type of the hash
key.
The name of the index to use when running an index
operation. By default
if will be called byGSIK
. If the index is not created before hand, and
the model is configured with a tenant
, then the method will fail.
The maximum GSIK values to use to index the models. This is necessary when
configuring a tenant
, since you can't configure an IAM policy to restrict
access to an item with a prefix on its hash ID. So, a GSIK will be
configured on every item by the library, using the tenant
value plus a
number between 0
and maxGSIK
. Then you can create an IAM policy that
restrict access on the index (called by defaylt byGSIK
) with access only
on the items with the appropiate GSIK value.
The name of the range
key.
The type of the range
key.
Struct instance created from the struct
data passed through the model
configuration.
The table name. If not provided it will try to use the table
name
globally configured.
The tenant
unique identifier.
Value used to track the dates where modifications were done to the item.
Generated using TypeDoc
Abstract class used to bootstrap a new Model.
Model
{IModel}