AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  System.Attribute
    Amazon.DynamoDBv2.DataModel.DynamoDBAttribute
      Amazon.DynamoDBv2.DataModel.DynamoDBTableAttribute

Namespace: Amazon.DynamoDBv2.DataModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C#
public sealed class DynamoDBTableAttribute : DynamoDBAttribute

The DynamoDBTableAttribute type exposes the following members

Constructors

NameDescription
Public Method DynamoDBTableAttribute(string)

Construct an instance of DynamoDBTableAttribute

Public Method DynamoDBTableAttribute(string, CaseMode)

Construct an instance of DynamoDBTableAttribute with the given attribute casing.

Public Method DynamoDBTableAttribute(string, CaseMode, ConversionSchema)

Construct an instance of DynamoDBTableAttribute with the given attribute casing and conversion schema.

Public Method DynamoDBTableAttribute(string, bool)

Construct an instance of DynamoDBTableAttribute

Public Method DynamoDBTableAttribute(string, bool, ConversionSchema)

Construct an instance of DynamoDBTableAttribute

Properties

NameTypeDescription
Public Property AttributeCasing Amazon.DynamoDBv2.DataModel.CaseMode

Gets and sets how .NET property names are cased when mapped to DynamoDB attribute names. Defaults to Amazon.DynamoDBv2.DataModel.CaseMode.Unset, meaning no casing was specified for this type: it behaves as Amazon.DynamoDBv2.DataModel.CaseMode.PascalCase at the root and, when nested, inherits an enclosing type's casing. The Amazon.DynamoDBv2.DataModel.CaseMode.Unset sentinel is what lets an explicit Amazon.DynamoDBv2.DataModel.CaseMode.PascalCase be distinguished from "not specified" (see remarks).

Public Property Conversion Amazon.DynamoDBv2.ConversionSchema

Gets and sets the Amazon.DynamoDBv2.ConversionSchema used for mapping between .NET and DynamoDB types. The conversion schema determines how types are serialized and deserialized during data persistence. When resolving the effective schema, the following precedence is applied: 1. If set on the operation configuration, it takes the highest precedence. 2. If not set on the operation, but specified at the table level, the table configuration is used. 3. If neither is set, the context-level configuration is used as the default fallback.

Public Property LowerCamelCaseProperties System.Boolean

Gets and sets the LowerCamelCaseProperties property. When true, only the root object's attribute names are camelCased; nested objects keep their PascalCase names.

Public Property TableName System.String

Gets and sets the TableName property.

Public Property TypeId System.Object Inherited from System.Attribute.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer