Aller au contenu
Français

DynamoDbDurableStateStoreOptionsType

Ce contenu n’est pas encore disponible dans votre langue.

Defined in: src/persistence/durable-state-stores/DynamoDbDurableStateStoreOptions.ts:8

  • DynamoDbOptionsBaseType

readonly optional autoCreateTables?: boolean

Defined in: src/persistence/journals/DynamoDbOptionsBase.ts:8

Create the table on first use. Default: true.

DynamoDbOptionsBaseType.autoCreateTables


readonly optional billingMode?: "PAY_PER_REQUEST" | "PROVISIONED"

Defined in: src/persistence/journals/DynamoDbOptionsBase.ts:13

PAY_PER_REQUEST (default) or PROVISIONED. On-demand needs no capacity planning, which suits an event journal’s bursty write pattern.

DynamoDbOptionsBaseType.billingMode


readonly optional clientConfig?: Record<string, unknown>

Defined in: src/persistence/journals/DynamoDbClient.ts:115

Extra DynamoDBClient config, merged over region / endpoint: { credentials, maxAttempts, requestHandler, … }.

DynamoDbOptionsBaseType.clientConfig


readonly optional endpoint?: string

Defined in: src/persistence/journals/DynamoDbClient.ts:110

Override the service endpoint — how you point at dynamodb-local or LocalStack (http://localhost:8000).

DynamoDbOptionsBaseType.endpoint


readonly optional operations?: DynamoDbOperations

Defined in: src/persistence/journals/DynamoDbClient.ts:121

Pre-built operations façade — bypasses the lazy SDK import entirely. Use to share ONE client across the journal, snapshot and durable-state stores (see registerDynamoDbPlugins), or to inject a fake in tests.

DynamoDbOptionsBaseType.operations


readonly optional provisionedThroughput?: object

Defined in: src/persistence/journals/DynamoDbOptionsBase.ts:15

Capacity units — only read when billingMode is PROVISIONED.

readonly readCapacityUnits: number

readonly writeCapacityUnits: number

DynamoDbOptionsBaseType.provisionedThroughput


readonly optional region?: string

Defined in: src/persistence/journals/DynamoDbClient.ts:105

AWS region, e.g. eu-central-1. Falls back to the SDK’s own resolution.

DynamoDbOptionsBaseType.region


readonly optional serializer?: Serializer<unknown>

Defined in: src/persistence/storage/StoreSerializerOptions.ts:23

Custom payload serializer. When set, the store writes rows in the self-describing __serialized__ framing (see PayloadCodec) instead of the default tagged JSON; rows of both formats can coexist in one stream, but reading a framed row back requires a serializer with the same id to be configured.

DynamoDbOptionsBaseType.serializer


readonly optional table?: string

Defined in: src/persistence/durable-state-stores/DynamoDbDurableStateStoreOptions.ts:10

Durable-state table name. Default: actor_ts_durable_state.


readonly optional tableReadyTimeoutMs?: number

Defined in: src/persistence/journals/DynamoDbOptionsBase.ts:20

How long to wait for a new table to become ACTIVE. Default: 30 000 ms.

DynamoDbOptionsBaseType.tableReadyTimeoutMs