Keep all properties names convenient

fourTheorem · Feb 22, 2023 · a033267 · a033267
1 parent a6bc083
commit a033267
Show file tree

Hide file tree

Showing 14 changed files with 122 additions and 128 deletions.
diff --git a/cf-macro/index.ts b/cf-macro/index.ts
@@ -3,7 +3,7 @@
 import _ from 'lodash'
 import Ajv from 'ajv'
 
-import alarms from '../core/alarms/alarms'
+import alarms from 'slic-watch-core/alarms/alarms'
 import dashboard from 'slic-watch-core/dashboards/dashboard'
 import CloudFormationTemplate from 'slic-watch-core/cf-template'
 import defaultConfig from 'slic-watch-core/inputs/default-config'

diff --git a/core/alarms/alb-target-group.ts b/core/alarms/alb-target-group.ts
@@ -16,8 +16,8 @@ export type AlbTargetAlarmProperties = AlarmProperties & {
 }
 
 export type AlbTargetAlarm = AlarmProperties & {
-  targetGroupResourceName: string
-  loadBalancerLogicalId: string 
+  TargetGroupResourceName: string
+  LoadBalancerLogicalId: string 
 } 
 
 /**
@@ -38,12 +38,9 @@ export function findLoadBalancersForTargetGroup (targetGroupLogicalId: string, c
 
   // First, find Listeners with _default actions_ referencing the target group
   for (const listener of Object.values(listenerResources)) {
-    // @ts-ignore
     for (const action of listener.Properties.DefaultActions || []) {
       const targetGroupArn = action?.TargetGroupArn
-      // @ts-ignore
       if (targetGroupArn?.Ref === targetGroupLogicalId) {
-        // @ts-ignore
         const loadBalancerLogicalId = listener.Properties.LoadBalancerArn?.Ref
         if (loadBalancerLogicalId) {
           allLoadBalancerLogicalIds.add(loadBalancerLogicalId)
@@ -57,10 +54,8 @@ export function findLoadBalancersForTargetGroup (targetGroupLogicalId: string, c
 
   // Second, find ListenerRules with actions referncing the target group, then follow to the rules' listeners
   for (const [listenerRuleLogicalId, listenerRule ] of Object.entries(listenerRuleResources)) {
-    // @ts-ignore
     for (const action of listenerRule.Properties.Actions || []) {
       const targetGroupArn = action.TargetGroupArn
-      // @ts-ignore
       if (targetGroupArn.Ref === targetGroupLogicalId) {
         allListenerRules[listenerRuleLogicalId] = listenerRule
         break
@@ -159,8 +154,8 @@ export default function ALBTargetAlarms (albTargetAlarmProperties: AlbTargetAlar
     const albTargetAlarmProperties: AlbTargetAlarm = {
       AlarmName: `LoadBalancerHTTPCodeTarget5XXCountAlarm_${targetGroupResourceName}`,
       AlarmDescription:  `LoadBalancer HTTP Code Target 5XX Count ${getStatisticName(config)} for ${targetGroupResourceName} breaches ${threshold}`,
-      targetGroupResourceName,
-      loadBalancerLogicalId,
+      TargetGroupResourceName: targetGroupResourceName,
+      LoadBalancerLogicalId:loadBalancerLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'HTTPCode_Target_5XX_Count',
@@ -186,8 +181,8 @@ export default function ALBTargetAlarms (albTargetAlarmProperties: AlbTargetAlar
     const albTargetAlarmProperties: AlbTargetAlarm = {
       AlarmName: `LoadBalancerUnHealthyHostCountAlarm_${targetGroupResourceName}`,
       AlarmDescription:  `LoadBalancer UnHealthy Host Count ${getStatisticName(config)} for ${targetGroupResourceName} breaches ${threshold}`,
-      targetGroupResourceName,
-      loadBalancerLogicalId,
+      TargetGroupResourceName: targetGroupResourceName,
+      LoadBalancerLogicalId:loadBalancerLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'UnHealthyHostCount',
@@ -213,8 +208,8 @@ export default function ALBTargetAlarms (albTargetAlarmProperties: AlbTargetAlar
     const albTargetAlarmProperties: AlbTargetAlarm = {
       AlarmName: `LoadBalancerLambdaInternalErrorAlarm_${targetGroupResourceName}`,
       AlarmDescription: `LoadBalancer Lambda Internal Error ${getStatisticName(config)} for ${targetGroupResourceName} breaches ${threshold}`,
-      targetGroupResourceName,
-      loadBalancerLogicalId,
+      TargetGroupResourceName: targetGroupResourceName,
+      LoadBalancerLogicalId:loadBalancerLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'LambdaInternalError',
@@ -240,8 +235,8 @@ export default function ALBTargetAlarms (albTargetAlarmProperties: AlbTargetAlar
     const albTargetAlarmProperties: AlbTargetAlarm = {
       AlarmName: `LoadBalancerLambdaUserErrorAlarm_${targetGroupResourceName}`,
       AlarmDescription:  `LoadBalancer Lambda User Error ${getStatisticName(config)} for ${targetGroupResourceName} breaches ${threshold}`,
-      targetGroupResourceName,
-      loadBalancerLogicalId,
+      TargetGroupResourceName: targetGroupResourceName,
+      LoadBalancerLogicalId:loadBalancerLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'LambdaUserError',

diff --git a/core/alarms/alb.ts b/core/alarms/alb.ts
@@ -13,7 +13,7 @@ export type AlbAlarmProperties = AlarmProperties & {
 }
 
 export type AlbAlarm = AlarmProperties & {
-  loadBalancerResourceName: string
+  LoadBalancerResourceName: string
 } 
 
 
@@ -62,7 +62,7 @@ export default function ALBAlarms (albAlarmProperties: AlbAlarmProperties, conte
     const albAlarmProperties:AlbAlarm = {
       AlarmName:`LoadBalancerHTTPCodeELB5XXCountAlarm_${loadBalancerResourceName}` ,
       AlarmDescription: `LoadBalancer HTTP Code ELB 5XX Count ${getStatisticName(config)} for ${loadBalancerResourceName} breaches ${threshold}`,
-      loadBalancerResourceName, 
+      LoadBalancerResourceName: loadBalancerResourceName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'HTTPCode_ELB_5XX_Count',
@@ -87,7 +87,7 @@ export default function ALBAlarms (albAlarmProperties: AlbAlarmProperties, conte
     const albAlarmProperties: AlbAlarm = {
       AlarmName:`LoadBalancerRejectedConnectionCountAlarm_${loadBalancerResourceName}` ,
       AlarmDescription: `LoadBalancer Rejected Connection Count ${getStatisticName(config)} for ${loadBalancerResourceName} breaches ${threshold}`,
-      loadBalancerResourceName, 
+      LoadBalancerResourceName: loadBalancerResourceName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'RejectedConnectionCount',

diff --git a/core/alarms/api-gateway.ts b/core/alarms/api-gateway.ts
@@ -14,7 +14,7 @@ export type ApiGwAlarmProperties = AlarmProperties &{
 }
 
 export type ApiAlarm= AlarmProperties & {
-  apiName: string
+  ApiName: string
 }
 
 /**
@@ -126,7 +126,7 @@ export default function ApiGatewayAlarms (apiGwAlarmProperties: ApiGwAlarmProper
     const apiAlarmProperties:ApiAlarm = {
       AlarmName: `APIGW_5XXError_${apiNameForSub}` ,
       AlarmDescription: `API Gateway 5XXError ${getStatisticName(config)} for ${apiNameForSub} breaches ${threshold}`,
-      apiName, 
+      ApiName: apiName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: '5XXError',
@@ -151,7 +151,7 @@ export default function ApiGatewayAlarms (apiGwAlarmProperties: ApiGwAlarmProper
     const apiAlarmProperties:ApiAlarm = {
       AlarmName: `APIGW_4XXError_${apiNameForSub}` ,
       AlarmDescription: `API Gateway 4XXError ${getStatisticName(config)} for ${apiNameForSub} breaches ${threshold}`,
-      apiName, 
+      ApiName: apiName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: '4XXError',
@@ -176,7 +176,7 @@ export default function ApiGatewayAlarms (apiGwAlarmProperties: ApiGwAlarmProper
     const apiAlarmProperties:ApiAlarm = {
       AlarmName: `APIGW_Latency_${apiNameForSub}` ,
       AlarmDescription: `API Gateway Latency ${getStatisticName(config)} for ${apiNameForSub} breaches ${threshold}`,
-      apiName, 
+      ApiName: apiName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'Latency',

diff --git a/core/alarms/appsync.ts b/core/alarms/appsync.ts
@@ -14,7 +14,7 @@ export type AppSyncAlarmProperties = AlarmProperties & {
 }
 
 export type AppSyncAlarm= AlarmProperties & {
-  appSyncResourceName: string 
+  AppSyncResourceName: string 
 }
 
 /**
@@ -65,7 +65,7 @@ export default function appSyncAlarms (appSyncAlarmProperties: AppSyncAlarmPrope
     const appSyncAlarmProperties:AppSyncAlarm = {
       AlarmName:`AppSync5XXErrorAlarm_${graphQLName}` ,
       AlarmDescription: `AppSync 5XX Error ${getStatisticName(config)} for ${graphQLName} breaches ${threshold}`,
-      appSyncResourceName, 
+      AppSyncResourceName:appSyncResourceName , 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: '5XXError',
@@ -80,7 +80,6 @@ export default function appSyncAlarms (appSyncAlarmProperties: AppSyncAlarmPrope
       ]
     }
     return {
-      // @ts-ignore
       resourceName: makeResourceName('AppSync', graphQLName, '5XXError'),
       resource: createAlarm(appSyncAlarmProperties, context)
     }
@@ -92,7 +91,7 @@ export default function appSyncAlarms (appSyncAlarmProperties: AppSyncAlarmPrope
     const appSyncAlarmProperties:AppSyncAlarm = {
       AlarmName:`AppSyncLatencyAlarm_${graphQLName}` ,
       AlarmDescription: `AppSync Latency ${getStatisticName(config)} for ${graphQLName} breaches ${threshold}`,
-      appSyncResourceName, 
+      AppSyncResourceName: appSyncResourceName, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'Latency',
@@ -107,7 +106,6 @@ export default function appSyncAlarms (appSyncAlarmProperties: AppSyncAlarmPrope
       ]
     }
     return {
-      // @ts-ignore
       resourceName: makeResourceName('AppSync', graphQLName, 'Latency'),
       resource: createAlarm(appSyncAlarmProperties, context)
     }

diff --git a/core/alarms/ecs.ts b/core/alarms/ecs.ts
@@ -11,8 +11,8 @@ export type EcsAlarmsConfig = AlarmProperties & {
 }
 
 export type EcsAlarm = AlarmProperties & {
-  serviceName,
-  clusterName: string
+  ServiceName: string,
+  ClusterName: string
 }
 
 /**
@@ -85,8 +85,8 @@ export default function ecsAlarms (ecsAlarmsConfig: EcsAlarmsConfig, context: Co
     const ecsAlarmProperties: EcsAlarm = {
       AlarmName: `ECS_MemoryAlarm_\${${logicalId}.Name}`,
       AlarmDescription: `ECS memory utilization for ${logicalId}.Name breaches ${threshold}`,
-      serviceName:  { 'Fn::GetAtt': [logicalId, 'Name'] },
-      clusterName,  
+      ServiceName: `\${${logicalId}.Name}`,
+      ClusterName:clusterName,  
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'MemoryUtilization',
@@ -112,8 +112,8 @@ export default function ecsAlarms (ecsAlarmsConfig: EcsAlarmsConfig, context: Co
     const ecsAlarmProperties: EcsAlarm = {
       AlarmName: `ECS_CPUAlarm_\${${logicalId}.Name}`,
       AlarmDescription:  `ECS CPU utilization for ${logicalId}.Name breaches ${threshold}`,
-      serviceName:  { 'Fn::GetAtt': [logicalId, 'Name'] },
-      clusterName,  
+      ServiceName:  `\${${logicalId}.Name}`,
+      ClusterName: clusterName,  
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'CPUUtilization',

diff --git a/core/alarms/eventbridge.ts b/core/alarms/eventbridge.ts
@@ -11,7 +11,7 @@ export type EventsAlarmsConfig = AlarmProperties &{
 }
 
 export type EventbridgeAlarm = AlarmProperties & {
-  ruleName: object 
+  RuleName: string 
 }
 
 /**
@@ -59,7 +59,7 @@ export default function eventsAlarms (eventsAlarmsConfig: EventsAlarmsConfig, co
     const eventbridgeAlarmProperties:EventbridgeAlarm = {
       AlarmName: `Events_FailedInvocationsAlarm_\${${logicalId}}` ,
       AlarmDescription: `EventBridge Failed Invocations for \${${logicalId}} breaches ${threshold}`,
-      ruleName: { Ref: logicalId }, 
+      RuleName: logicalId , 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'FailedInvocations',
@@ -82,7 +82,7 @@ export default function eventsAlarms (eventsAlarmsConfig: EventsAlarmsConfig, co
     const eventbridgeAlarmProperties:EventbridgeAlarm = {
       AlarmName: `Events_ThrottledRulesAlarm_\${${logicalId}}`,
       AlarmDescription: `EventBridge Throttled Rules for \${${logicalId}} breaches ${threshold}`,
-      ruleName: { Ref: logicalId }, 
+      RuleName: logicalId, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'ThrottledRules',

diff --git a/core/alarms/lambda.ts b/core/alarms/lambda.ts
@@ -16,7 +16,7 @@ export type LambdaFunctionAlarmPropertiess = AlarmProperties & {
 }
 
 export type LambdaAlarm = AlarmProperties & {
-  funcName: object
+  FuncName: string
 } 
 /**
  * functionAlarmPropertiess The cascaded Lambda alarm configuration with
@@ -123,7 +123,7 @@ export default function LambdaAlarms (functionAlarmPropertiess: FunctionAlarmPro
     const lambdaAlarmProperties: LambdaAlarm = {
       AlarmName: `Lambda_IteratorAge_\${${funcLogicalId}}`,
       AlarmDescription:  `Iterator Age for ${funcLogicalId} breaches ${threshold}`,
-      funcName: { Ref: funcLogicalId },
+      FuncName: funcLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: threshold,
       Metrics: null,
@@ -147,7 +147,7 @@ export default function LambdaAlarms (functionAlarmPropertiess: FunctionAlarmPro
     const lambdaAlarmProperties: LambdaAlarm = {
       AlarmName: `Lambda_Errors_\${${funcLogicalId}}`,
       AlarmDescription: `Error count for \${${funcLogicalId}} breaches ${threshold}`,
-      funcName: { Ref: funcLogicalId },
+      FuncName: `\${${funcLogicalId}}`,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: threshold,
       Metrics: null,
@@ -207,7 +207,7 @@ export default function LambdaAlarms (functionAlarmPropertiess: FunctionAlarmPro
     const lambdaAlarmProperties: LambdaAlarm = {
       AlarmName:  `Lambda_Throttles_\${${funcLogicalId}}` ,
       AlarmDescription:  `Throttles % for \${${funcLogicalId}} breaches ${threshold}`,
-      funcName: { Ref: funcLogicalId },
+      FuncName: `\${${funcLogicalId}}`,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: threshold,
       Metrics: metrics, 
@@ -227,7 +227,7 @@ export default function LambdaAlarms (functionAlarmPropertiess: FunctionAlarmPro
     const lambdaAlarmProperties: LambdaAlarm = {
       AlarmName:  `Lambda_Duration_\${${funcLogicalId}}`,
       AlarmDescription:  `Max duration for \${${funcLogicalId}} breaches ${threshold}% of timeout (${funcTimeout})`,
-      funcName: { Ref: funcLogicalId },
+      FuncName: funcLogicalId,
       ComparisonOperator: config.ComparisonOperator,
       // @ts-ignore
       Threshold:  (threshold * funcTimeout * 1000) / 100,
@@ -252,7 +252,7 @@ export default function LambdaAlarms (functionAlarmPropertiess: FunctionAlarmPro
     const lambdaAlarmProperties: LambdaAlarm = {
       AlarmName: `Lambda_Invocations_\${${funcLogicalId}}`,
       AlarmDescription: `Total invocations for \${${funcLogicalId}} breaches ${threshold}`,
-      funcName: { Ref: funcLogicalId },
+      FuncName: `\${${funcLogicalId}}`,
       ComparisonOperator: config.ComparisonOperator,
       Threshold: threshold,
       Metrics: null,

diff --git a/core/alarms/sns.ts b/core/alarms/sns.ts
@@ -11,7 +11,7 @@ export type SnsAlarmsConfig = AlarmProperties & {
 }
 
 export type SnsAlarm= AlarmProperties & {
-  topicName: string
+  TopicName: string
 }
 
 /**
@@ -59,7 +59,7 @@ export default function snsAlarms (snsAlarmsConfig: SnsAlarmsConfig, context: Co
     const snsAlarmProperties: SnsAlarm = {
       AlarmName:  `SNS_NumberOfNotificationsFilteredOutInvalidAttributesAlarm_\${${topicLogicalId}.TopicName}`,
       AlarmDescription: `Number of SNS Notifications Filtered out Invalid Attributes for \${${topicLogicalId}.TopicName} breaches (${threshold}`,
-      topicName: `\${${topicLogicalId}.TopicName}`,  
+      TopicName: `\${${topicLogicalId}.TopicName}`,  
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'NumberOfNotificationsFilteredOut-InvalidAttributes',
@@ -82,7 +82,7 @@ export default function snsAlarms (snsAlarmsConfig: SnsAlarmsConfig, context: Co
     const snsAlarmProperties: SnsAlarm = {
       AlarmName: `SNS_NumberOfNotificationsFailedAlarm_\${${topicLogicalId}.TopicName}`,
       AlarmDescription: `Number of Notifications failed for \${${topicLogicalId}.TopicName} breaches (${threshold}`,
-      topicName: `\${${topicLogicalId}.TopicName}`, 
+      TopicName: `\${${topicLogicalId}.TopicName}`, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'NumberOfNotificationsFailed',

diff --git a/core/alarms/sqs.ts b/core/alarms/sqs.ts
@@ -11,7 +11,7 @@ export type SqsAlarmsConfig = AlarmProperties& {
 }
 
 export type SqsAlarm= AlarmProperties & {
-  queueName: object
+  QueueName: string
 }
 
 /**
@@ -74,7 +74,7 @@ export default function sqsAlarms (sqsAlarmsConfig: SqsAlarmsConfig, context: Co
     const sqsAlarmProperties: SqsAlarm = {
       AlarmName: `SQS_ApproximateNumberOfMessagesNotVisible_\${${logicalId}.QueueName}`,
       AlarmDescription: `SQS in-flight messages for \${${logicalId}.QueueName} breaches ${thresholdValue} (${threshold}% of the hard limit of ${hardLimit})`,
-      queueName: { 'Fn::GetAtt': [logicalId, 'QueueName'] }, 
+      QueueName: `\${${logicalId}.QueueName}`, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: thresholdValue,
       MetricName: 'ApproximateNumberOfMessagesNotVisible',
@@ -97,7 +97,7 @@ export default function sqsAlarms (sqsAlarmsConfig: SqsAlarmsConfig, context: Co
     const sqsAlarmProperties: SqsAlarm = {
       AlarmName: `SQS_ApproximateAgeOfOldestMessage_\${${logicalId}.QueueName}`,
       AlarmDescription: `SQS age of oldest message in the queue \${${logicalId}.QueueName} breaches ${threshold}`,
-      queueName: { 'Fn::GetAtt': [logicalId, 'QueueName'] }, 
+      QueueName: `\${${logicalId}.QueueName}`, 
       ComparisonOperator: config.ComparisonOperator,
       Threshold: config.Threshold,
       MetricName: 'ApproximateAgeOfOldestMessage',

diff --git a/core/alarms/step-functions.ts b/core/alarms/step-functions.ts
@@ -10,7 +10,7 @@ export type SfAlarmsConfig = AlarmProperties& {
 }
 
 export type SmAlarm= AlarmProperties & {
-  stateMachineArn: object 
+  StateMachineArn: string 
 }
 
 /**
@@ -45,7 +45,7 @@ export default function StatesAlarms (sfAlarmProperties: SfAlarmsConfig, context
           const smAlarmProperties: SmAlarm = {
             AlarmName: `StepFunctions_${metric}_\${${logicalId}.Name}` ,
             AlarmDescription: `StepFunctions_${metric} ${config.Statistic} for \${${logicalId}.Name}  breaches ${config.Threshold}`,
-            stateMachineArn: { Ref: logicalId }, 
+            StateMachineArn:  `\${${logicalId}}`, 
             ComparisonOperator: config.ComparisonOperator,
             Threshold: config.Threshold,
             MetricName: metric,