Class Datastore

The Datastore construct sets up a DynamoDB single-table design for a serverless project using projen. This construct extends the projen Component to include dependencies and development dependencies required for DynamoDB and provides methods to generate model and construct files based on a schema definition file.

Example

const datastore = new Datastore(app, {
modelName: 'User',
definitionFile: 'src/models/user.schema.json',
});

Hierarchy

  • Component
    • Datastore

Constructors

Properties

node: Node

The tree node.

project: Project

Methods

  • Parameters

    • file: FileBase

    Returns string

  • Parameters

    • file: FileBase

    Returns string

  • Called after synthesis. Order is not guaranteed.

    Returns void

  • Called before synthesis.

    Returns void

  • Parameters

    • model: OneSchema

    Returns string

  • Synthesizes files to the project output directory.

    Returns void

  • Returns a string representation of this construct.

    Returns string

  • Test whether the given construct is a component.

    Parameters

    • x: any

    Returns x is Component

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Generated using TypeDoc