feat: adds logLevel option, so users can debug lambda functions (#286)

lambda/index.ts

@@ -41,7 +41,9 @@ import {
   Callback,
   CustomResource,
   Event,
+  LogLevel,
   Logger,
+  StandardLogger,
 } from 'aws-cloudformation-custom-resource';
 import * as forge from 'node-forge';
 import { PublicKeyFormat, ResourceProperties } from './types';
@@ -53,14 +55,22 @@ export const handler = function (
   context: Context,
   callback: Callback,
 ) {
-  new CustomResource<ResourceProperties>(
+  const resource = new CustomResource<ResourceProperties>(
     event,
     context,
     callback,
     createResource,
     updateResource,
     deleteResource,
   );
+  if (event.ResourceProperties.LogLevel) {
+    resource.setLogger(
+      new StandardLogger(
+        // because jsii is forcing us to expose enums with all capitals and the enum in aws-cloudformation-custom-resource is all lowercase, we need to cast here. Other than the capitalization, the enums are identical
+        event.ResourceProperties.LogLevel as unknown as LogLevel,
+      ),
+    );
+  }
 };
 
 async function createResource(

lambda/types.ts

@@ -1,6 +1,15 @@
 // this file is physically present in /lambda, as it is required for build the lambda zip
 // the file is symlinked into /lib, as otherwise jsii is refusing to find it, even when the whole lambda directory is not ignored
 
+export enum LogLevel {
+  /* eslint-disable @typescript-eslint/naming-convention */
+  ERROR,
+  WARN,
+  INFO,
+  DEBUG,
+  /* eslint-enable @typescript-eslint/naming-convention */
+}
+
 export enum PublicKeyFormat {
   /* eslint-disable @typescript-eslint/naming-convention */
   OPENSSH = 'OPENSSH',
@@ -22,5 +31,6 @@ export interface ResourceProperties {
   RemoveKeySecretsAfterDays: number;
   StackName: string;
   Tags: Record<string, string>;
+  LogLevel?: LogLevel;
   /* eslint-enable @typescript-eslint/naming-convention */
 }

lib/index.ts

@@ -16,8 +16,8 @@ import {
 import { IKeyPair, OperatingSystemType } from 'aws-cdk-lib/aws-ec2';
 import { Construct } from 'constructs';
 import * as path from 'path';
-import { PublicKeyFormat, ResourceProperties } from './types';
-export { PublicKeyFormat } from './types';
+import { LogLevel, PublicKeyFormat, ResourceProperties } from './types';
+export { LogLevel, PublicKeyFormat } from './types';
 
 const resourceType = 'Custom::EC2-Key-Pair';
 const ID = `CFN::Resource::${resourceType}`;
@@ -140,6 +140,13 @@ export interface KeyPairProps extends ResourceProps {
    * @default false
    */
   readonly legacyLambdaName?: boolean;
+
+  /**
+   * The log level of the Lambda function
+   *
+   * @default LogLevel.warn
+   */
+  readonly logLevel?: LogLevel;
 }
 
 /**
@@ -249,6 +256,7 @@ export class KeyPair extends Resource implements ITaggable, IKeyPair {
       Tags: Lazy.any({
         produce: () => this.tags.renderTags() as Record<string, string>,
       }) as unknown as Record<string, string>,
+      LogLevel: props.logLevel,
       /* eslint-enable @typescript-eslint/naming-convention */
     };
 

test/lib/test-stack.ts

@@ -8,13 +8,15 @@ import {
 } from 'aws-cdk-lib';
 import cloudfront = require('aws-cdk-lib/aws-cloudfront');
 import { Construct } from 'constructs';
-import { PublicKeyFormat } from '../../lambda/types';
+import { LogLevel, PublicKeyFormat } from '../../lambda/types';
 import { KeyPair } from '../../lib';
 
 interface Props extends StackProps {
   currentUserName: string;
 }
 
+const logLevel = LogLevel.DEBUG;
+
 export class TestStack extends Stack {
   constructor(scope: Construct, id: string, props: Props) {
     super(scope, id, props);
@@ -47,6 +49,7 @@ export class TestStack extends Stack {
       storePublicKey: false,
       exposePublicKey: true,
       publicKey: keyPair.publicKeyValue,
+      logLevel,
     });
 
     if (process.env.with_ec2 === 'true') {
@@ -76,6 +79,7 @@ export class TestStack extends Stack {
       storePublicKey: true,
       publicKeyFormat: PublicKeyFormat.PEM,
       legacyLambdaName: true,
+      logLevel,
     });
 
     const currentUser = aws_iam.User.fromUserName(