@digitraffic/common v2024.5.13-1

Digitraffic-common

This is a place for common utilities and classes that can be used in other cdk-projects.

How to build

Use pnpm to build the code i.e.

pnpm install
pnpm build
pnpm test

How to use

In package.json dependencies:

  "dependencies": {
    "@digitraffic/common": "*",
  }

In code:

import {DigitrafficStack, StackConfiguration} from "@digitraffic/common/dist/aws/infra/stack/stack";

DigitrafficStack

If you extend your stack from DigitrafficStack you get many benefits:

• Secret, VPC, Sg & alarmTopics automatically
• Stack validation with StackCheckingAspect
• Easier configuration with StackConfiguration

If you do not need those things, you should not use DigitrafficStack.

StackConfiguration

Some commonly used parameters is predefined configuration. You can write configuration for your environments once and use across cdk-projects.

StackCheckingAspect

Uses cdk aspects to do some sanity checking for your cdk stack:

• Stack naming check(Test/Prod in name)
• Function configuration(memory, timeout, runtime, reservedConcurrency)
• Tags, must have Solution tag defined
• S3 Buckets, no public access
• Api Gateway resource casing(kebabCase and snake_case)
• Queue encrypting
• LogGroup Retention

You can use StackCheckingAspect for any stack, DigitrafficStack does it automatically, but you can call it manually:

Aspects.of(this).add(StackCheckingAspect.create(this));

Any resource can be whitelisted by giving it as a parameter or in the StackConfiguration

MonitoredFunction

MonitoredFunction extends Function with alarms on memory usage and timeouts.

If you need database access in your Function, you can use MonitoredDBFunction. Creating a Function with it is this easy:

const lambda = MonitoredDBFunction.create(stack, 'get-metadata');

See the documentation for more information.