MDAA TS Docs
    Preparing search index...

    Configuration for a DynamoDB table including schema, capacity, and TTL settings.

    Use cases: NoSQL table configuration, database schema definition, capacity planning, TTL management

    AWS: Amazon DynamoDB table configuration for NoSQL database deployment

    Validation: partitionKey is required; sortKey, readCapacity, writeCapacity, billingMode, and timeToLiveAttribute are optional

    interface DynamodbProps {
        billingMode?: BillingMode;
        partitionKey: Attribute;
        readCapacity?: number;
        sortKey?: Attribute;
        timeToLiveAttribute?: string;
        writeCapacity?: number;
    }
    Index

    Properties

    billingMode?: BillingMode

    Billing mode controlling the pricing model (PROVISIONED or PAY_PER_REQUEST).

    Use cases: Cost optimization, billing model selection, workload adaptation

    AWS: DynamoDB billing mode

    Validation: Must be PROVISIONED or PAY_PER_REQUEST if provided

    partitionKey: Attribute

    Partition key attribute for the table primary key.

    Use cases: Primary key definition, data distribution, access pattern design

    AWS: DynamoDB partition key attribute

    Validation: Must be a valid Attribute with name and type; required

    readCapacity?: number

    Provisioned read capacity units (reads per second for items up to 4 KB).

    Use cases: Read performance tuning, cost management, capacity planning

    AWS: DynamoDB provisioned read capacity units

    Validation: Must be a positive integer if provided; only applies when billingMode is PROVISIONED

    sortKey?: Attribute

    Optional sort key attribute for composite primary key enabling range queries.

    Use cases: Composite keys, range queries, hierarchical data organization

    AWS: DynamoDB sort key attribute

    Validation: Must be a valid Attribute if provided

    timeToLiveAttribute?: string

    TTL attribute name for automatic item expiration based on a timestamp value.

    Use cases: Data lifecycle management, automatic cleanup, storage cost optimization

    AWS: DynamoDB TTL attribute for automatic item expiration

    Validation: Must be a valid attribute name if provided; attribute value must be a Unix epoch timestamp

    writeCapacity?: number

    Provisioned write capacity units (writes per second for items up to 1 KB).

    Use cases: Write performance tuning, cost management, capacity planning

    AWS: DynamoDB provisioned write capacity units

    Validation: Must be a positive integer if provided; only applies when billingMode is PROVISIONED