Skip to main content

DynamoStoreParameters

@webda/aws

Class: DynamoStoreParameters

Defined in: aws/src/services/dynamodb.service.ts:55

Define DynamoDB parameters

Extends​

  • StoreParameters

Implements​

Constructors​

Constructor​

new DynamoStoreParameters(): DynamoStoreParameters

Returns​

DynamoStoreParameters

Inherited from​

StoreParameters.constructor

Properties​

CloudFormation?​

optional CloudFormation?: any

Defined in: aws/src/services/dynamodb.service.ts:87

CloudFormation customization

CloudFormationSkip?​

optional CloudFormationSkip?: boolean

Defined in: aws/src/services/dynamodb.service.ts:91

Skip CloudFormation on deploy

credentials?​

optional credentials?: object

Defined in: aws/src/services/dynamodb.service.ts:63

Static credentials, default to the AWS environment variables

accessKeyId​

accessKeyId: string

secretAccessKey​

secretAccessKey: string

sessionToken?​

optional sessionToken?: string

Implementation of​

AWSServiceParameters.credentials

defaultModel?​

optional defaultModel?: boolean

Defined in: core/lib/stores/store.d.ts:218

When __type model not found, use the model If strict is setup this parameter is not used

Default​

true

Inherited from​

StoreParameters.defaultModel

endpoint?​

optional endpoint?: string

Defined in: aws/src/services/dynamodb.service.ts:59

Custom endpoint (localstack, minio, ...)

Implementation of​

AWSServiceParameters.endpoint

forceModel?​

optional forceModel?: boolean

Defined in: core/lib/stores/store.d.ts:224

If set, Store will ignore the __type

Default​

false

Inherited from​

StoreParameters.forceModel

globalIndexes?​

optional globalIndexes?: DynamoGlobalIndexes

Defined in: aws/src/services/dynamodb.service.ts:83

Additional global indexes

modelAliases?​

optional modelAliases?: object

Defined in: core/lib/stores/store.d.ts:234

Model Aliases to allow easier rename of Model

Index Signature​

[key: string]: string

Inherited from​

StoreParameters.modelAliases

models?​

optional models?: string[]

Defined in: core/lib/stores/store.d.ts:202

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

Inherited from​

StoreParameters.models

noCache?​

optional noCache?: boolean

Defined in: core/lib/stores/store.d.ts:240

Disable default memory cache

Inherited from​

StoreParameters.noCache

region?​

optional region?: string

Defined in: aws/src/services/dynamodb.service.ts:68

AWS region

Default​

"us-east-1"

Implementation of​

AWSServiceParameters.region

scanPage?​

optional scanPage?: number

Defined in: aws/src/services/dynamodb.service.ts:95

Number of items to retrieve per scan page

slowQueryThreshold​

slowQueryThreshold: number

Defined in: core/lib/stores/store.d.ts:230

Slow query threshold

Default​

30000

Inherited from​

StoreParameters.slowQueryThreshold

strict?​

optional strict?: boolean

Defined in: core/lib/stores/store.d.ts:211

Allow to load object that does not have the type data

If set to true, then the Store will only managed the defined _model and no model extending this one

Default​

false

Inherited from​

StoreParameters.strict

table​

table: string

Defined in: aws/src/services/dynamodb.service.ts:73

Table name

tables?​

optional tables?: object

Defined in: aws/src/services/dynamodb.service.ts:79

Per-model table name overrides, keyed by model identifier

Models not listed use table

Index Signature​

[modelIdentifier: string]: string

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

StoreParameters.type

Methods​

load()​

load(params?): this

Defined in: aws/src/services/dynamodb.service.ts:102

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

StoreParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

StoreParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

StoreParameters.with