Table of Contents

Namespace Amazon.DynamoDBv2.DataModel

Classes

AsyncSearch<T>

A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB.

BatchGet

Represents a non-generic object for retrieving a batch of items from a single DynamoDB table

BatchGet<T>

Represents a strongly-typed object for retrieving a batch of items from a single DynamoDB table

BatchWrite

Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table

BatchWrite<T>

Represents a strongly-typed object for writing/deleting a batch of items in a single DynamoDB table

DynamoDBAttribute

Base DynamoDB attribute.

DynamoDBContext

Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc.

DynamoDBContextConfig

Configuration object for setting options on the DynamoDBContext. and individual operations.

DynamoDBGlobalSecondaryIndexHashKeyAttribute
DynamoDBGlobalSecondaryIndexRangeKeyAttribute
DynamoDBHashKeyAttribute

DynamoDB property that marks up current member as a hash key element. Exactly one member in a class must be marked with this attribute.

Members that are marked as hash key must be convertible to a Primitive object.

DynamoDBIgnoreAttribute

DynamoDB attribute that directs the specified attribute not to be included when saving or loading objects.

DynamoDBLocalSecondaryIndexRangeKeyAttribute

DynamoDB property that marks up current member as range key element for a Local Secondary Index on a table.

Members that are marked as a Local Secondary Index range key element must be convertible to a Primitive object.

DynamoDBOperationConfig

Configuration object for setting options for individual operations. This will override any settings specified by the DynamoDBContext's DynamoDBContextConfig object.

DynamoDBPropertyAttribute

DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter.

DynamoDBRangeKeyAttribute

DynamoDB property that marks up current member as range key element (for a hash-and-range primary key). At most one member in a class may be marked with this attribute.

Members that are marked as a range key element must be convertible to a Primitive object.

DynamoDBRenamableAttribute

DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter.

DynamoDBTableAttribute

DynamoDB attribute that marks a class. Specifies that this object can be stored in DynamoDB, the name of the target table, and if attribute names must be automatically converted to lowerCamelCase.

Need not be declared on subclasses if present on base class. Can be defined on subclasses to specify different target table or specify different attribute casing.

DynamoDBVersionAttribute

DynamoDB property that marks up current member as item version. At most one member in a class may be marked with this attribute.

Members that are marked as version must be of primitive, numeric, integer, nullable type (e.g. int?, long?, byte?)

MultiTableBatchGet

Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects

MultiTableBatchWrite

Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects

QueryCondition

Class describing a single query condition

S3Link

S3Link is an object that provides a connection to an S3 resource that can be stored in a DynamoDB field through DynamoDBContext

ScanCondition

Class describing a single scan condition

Interfaces

IDynamoDBContext

Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc.

IPropertyConverter

Interface for converting arbitrary objects to DynamoDB-supported object types.

Implementing type must be public, instantiable, and should have a zero-parameter constructor.