@godspeedsystems/plugins-dynamodb-as-datasource NP

Godspeed-plugin-dynamodb-as-datasource

Amazon DynamoDB is a fully managed NoSQL database service provided by Amazon Web Services (AWS). It is designed for high-performance applications that require seamless and predictable scalability. DynamoDB is known for its simplicity, low-latency performance, and automatic scaling of throughput capacity to handle varying workloads.

A brief description of how to use the DynamoDB plugin in our Godspeed framework as a data source.

Steps to use DynamoDB plugin in the Godspeed framework:

Add the plugin using CLI. Example usage (listObjects): Update the configuration file based on your requirements in Datasource/dynamo.yaml.

Example usage (listObjects):

Update configuration file based on your requirements in Datasource/dynamo.yaml.

Dynamodb config ( src/datasources/dynamo.yaml )

type: dynamodb
endpoint: <%config.endpoint%>
region: <%config.region%>
accessKeyId: <%config.accessKeyId%>
secretAccessKey: <%config.secretAccessKey%>

Dynamodb event for create a new table ( src/events/dynamodbEvent.yaml )

In the event, we establish HTTP endpoint that accepts json objects in request body. When this endpoint is invoked, it triggers the create workflow. This workflow, in turn, takes the input arguments and performs the task of creating new table to the specified aws dynamodb instance.

# Event to create new table in DynamoDB
http.post./dynamodb:
  summary: Create a new table
  description: Create new table in dynamodb
  fn: create
  body:
    content:
      application/json:
        schema:
          type: object
          properties:
            TableName:
              type: string
            KeySchema:
              type: array
              items:
                type: object
                properties:
                  AttributeName:
                    type: string
                  KeyType:
                    type: string
            AttributeDefinitions:
              type: array
              items:
                type: object
                properties:
                  AttributeName:
                    type: string
                  AttributeType:
                    type: string
            ProvisionedThroughput:
              type: object
              properties:
                ReadCapacityUnits:
                  type: integer
                WriteCapacityUnits:
                  type: integer
            # Add more properties as needed
          required:
            - TableName
            - KeySchema
            - AttributeDefinitions
            - ProvisionedThroughput
  responses:
    '201':
      description: Table created successfully
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string

Dynamodb workflow for create a new table ( src/functions/create.yaml )

In workflow we need to mension datasource.dynamodb.${method} as function (fn) to perform operations in this case datasource.dynamodb.createTable.

summary: Create table
tasks:
  - id: create table in dynamodb
    fn: datasource.dynamo.createTable
    args: <%inputs.body%> # args must carry exact same params as expected by @aws-sdk/client-dynamodb

Plugin Commands (Operations List)

Command API Reference / Input / Output

@aws-sdk/client-dynamodb @godspeedsystems/core pino-pretty

1.0.0

5 months ago