Skip to content

kbrashears5/typescript-aws-cloudwatch-helper

Repository files navigation

typescript-aws-cloudwatch-helper

Typescript helper functions for AWS CloudWatch service

CI/CD codecov NPM Version Downloads

Install

npm install typescript-aws-cloudwatch-helper@latest

Usage

Default - running in Lambda in your own account

const logger = new Logger(LogLevel.Trace);

const helper = new CloudWatchHelper(logger);

const response = await helper.PutMetricDataAsync(
  'namespace',
  [] as AWS.CloudWatch.MetricDatum[],
);

Running in separate account or not in Lambda

import * as CloudWatch from '@aws-sdk/client-cloudwatch';

const logger = new Logger(LogLevel.Trace);

const options: CloudWatch.CloudWatchClientConfig = {
  accessKeyId: '{access_key}',
  secretAccessKey: '{secret_key}',
  region: 'us-east-1',
};

const repository = new CloudWatch.CloudWatch(options);

const helper = new CloudWatchHelper(logger, repository);

const response = await helper.PutMetricDataAsync(
  'namespace',
  [] as CloudWatch.MetricDatum[],
);

Notes

If no options are supplied, will default to us-east-1 as the region

Development

Clone the latest and run

npm run prep

to install packages and prep the git hooks