Merge pull request #1719 from guardian/jajb/define-dynamoDB-in-cdk-not-yaml

Define dynamo table in cdk

Author: JuliaBrigitte

cdk/lib/__snapshots__/footballnotificationslambda.test.ts.snap

@@ -2,8 +2,6 @@
 
 exports[`The FootballNotificationsLambda stack matches the snapshot for CODE 1`] = `
 {
-  "AWSTemplateFormatVersion": "2010-09-09",
-  "Description": "mobile-notifications-football",
   "Metadata": {
     "gu:cdk:constructs": [
       "GuDistributionBucketParameter",
@@ -14,42 +12,15 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for CODE 1`]
     "gu:cdk:version": "TEST",
   },
   "Parameters": {
-    "App": {
-      "Default": "football",
-      "Description": "Application name",
-      "Type": "String",
-    },
-    "DeployBucket": {
-      "Default": "mobile-dist",
-      "Description": "Bucket where RiffRaff uploads artifacts on deploy",
-      "Type": "String",
-    },
     "DistributionBucketName": {
       "Default": "/account/services/artifact.bucket",
       "Description": "SSM parameter containing the S3 bucket name holding distribution artifacts",
       "Type": "AWS::SSM::Parameter::Value<String>",
     },
-    "DynamoNotificationTopic": {
-      "Description": "SNS topic to notify when there's a dynamo throttling event",
-      "Type": "String",
-    },
-    "Stack": {
-      "Default": "mobile-notifications",
-      "Description": "Stack name",
-      "Type": "String",
-    },
-    "Stage": {
-      "AllowedValues": [
-        "CODE",
-        "PROD",
-      ],
-      "Default": "CODE",
-      "Description": "Stage name",
-      "Type": "String",
-    },
   },
   "Resources": {
     "DynamoTable": {
+      "DeletionPolicy": "Retain",
       "Properties": {
         "AttributeDefinitions": [
           {
@@ -67,9 +38,7 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for CODE 1`]
           "ReadCapacityUnits": 3,
           "WriteCapacityUnits": 3,
         },
-        "TableName": {
-          "Fn::Sub": "\${Stack}-\${App}-notifications-\${Stage}",
-        },
+        "TableName": "mobile-notifications-football-notifications-CODE",
         "Tags": [
           {
             "Key": "devx-backup-enabled",
@@ -98,6 +67,7 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for CODE 1`]
         },
       },
       "Type": "AWS::DynamoDB::Table",
+      "UpdateReplacePolicy": "Retain",
     },
     "ErrorEventMetricFilter9872E3AE": {
       "Properties": {
@@ -589,8 +559,6 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for CODE 1`]
 
 exports[`The FootballNotificationsLambda stack matches the snapshot for PROD 1`] = `
 {
-  "AWSTemplateFormatVersion": "2010-09-09",
-  "Description": "mobile-notifications-football",
   "Metadata": {
     "gu:cdk:constructs": [
       "GuDistributionBucketParameter",
@@ -601,42 +569,15 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for PROD 1`]
     "gu:cdk:version": "TEST",
   },
   "Parameters": {
-    "App": {
-      "Default": "football",
-      "Description": "Application name",
-      "Type": "String",
-    },
-    "DeployBucket": {
-      "Default": "mobile-dist",
-      "Description": "Bucket where RiffRaff uploads artifacts on deploy",
-      "Type": "String",
-    },
     "DistributionBucketName": {
       "Default": "/account/services/artifact.bucket",
       "Description": "SSM parameter containing the S3 bucket name holding distribution artifacts",
       "Type": "AWS::SSM::Parameter::Value<String>",
     },
-    "DynamoNotificationTopic": {
-      "Description": "SNS topic to notify when there's a dynamo throttling event",
-      "Type": "String",
-    },
-    "Stack": {
-      "Default": "mobile-notifications",
-      "Description": "Stack name",
-      "Type": "String",
-    },
-    "Stage": {
-      "AllowedValues": [
-        "CODE",
-        "PROD",
-      ],
-      "Default": "CODE",
-      "Description": "Stage name",
-      "Type": "String",
-    },
   },
   "Resources": {
     "DynamoTable": {
+      "DeletionPolicy": "Retain",
       "Properties": {
         "AttributeDefinitions": [
           {
@@ -654,9 +595,7 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for PROD 1`]
           "ReadCapacityUnits": 3,
           "WriteCapacityUnits": 3,
         },
-        "TableName": {
-          "Fn::Sub": "\${Stack}-\${App}-notifications-\${Stage}",
-        },
+        "TableName": "mobile-notifications-football-notifications-PROD",
         "Tags": [
           {
             "Key": "devx-backup-enabled",
@@ -685,6 +624,7 @@ exports[`The FootballNotificationsLambda stack matches the snapshot for PROD 1`]
         },
       },
       "Type": "AWS::DynamoDB::Table",
+      "UpdateReplacePolicy": "Retain",
     },
     "ErrorEventMetricFilter9872E3AE": {
       "Properties": {

cdk/lib/footballnotificationslambda.ts

@@ -1,21 +1,21 @@
-import { join } from 'path';
 import { GuScheduledLambda } from '@guardian/cdk';
 import { GuAlarm } from '@guardian/cdk/lib/constructs/cloudwatch';
 import type { GuStackProps } from '@guardian/cdk/lib/constructs/core';
 import { GuStack } from '@guardian/cdk/lib/constructs/core';
 import type { App } from 'aws-cdk-lib';
+import { Tags } from 'aws-cdk-lib';
 import { Duration } from 'aws-cdk-lib';
 import {
 	ComparisonOperator,
 	Metric,
 	TreatMissingData,
 	Unit,
 } from 'aws-cdk-lib/aws-cloudwatch';
+import { AttributeType, BillingMode, Table } from 'aws-cdk-lib/aws-dynamodb';
 import { Schedule } from 'aws-cdk-lib/aws-events';
 import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
 import { LoggingFormat, Runtime } from 'aws-cdk-lib/aws-lambda';
 import { LogGroup, MetricFilter } from 'aws-cdk-lib/aws-logs';
-import { CfnInclude } from 'aws-cdk-lib/cloudformation-include';
 
 export class FootballNotificationsLambda extends GuStack {
 	constructor(scope: App, id: string, props: GuStackProps) {
@@ -24,11 +24,6 @@ export class FootballNotificationsLambda extends GuStack {
 		const { stack, stage, region, account } = this;
 		const app = 'football';
 
-		const yamlTemplateFilePath = join(__dirname, '../../football/cfn.yaml');
-		new CfnInclude(this, 'YamlTemplate', {
-			templateFile: yamlTemplateFilePath,
-		});
-
 		const footballnotificationslambda = new GuScheduledLambda(
 			this,
 			`${app}-Lambda`,
@@ -68,9 +63,33 @@ export class FootballNotificationsLambda extends GuStack {
 			}),
 		);
 
-		// Keep dynoma table defition in the yaml for now
 		const dynamoTableName = `${stack}-football-notifications-${stage}`;
 
+		const dynamoTable = new Table(this, 'DynamoTable', {
+			tableName: dynamoTableName,
+			partitionKey: { name: 'notificationId', type: AttributeType.STRING },
+			billingMode: BillingMode.PROVISIONED,
+			readCapacity: 3,
+			writeCapacity: 3,
+			timeToLiveAttribute: 'ttl',
+		});
+		this.overrideLogicalId(dynamoTable, {
+			logicalId: 'DynamoTable',
+			reason: 'Retaining a stateful resource previously defined in YAML',
+		});
+
+		Tags.of(dynamoTable).add('devx-backup-enabled', 'true');
+
+		footballnotificationslambda.addToRolePolicy(
+			new PolicyStatement({
+				actions: ['dynamodb:PutItem', 'dynamodb:UpdateItem', 'dynamodb:Query'],
+				effect: Effect.ALLOW,
+				resources: [
+					`arn:aws:dynamodb:${region}:${account}:table/${dynamoTableName}`,
+				],
+			}),
+		);
+
 		footballnotificationslambda.addToRolePolicy(
 			new PolicyStatement({
 				actions: ['dynamodb:PutItem', 'dynamodb:UpdateItem', 'dynamodb:Query'],