Skip to main content

@webda/awsReadme | API


Class: DynamoStoreParameters

Define DynamoDB parameters

Extends

  • AWSServiceParametersMixin<typeof StoreParameters, this> & StoreParameters<this>

Constructors

new DynamoStoreParameters(params, service)

new DynamoStoreParameters(params, service): DynamoStoreParameters

Parameters

params: any

service: DynamoStore<CoreModel, DynamoStoreParameters>

Returns

DynamoStoreParameters

Overrides

AWSServiceParameters(StoreParameters).constructor

Source

packages/aws/src/services/dynamodb.ts:47

Properties

CloudFormation

CloudFormation: any

CloudFormation customization

Source

packages/aws/src/services/dynamodb.ts:43


CloudFormationSkip

CloudFormationSkip: boolean

Source

packages/aws/src/services/dynamodb.ts:44


additionalModels?

additionalModels?: string[]

Additional models

Allow this store to manage other models

Default

[]

Inherited from

AWSServiceParameters(StoreParameters).additionalModels

Source

packages/core/lib/stores/store.d.ts:388


asyncDelete

asyncDelete: boolean

async delete

Inherited from

AWSServiceParameters(StoreParameters).asyncDelete

Source

packages/core/lib/stores/store.d.ts:392


credentials?

credentials?: Object

Type declaration

accessKeyId

accessKeyId: string

secretAccessKey

secretAccessKey: string

sessionToken?

sessionToken?: string

Inherited from

AWSServiceParameters(StoreParameters).credentials

Source

packages/aws/src/services/aws-mixin.ts:24


defaultModel?

defaultModel?: boolean

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

Default

true

Inherited from

AWSServiceParameters(StoreParameters).defaultModel

Source

packages/core/lib/stores/store.d.ts:414


endpoint?

endpoint?: string

Inherited from

AWSServiceParameters(StoreParameters).endpoint

Source

packages/aws/src/services/aws-mixin.ts:23


expose?

expose?: StoreExposeParameters

Expose the service to an urls

Deprecated

will probably be removed in 4.0 in favor of Expose annotation

Inherited from

AWSServiceParameters(StoreParameters).expose

Source

packages/core/lib/stores/store.d.ts:398


forceModel?

forceModel?: boolean

If set, Store will ignore the __type

Default

false

Inherited from

AWSServiceParameters(StoreParameters).forceModel

Source

packages/core/lib/stores/store.d.ts:420


globalIndexes?

globalIndexes?: Object

Additional global indexes

Index signature

[key: string]: Object

Source

packages/aws/src/services/dynamodb.ts:34


model?

model?: string

Webda model to use within the Store

Default

"Webda/CoreModel"

Inherited from

AWSServiceParameters(StoreParameters).model

Source

packages/core/lib/stores/store.d.ts:380


modelAliases?

modelAliases?: Object

Model Aliases to allow easier rename of Model

Index signature

[key: string]: string

Inherited from

AWSServiceParameters(StoreParameters).modelAliases

Source

packages/core/lib/stores/store.d.ts:430


noCache?

noCache?: boolean

Disable default memory cache

Inherited from

AWSServiceParameters(StoreParameters).noCache

Source

packages/core/lib/stores/store.d.ts:436


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

AWSServiceParameters(StoreParameters).openapi

Source

packages/core/lib/services/service.d.ts:104


region?

region?: string

Inherited from

AWSServiceParameters(StoreParameters).region

Source

packages/aws/src/services/aws-mixin.ts:29


scanPage

scanPage: number

Source

packages/aws/src/services/dynamodb.ts:45


slowQueryThreshold

slowQueryThreshold: number

Slow query threshold

Default

30000

Inherited from

AWSServiceParameters(StoreParameters).slowQueryThreshold

Source

packages/core/lib/stores/store.d.ts:426


strict?

strict?: boolean

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

AWSServiceParameters(StoreParameters).strict

Source

packages/core/lib/stores/store.d.ts:407


table

table: string

Table name

Source

packages/aws/src/services/dynamodb.ts:30


type

type: string

Type of the service

Inherited from

AWSServiceParameters(StoreParameters).type

Source

packages/core/lib/services/service.d.ts:95


url?

url?: string

URL on which to serve the content

Inherited from

AWSServiceParameters(StoreParameters).url

Source

packages/core/lib/services/service.d.ts:99