fix(aws-elasticache): wrong dimensionsMap key for serverless cluster (#68)

* fix(aws-elasticache): wrong dimensionsMap key for serverless cluster

* update integ test

* update snapshot

* apply lint

Author: sakurai-ryo

src/aws-elasticache/serverless-cache.ts

@@ -298,7 +298,7 @@ abstract class ServerlessCacheBase extends Resource implements IServerlessCache
     return new Metric({
       namespace: 'AWS/ElastiCache',
       dimensionsMap: {
-        CacheClusterId: this.serverlessCacheName,
+        clusterId: this.serverlessCacheName,
       },
       metricName,
       ...props,

test/aws-elasticache/integ.elasticache-serverless-cache.ts

@@ -1,10 +1,13 @@
-import { IntegTest } from '@aws-cdk/integ-tests-alpha';
+import { IntegTest, ExpectedResult, AwsApiCall } from '@aws-cdk/integ-tests-alpha';
 import * as cdk from 'aws-cdk-lib';
+import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
 import { Construct } from 'constructs';
 import * as ocf from '../../src';
 import { DailySnapshotTime, Engine, MajorVersion } from '../../src/aws-elasticache';
 
 class ElastiCacheStack extends cdk.Stack {
+  public readonly alarms: cloudwatch.IAlarm[] = [];
+
   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
     super(scope, id, props);
 
@@ -80,11 +83,11 @@ class ElastiCacheStack extends cdk.Stack {
       userGroup,
     });
 
-    serverlessCache.metric('CacheHits', {}).createAlarm(this, 'CacheHitsAlarm', {
+    const cacheHitsAlarm = serverlessCache.metric('CacheHits', {}).createAlarm(this, 'CacheHitsAlarm', {
       threshold: 50,
       evaluationPeriods: 1,
     });
-    serverlessCache.metricBytesUsedForCache().createAlarm(this, 'BytesUsedForCacheAlarm', {
+    const bytesUsedAlarm = serverlessCache.metricBytesUsedForCache().createAlarm(this, 'BytesUsedForCacheAlarm', {
       threshold: 50,
       evaluationPeriods: 1,
     });
@@ -93,6 +96,10 @@ class ElastiCacheStack extends cdk.Stack {
       evaluationPeriods: 1,
     });
 
+    // Add the alarms to the array to assert on them later
+    // ElastiCacheProcessingUnitsAlarm is not added because ElastiCacheProcessingUnits metric data is not available without executing commands
+    this.alarms.push(cacheHitsAlarm, bytesUsedAlarm);
+
     const role = new cdk.aws_iam.Role(this, 'TestRole', { assumedBy: new cdk.aws_iam.AccountRootPrincipal() });
     iamUser.grantConnect(role);
     importedIamUser.grantConnect(role);
@@ -104,6 +111,31 @@ const app = new cdk.App();
 
 const testCase = new ElastiCacheStack(app, 'ElastiCacheServerlessCacheStack');
 
-new IntegTest(app, 'ElastiCacheServerlessCacheTest', {
+const integ = new IntegTest(app, 'ElastiCacheServerlessCacheTest', {
   testCases: [testCase],
 });
+
+const describeAlarmsCall = integ.assertions
+  .awsApiCall(
+    'cloudwatch',
+    'DescribeAlarmsCommand',
+    {
+      AlarmNames: testCase.alarms.map(a => a.alarmName),
+    },
+    testCase.alarms.map((_, i) => `MetricAlarms.${i}.StateValue`),
+  )
+  .waitForAssertions({
+    totalTimeout: cdk.Duration.minutes(2),
+  }) as AwsApiCall;
+
+// In the current version of aws-cdk-lib, awsApiCall cannot generate the correct policy for CloudWatch API calls
+// https://github.com/aws/aws-cdk/pull/33078
+describeAlarmsCall.waiterProvider?.addToRolePolicy({
+  Effect: 'Allow',
+  Action: ['cloudwatch:DescribeAlarms'],
+  Resource: ['*'],
+});
+
+for (const [i, _] of testCase.alarms.entries()) {
+  describeAlarmsCall.assertAtPath(`MetricAlarms.${i}.StateValue`, ExpectedResult.stringLikeRegexp('OK'));
+}

test/aws-elasticache/integ.elasticache-serverless-cache.ts.snapshot/ElastiCacheServerlessCacheStack.assets.json

@@ -14,15 +14,15 @@
         }
       }
     },
-    "7d17558a1f0e522b0468782535824aa34653fc3af184543bd2aebed790e5ea9c": {
+    "d64b11b9e7a58a88f37eced4fb01e4e1930be8cfc214dd9339b0146a929ed9c3": {
       "source": {
         "path": "ElastiCacheServerlessCacheStack.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "7d17558a1f0e522b0468782535824aa34653fc3af184543bd2aebed790e5ea9c.json",
+          "objectKey": "d64b11b9e7a58a88f37eced4fb01e4e1930be8cfc214dd9339b0146a929ed9c3.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }

test/aws-elasticache/integ.elasticache-serverless-cache.ts.snapshot/ElastiCacheServerlessCacheStack.template.json

@@ -732,7 +732,7 @@
     "ComparisonOperator": "GreaterThanOrEqualToThreshold",
     "Dimensions": [
      {
-      "Name": "CacheClusterId",
+      "Name": "clusterId",
       "Value": {
        "Ref": "ElastiCacheServerlessCluster09082A11"
       }
@@ -752,7 +752,7 @@
     "ComparisonOperator": "GreaterThanOrEqualToThreshold",
     "Dimensions": [
      {
-      "Name": "CacheClusterId",
+      "Name": "clusterId",
       "Value": {
        "Ref": "ElastiCacheServerlessCluster09082A11"
       }
@@ -772,7 +772,7 @@
     "ComparisonOperator": "GreaterThanOrEqualToThreshold",
     "Dimensions": [
      {
-      "Name": "CacheClusterId",
+      "Name": "clusterId",
       "Value": {
        "Ref": "ElastiCacheServerlessCluster09082A11"
       }
@@ -910,6 +910,24 @@
    }
   }
  },
+ "Outputs": {
+  "ExportsOutputRefCacheHitsAlarm8EBEC2EA7A07A227": {
+   "Value": {
+    "Ref": "CacheHitsAlarm8EBEC2EA"
+   },
+   "Export": {
+    "Name": "ElastiCacheServerlessCacheStack:ExportsOutputRefCacheHitsAlarm8EBEC2EA7A07A227"
+   }
+  },
+  "ExportsOutputRefBytesUsedForCacheAlarm18D5884D881686E0": {
+   "Value": {
+    "Ref": "BytesUsedForCacheAlarm18D5884D"
+   },
+   "Export": {
+    "Name": "ElastiCacheServerlessCacheStack:ExportsOutputRefBytesUsedForCacheAlarm18D5884D881686E0"
+   }
+  }
+ },
  "Parameters": {
   "BootstrapVersion": {
    "Type": "AWS::SSM::Parameter::Value<String>",

test/aws-elasticache/integ.elasticache-serverless-cache.ts.snapshot/ElastiCacheServerlessCacheTestDefaultTestDeployAssertB226C8E2.assets.json

@@ -1,15 +1,28 @@
 {
   "version": "36.0.0",
   "files": {
-    "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
+    "4984c845346313a408899c8ff361d3b7b97953a9d4202e47694ef2a101f4b5c3": {
+      "source": {
+        "path": "asset.4984c845346313a408899c8ff361d3b7b97953a9d4202e47694ef2a101f4b5c3.bundle",
+        "packaging": "zip"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "4984c845346313a408899c8ff361d3b7b97953a9d4202e47694ef2a101f4b5c3.zip",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    },
+    "dbfafc122f2e9b8a060842904d5df7178d0e17369c63a7e472a779e2fe222876": {
       "source": {
         "path": "ElastiCacheServerlessCacheTestDefaultTestDeployAssertB226C8E2.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json",
+          "objectKey": "dbfafc122f2e9b8a060842904d5df7178d0e17369c63a7e472a779e2fe222876.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }