feat!: support adding tags for alarms (#6)

README.md

@@ -35,6 +35,8 @@ custom:
       nameTemplate: $[functionName]-$[metricName]-alarm # Optional - naming template for alarms, can be overwritten in definitions
       prefixTemplate: $[stackName] # Optional - override the alarm name prefix
       suffixTemplate: alarm # Optional - override the alarm name suffix
+      tags:
+        TEAM: my-team
 
     definitions: # these defaults are merged with your definitions
       lambdaErrors:

codecov.yml

@@ -0,0 +1,9 @@
+comment: false
+
+coverage:
+  status:
+    patch: off
+    project:
+      default:
+        only_pulls: true
+        target: auto

src/types.ts

@@ -29,6 +29,7 @@ export interface AlarmDefinition {
   insufficientDataActions?: string[];
   treatMissingData?: string;
   metricFilter?: AlarmMetricFilterDefinition;
+  tags?: Record<string, string | null>;
 }
 
 // Can be string (arn) or object (!Ref/!Sub...) or an array of those

src/utils/alarms.ts

@@ -94,6 +94,15 @@ export function generateCloudFormationResourcesForDefinition(
     TreatMissingData: alarm.treatMissingData,
   };
 
+  if (alarm.tags && Object.keys(alarm.tags).length > 0) {
+    cfAlarmProperties.Tags = Object.entries(alarm.tags)
+      .map(([key, value]) => ({
+        Key: key,
+        Value: value,
+      }))
+      .filter((tag) => !!tag.Value);
+  }
+
   resources[
     awsNaming.getNormalizedResourceName(`${lambdaLogicalId}${awsNaming.normalizeName(alarmDefinitionName)}Alarm`)
   ] = {

src/utils/config.ts

@@ -44,6 +44,7 @@ const alarmDefSchema = z.object({
   insufficientDataActions: z.array(z.string()).optional(),
   treatMissingData: z.optional(z.enum(['missing', 'ignore', 'breaching', 'notBreaching'])),
   metricFilter: z.optional(alarmMetricFilterDefSchema),
+  tags: z.optional(z.record(z.string().min(1).max(128), z.string().min(1).max(256).nullable())),
 }) satisfies z.ZodType<AlarmDefinition>;
 
 const alarmActionSchema = z.union([