Den Dribbles

Creating and using AWS Secrets from the CDK and CLI

August 15, 2020

Secrets such as environment variables are a must when working with applications using tools such as the CDK. When generating our CloudFormation templates, the last thing you want is to have environment variables leaking through your Git history.

This short overview will create/retrieve a secret from the AWS Secrets Manager and show how you can then require it within a CDK stack.

The secrets manager from the CLI

Ensure that you have the aws-cli installed.

We’re going to add values for example/secretKey and example/secretToken. For us to reference later in the example CDK usage.

Creating our first example two secrets:

aws secretsmanager create-secret --name example/secretKey
          --description "Example Secret Key" --secret-string "super-secret-key"
aws secretsmanager create-secret --name example/secretToken
          --description "Example Secret Token" --secret-string "super-secret-token"

The response from each will give you an ARN value - make sure you note these down.

If you do not note it down, you can always refetch the secret using describe-secret from the CLI:

# Example to get "example/secretKey" info back
aws secretsmanager describe-secret --secret-id example/secretKey

CDK Example

Let’s pretend we’re going to deploy a Lambda function that requires particular environment variables.

This tutorial won’t go into the depths of the AWS CDK, but just know it requires @aws-cdk/aws-secretsmanager to be installed for the secret manager part.

The following code can be updated with the appropriate ARNs that we explored above.

import events = require("@aws-cdk/aws-events")
import targets = require("@aws-cdk/aws-events-targets")
import lambda = require("@aws-cdk/aws-lambda")
import cdk = require("@aws-cdk/core")
import assets = require("@aws-cdk/aws-s3-assets")
import secretsManager = require("@aws-cdk/aws-secretsmanager")

/**
 * Update the LambdaAsset, functions path
 * and handler
 */
export class LambdaCronStack extends cdk.Stack {
  constructor(app: cdk.App, id: string, props: cdk.StackProps) {
    super(app, id)

    // The following JavaScript example defines an directory
    // asset which is archived as a .zip file and uploaded to
    // S3 during deployment.
    // See https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-assets-readme.html
    const myLambdaAsset = new assets.Asset(
      // @ts-ignore - this expects Construct not cdk.Construct :thinking:
      this,
      `ExampleAssetsZip`,
      {
        path: fn.relativeFunctionPath,
      }
    )

    // This creates a lambda function that
    // sets secrets for the Lambda environment variables.
    const lambdaFn = new lambda.Function(this, `ExampleLambdaAssetFn`, {
      code: lambda.Code.fromBucket(
        // @ts-ignore
        myLambdaAsset.bucket,
        myLambdaAsset.s3ObjectKey
      ),
      timeout: cdk.Duration.seconds(300),
      runtime: lambda.Runtime.NODEJS_12_X,
      // Here is the example part
      environment: {
        EXAMPLE_SECRET_KEY: `${
          secretsManager.Secret.fromSecretAttributes(this, "ExampleSecretKey", {
            // replace with actual ARN for the secret key
            secretArn:
              "arn:aws:secretsmanager:<region>:<account-id-number>:secret:<secret-name>-<random-6-characters>",
          }).secretValue
        }`,
        EXAMPLE_SECRET_TOKEN: secretsManager.Secret.fromSecretAttributes(
          this,
          "ExampleSecretToken",
          {
            // replace with actual ARN for the secret token
            secretArn:
              "arn:aws:secretsmanager:<region>:<account-id-number>:secret:<secret-name>-<random-6-characters>",
          }
        ).secretValue,
      },
      handler: "index.handler",
    })
  }
}

Resources and Further Reading

  1. AWS Secrets User Guide
  2. AWS CDK Get Secret example
  3. AWS CDK Docs
  4. AWS CLI

Image credit: Emiel Maters


Related Articles

December 02, 2020

Have you ever wanted to build a UI Component Library with TypeScript and React? This blog post will take you through a straightforward set up that uses the bare minimum to get a working component library that you can re-use across your different React projects.

November 08, 2020

This blog post will explore the new Next.js Image component for an optimised image experience on the web.

November 07, 2020

Learn how to create a test Stripe example, update that example and deploy to Vercel for a Stripe payment gateway, React 17, TypeScript 4 and Next.js 10

November 05, 2020

Learn how to deploy the base Next.js 10 app with the Vercel CLI and/or the Vercel GitHub Integration

November 04, 2020

Learn how to export static HTML from a Nextjs 10 project to host

November 04, 2020

Use the TypeScript AWS CDK to deploy static sites to S3 with a CloudFront distribution and Route53 setup for a custom domain.

October 15, 2020

Using Webpack 5 to build lambdas for AWS deployments

September 30, 2020

A look into how you can run a cron job to self-destruct tweets

September 20, 2020

Using TypeScript to standardise types across the board using JSON Schema

August 18, 2020

Look at how we can work around one of the Service Worker's biggest misunderstanding

A personal blog on all things of interest. Written by Dennis O'Keeffe, Follow me on Twitter