https://github.com/tsapporg/ts-app-aws-infra

https://github.com/tsapporg/ts-app-aws-infra

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/tsapporg/ts-app-aws-infra
• Owner: tsapporg
• License: mit
• Created: 2023-04-16T18:41:06.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-24T23:06:02.000Z (over 2 years ago)
• Last Synced: 2025-02-27T17:35:38.351Z (over 1 year ago)
• Language: TypeScript
• Size: 51.1 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

          
# ts-app-aws-infra

This package is responsible for provided AWS-specific infra software. Currently all that's in here is (yet another) Local Dynamo provider, but this one runs _without_ Docker, is typed, and uses the latest AWS SDK V3 DynamoDB client.

This source code is experimental and therefore unpublished on NPM; install directly from Github. 

## Pre-reqs

1. Java - Definitely > v11 (v11 did not work w/ latest Local Dynamo, but v17 did)

## Usage

To use Local Dynamo:

    import { LocalDynamoDB } from 'ts-app-aws-infra';

    import { CreateTableCommandInput, GetItemCommand, PutItemCommand } from '@aws-sdk/client-dynamodb';

    const createTable = (TableName: string): CreateTableCommandInput => {

      return {

        TableName,

        KeySchema: [{ AttributeName: 'id', KeyType: 'HASH' }],

        AttributeDefinitions: [{ AttributeName: 'id', AttributeType: 'S' }],

        ProvisionedThroughput: {

          ReadCapacityUnits: 5,

          WriteCapacityUnits: 5

        },

        StreamSpecification: {

          StreamEnabled: true,

          StreamViewType: 'NEW_AND_OLD_IMAGES'

        }

      };

    }

    const localDynamoDBInfra = await LocalDynamoDB.setup(4567, [createTable('table-name')]);

    const localDynamoDBClient = localDynamoDBInfra.getLocalDynamoDBClient();

    const putItemCommand = new PutItemCommand({

      TableName: 'table-name', Item: { id: { S: 'id' }, key: { S: 'value' } }

    });

    console.debug('put item', putItemCommand);

    await localDynamoDBClient.send(putItemCommand);

    await localDynamoDBInfra.teardown();

## Test

    make tests