Update: [AEA-4574] - Updates Stack and Resource Names

.github/workflows/cdk_release_code.yml

@@ -88,12 +88,14 @@ jobs:
       - name: fix cdk.json for deployment
         run: |
           jq \
-          --arg serviceName "${{ inputs.SERVICE_NAME }}" \
+          --arg SERVICE_NAME "${{ inputs.SERVICE_NAME }}" \
+          --arg ENVIRONMENT "${{ inputs.TARGET_ENVIRONMENT }}" \
           --arg VERSION_NUMBER "${{ inputs.VERSION_NUMBER }}" \
           --arg COMMIT_ID "${{ inputs.COMMIT_ID }}" \
           --argjson allowAutoDeleteObjects "${{ inputs.ALLOW_AUTO_DELETE_OBJECTS }}" \
           '.context += {
-            "serviceName": $serviceName,
+            "SERVICE_NAME": $SERVICE_NAME,
+            "ENVIRONMENT": $ENVIRONMENT,
             "VERSION_NUMBER": $VERSION_NUMBER,
             "COMMIT_ID": $COMMIT_ID,
             "allowAutoDeleteObjects": $allowAutoDeleteObjects

.github/workflows/ci.yml

@@ -98,7 +98,7 @@ jobs:
     needs: [tag_release, package_code, get_commit_id]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: dev
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
@@ -128,7 +128,7 @@ jobs:
     needs: [tag_release, release_dev, package_code, get_commit_id]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: qa
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}

.github/workflows/pull_request.yml

@@ -63,8 +63,8 @@ jobs:
     needs: [get_issue_number, package_code, get_commit_id, quality_checks]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources-pr-${{needs.get_issue_number.outputs.issue_number}}
-      TARGET_ENVIRONMENT: dev-pr
+      SERVICE_NAME: eps-spine
+      TARGET_ENVIRONMENT: dev-pr-${{needs.get_issue_number.outputs.issue_number}}
       VERSION_NUMBER: PR-${{ needs.get_issue_number.outputs.issue_number }}
       COMMIT_ID: ${{ needs.get_commit_id.outputs.commit_id }}
       CDK_APP_NAME: StorageResourcesApp

.github/workflows/release.yml

@@ -117,7 +117,7 @@ jobs:
     needs: [tag_release, package_code, get_commit_id]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: dev
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
@@ -146,7 +146,7 @@ jobs:
     needs: [tag_release, package_code, get_commit_id, release_dev]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: ref
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
@@ -160,7 +160,7 @@ jobs:
     needs: [tag_release, package_code, get_commit_id, release_dev]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: qa
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
@@ -174,7 +174,7 @@ jobs:
     needs: [tag_release, package_code, get_commit_id, release_qa]
     uses: ./.github/workflows/cdk_release_code.yml
     with:
-      SERVICE_NAME: storage-resources
+      SERVICE_NAME: eps-spine
       TARGET_ENVIRONMENT: int
       VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
       COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}
@@ -188,7 +188,7 @@ jobs:
   #   needs: [tag_release, package_code, get_commit_id, release_int]
   #   uses: ./.github/workflows/cdk_release_code.yml
   #   with:
-  #     SERVICE_NAME: storage-resources
+  #     SERVICE_NAME: eps-spine
   #     TARGET_ENVIRONMENT: prod
   #     VERSION_NUMBER: ${{needs.tag_release.outputs.version_tag}}
   #     COMMIT_ID: ${{needs.get_commit_id.outputs.commit_id}}

Makefile

@@ -67,17 +67,20 @@ cdk-synth:
 	npx cdk synth \
 		--quiet \
 		--app "npx ts-node --prefer-ts-exts packages/cdk/bin/StorageResourcesApp.ts" \
+		--context SERVICE_NAME=undefined \
+		--context ENVIRONMENT=undefined \
 		--context VERSION_NUMBER=undefined \
 		--context COMMIT_ID=undefined 
 
-cdk-diff: guard-service_name
+cdk-diff: guard-SERVICE_NAME guard-ENVIRONMENT
 	npx cdk diff \
 		--app "npx ts-node --prefer-ts-exts packages/cdk/bin/StorageResourcesApp.ts" \
-		--context serviceName=$$service_name \
+		--context SERVICE_NAME=$$SERVICE_NAME \
+		--context ENVIRONMENT=$$ENVIRONMENT \
 		--context VERSION_NUMBER=$$VERSION_NUMBER \
 		--context COMMIT_ID=$$COMMIT_ID 
 
-cdk-watch: guard-service_name
+cdk-watch: guard-SERVICE_NAME guard-ENVIRONMENT
 	REQUIRE_APPROVAL="$${REQUIRE_APPROVAL:-any-change}" && \
 	VERSION_NUMBER="$${VERSION_NUMBER:-undefined}" && \
 	COMMIT_ID="$${COMMIT_ID:-undefined}" && \
@@ -87,6 +90,7 @@ cdk-watch: guard-service_name
 		--all \
 		--ci true \
 		--require-approval $${REQUIRE_APPROVAL} \
-		--context serviceName=$$service_name \
+		--context SERVICE_NAME=$$SERVICE_NAME \
+		--context ENVIRONMENT=$$ENVIRONMENT \
 		--context VERSION_NUMBER=$$VERSION_NUMBER \
 		--context COMMIT_ID=$$COMMIT_ID

packages/cdk/bin/StorageResourcesApp.ts

@@ -8,7 +8,10 @@ const app = new App()
   - logRetentionInDays
 */
 
-const serviceName = app.node.tryGetContext("serviceName")
+const serviceName = app.node.tryGetContext("SERVICE_NAME")
+const environment = app.node.tryGetContext("ENVIRONMENT")
+const stackPrefix = `nhse-${environment}-${serviceName}`
+
 const version = app.node.tryGetContext("VERSION_NUMBER")
 const commit = app.node.tryGetContext("COMMIT_ID")
 
@@ -19,10 +22,10 @@ Tags.of(app).add("version", version)
 Tags.of(app).add("commit", commit)
 Tags.of(app).add("cdkApp", "StorageResourcesApp")
 
-new StorageResourcesStack(app, "StorageResourcesStack", {
+new StorageResourcesStack(app, {
   env: {
     region: "eu-west-2"
   },
-  stackName: `${serviceName}`,
+  stackPrefix: stackPrefix,
   version: version
 })

packages/cdk/nagSuppressions.ts

@@ -6,7 +6,7 @@ import {NagPackSuppression, NagSuppressions} from "cdk-nag"
 export const nagSuppressions = (stack: Stack) => {
   safeAddNagSuppression(
     stack,
-    "/StorageResourcesStack/DynamoDB/TableReadManagedPolicy/Resource",
+    "/DynamoDB/TableReadManagedPolicy/Resource",
     [
       {
         id: "AwsSolutions-IAM5",
@@ -17,7 +17,7 @@ export const nagSuppressions = (stack: Stack) => {
 
   safeAddNagSuppression(
     stack,
-    "/StorageResourcesStack/DynamoDB/TableWriteManagedPolicy/Resource",
+    "/DynamoDB/TableWriteManagedPolicy/Resource",
     [
       {
         id: "AwsSolutions-IAM5",
@@ -30,10 +30,12 @@ export const nagSuppressions = (stack: Stack) => {
 
 const safeAddNagSuppression = (stack: Stack, path: string, suppressions: Array<NagPackSuppression>) => {
   try {
-    NagSuppressions.addResourceSuppressionsByPath(stack, path, suppressions)
+    const stack_id = stack.node.id
+    const full_path = `/${stack_id}${path}`
+    NagSuppressions.addResourceSuppressionsByPath(stack, full_path, suppressions)
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch(err){
-    console.log(`Could not find path ${path}`)
+    console.log(`Could not find path ${path} in stack ${stack.node.id}`)
   }
 }

packages/cdk/resources/Dynamodb.ts

@@ -17,7 +17,7 @@ import {Duration, RemovalPolicy} from "aws-cdk-lib"
 import {ATTRIBUTE_KEYS, AttributeNames} from "./attributes"
 
 export interface DynamodbProps {
-  readonly stackName: string
+  readonly stackPrefix: string
   readonly account: string
   readonly region: string
   readonly allowAutoDeleteObjects: boolean
@@ -41,8 +41,8 @@ export class Dynamodb extends Construct {
     const DatastoreKmsKey = new Key(this, "DatastoreKmsKey", {
       removalPolicy: RemovalPolicy.DESTROY,
       pendingWindow: Duration.days(7),
-      alias: `alias/${props.stackName}-DatastoreKmsKey`,
-      description: `${props.stackName}-DatastoreKmsKey`,
+      alias: `alias/${props.stackPrefix}-DatastoreKmsKey`,
+      description: `${props.stackPrefix}-DatastoreKmsKey`,
       enableKeyRotation: true
     })
 
@@ -68,7 +68,7 @@ export class Dynamodb extends Construct {
     const DatastoreTable = new TableV2(this, "DatastoreTable", {
       partitionKey: ATTRIBUTE_KEYS.PRIMARY_KEY,
       sortKey: ATTRIBUTE_KEYS.SORT_KEY,
-      tableName: `${props.stackName}-datastore`,
+      tableName: `${props.stackPrefix}`,
       removalPolicy: props.allowAutoDeleteObjects ? RemovalPolicy.DESTROY: RemovalPolicy.RETAIN,
       pointInTimeRecovery: true,
       encryption: TableEncryptionV2.customerManagedKey(DatastoreKmsKey),

packages/cdk/stacks/StorageResourcesStack.ts

@@ -9,7 +9,7 @@ import {nagSuppressions} from "../nagSuppressions"
 import {Dynamodb} from "../resources/Dynamodb"
 
 export interface StorageResourcesStackProps extends StackProps{
-  readonly stackName: string
+  readonly stackPrefix: string
   readonly version: string
 }
 
@@ -18,8 +18,8 @@ export interface StorageResourcesStackProps extends StackProps{
  */
 
 export class StorageResourcesStack extends Stack {
-  public constructor(scope: App, id: string, props: StorageResourcesStackProps){
-    super(scope, id, props)
+  public constructor(scope: App, props: StorageResourcesStackProps){
+    super(scope, props.stackPrefix, props)
 
     // Context
     /* context values passed as --context cli arguments are passed as strings so coerce them to expected types*/
@@ -29,7 +29,7 @@ export class StorageResourcesStack extends Stack {
 
     // Resources
     const dynamodb = new Dynamodb(this, "DynamoDB", {
-      stackName: props.stackName,
+      stackPrefix: props.stackPrefix,
       account: this.account,
       region: this.region,
       allowAutoDeleteObjects: allowAutoDeleteObjects
@@ -40,23 +40,23 @@ export class StorageResourcesStack extends Stack {
     //Exports
     new CfnOutput(this, "tableWriteManagedPolicyArn", {
       value: dynamodb.tableWriteManagedPolicy.managedPolicyArn,
-      exportName: `${props.stackName}:tableWriteManagedPolicy:Arn`
+      exportName: `${props.stackPrefix}:tableWriteManagedPolicy:Arn`
     })
     new CfnOutput(this, "tableReadManagedPolicyArn", {
       value: dynamodb.tableReadManagedPolicy.managedPolicyArn,
-      exportName: `${props.stackName}:tableReadManagedPolicy:Arn`
+      exportName: `${props.stackPrefix}:tableReadManagedPolicy:Arn`
     })
     new CfnOutput(this, "usePrescriptionsTableKmsKeyPolicyArn", {
       value: dynamodb.usePrescriptionsTableKmsKeyPolicy.managedPolicyArn,
-      exportName: `${props.stackName}:usePrescriptionsTableKmsKeyPolicy:Arn`
+      exportName: `${props.stackPrefix}:usePrescriptionsTableKmsKeyPolicy:Arn`
     })
     new CfnOutput(this, "DatastoreTableArn", {
       value: dynamodb.DatastoreTable.tableArn,
-      exportName: `${props.stackName}:DatastoreTable:Arn`
+      exportName: `${props.stackPrefix}:DatastoreTable:Arn`
     })
     new CfnOutput(this, "DatastoreKmsKeyArn", {
       value: dynamodb.DatastoreKmsKey.keyArn,
-      exportName: `${props.stackName}:DatastoreKmsKey:Arn`
+      exportName: `${props.stackPrefix}:DatastoreKmsKey:Arn`
     })
     nagSuppressions(this)
   }