Amazon DynamoDB Attributes

Maps a class property to the hash attribute of the table's primary key. The primary key attributes cannot be a collection type.

The following C# code examples maps the Book class to the ProductCatalog table, and the Id property to the table's primary key hash attribute.

[DynamoDBTable("ProductCatalog")] 
   public class Book { 
   [DynamoDBHashKey] 
   public int Id { get; set; }
  
   // Additional properties go here. 
}

DynamoDBIgnore

Indicates DynamoDBContext that the associated property should be ignored. If you don't want to save any of your class properties you can add this attribute to instruct DynamoDBContext not to include this property when saving objects to the table.

Maps a class property to a table attribute. If the class property maps to the same name table attribute, then you don't need to specify this attribute. However, if the names are not the same, you can use this tag to provide the mapping. In the following C# statement the DynamoDBProperty maps the BookAuthors property to the Authors attribute in the table.

[DynamoDBProperty("Authors")]    
public List<string> BookAuthors { get; set; }

DynamoDBContext uses this mapping information to create the Authors attribute when saving object data to the corresponding table.

Maps a class property to the range attribute of the table's primary key. If the table's primary key is made of both the hash and range attributes, you must specify both the DynamoDBHashKey and DynamoDBRangeKey attributes in your class mapping.

For example, the sample table Reply has a primary key made of the Id hash attribute and Replenishment range attribute. The following C# code example maps the Reply class to the Reply table. The class definition also indicates that two of its properties map to the primary key.

For more information about sample tables, see Example Tables and Data in Amazon DynamoDB.

[DynamoDBTable("Reply")] 
public class Reply { 
   [DynamoDBHashKey] 
   public int ThreadId { get; set; }
   [DynamoDBRangeKey]
   public string Replenishment { get; set; }
   // Additional properties go here. 
}

DynamoDBTable

Identifies the target table in Amazon DynamoDB to which the class maps. For example, the following C# code example maps the Developer class to the People table in Amazon DynamoDB.

[DynamoDBTable("People")] 
public class Developer { ...}

This attribute can be inherited or overridden.

You can add the optional parameter, LowerCamelCaseProperties, to request Amazon DynamoDB to lower case the first letter of the property name when storing the objects to a table as shown in the following C# snippet.

[DynamoDBTable("People", LowerCamelCaseProperties=true)] 
public class Developer { 
   string DeveloperName;
   ...}

When saving instances of the Developer class, DynamoDBContext saves the DeveloperName property as the developerName.