Header menu logo FsCDK

LocalSecondaryIndexBuilder Type

Constructors

Constructor Description

LocalSecondaryIndexBuilder(indexName)

Full Usage: LocalSecondaryIndexBuilder(indexName)

Parameters:
    indexName : string

Returns: LocalSecondaryIndexBuilder
indexName : string
Returns: LocalSecondaryIndexBuilder

Instance members

Instance member Description
c1 : LocalSecondaryIndexConfig
c2 : LocalSecondaryIndexConfig
Returns: LocalSecondaryIndexConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: LocalSecondaryIndexConfig
Modifiers: inline
f : unit -> LocalSecondaryIndexConfig
Returns: LocalSecondaryIndexConfig

this.For

Full Usage: this.For

Parameters:
Returns: LocalSecondaryIndexConfig
Modifiers: inline
cfg : LocalSecondaryIndexConfig
f : unit -> LocalSecondaryIndexConfig
Returns: LocalSecondaryIndexConfig

nonKeyAttributes attrs

Full Usage: nonKeyAttributes attrs

Parameters:
    attrs : string list - The list of non-key attribute names to include.

Returns: LocalSecondaryIndexConfig

Specifies additional non-key attributes to include in the LSI projection.

Only used when projectionType is INCLUDE.

attrs : string list

The list of non-key attribute names to include.

Returns: LocalSecondaryIndexConfig

projectionType projType

Full Usage: projectionType projType

Parameters:
    projType : ProjectionType - The projection type (ALL, KEYS_ONLY, or INCLUDE).

Returns: LocalSecondaryIndexConfig

Sets the projection type for the LSI.

projType : ProjectionType

The projection type (ALL, KEYS_ONLY, or INCLUDE).

Returns: LocalSecondaryIndexConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: LocalSecondaryIndexProps
cfg : LocalSecondaryIndexConfig
Returns: LocalSecondaryIndexProps

sortKey attrName attrType

Full Usage: sortKey attrName attrType

Parameters:
    attrName : string - The attribute name for the sort key.
    attrType : AttributeType - The attribute type (STRING, NUMBER, or BINARY).

Returns: LocalSecondaryIndexConfig

Sets the sort key for the Local Secondary Index (LSI).

attrName : string

The attribute name for the sort key.

attrType : AttributeType

The attribute type (STRING, NUMBER, or BINARY).

Returns: LocalSecondaryIndexConfig

sortKey attr

Full Usage: sortKey attr

Parameters:
    attr : Attribute - The attribute definition to use as the sort key.

Returns: LocalSecondaryIndexConfig

Sets the sort key for the Local Secondary Index (LSI).

attr : Attribute

The attribute definition to use as the sort key.

Returns: LocalSecondaryIndexConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: LocalSecondaryIndexConfig
() : unit
Returns: LocalSecondaryIndexConfig

this.Zero

Full Usage: this.Zero

Returns: LocalSecondaryIndexConfig
Returns: LocalSecondaryIndexConfig

Type something to start searching.