Handle errors when checking CDK bootstrap (#2204)

Author: sobolk

.changeset/eleven-numbers-hide.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-deployer': patch
+---
+
+Handle errors when checking CDK bootstrap.

packages/backend-deployer/src/cdk_error_mapper.test.ts

@@ -96,6 +96,26 @@ const testErrorMappings = [
     errorName: 'BootstrapNotDetectedError',
     expectedDownstreamErrorMessage: 'Is this account bootstrapped',
   },
+  {
+    errorMessage:
+      // eslint-disable-next-line spellcheck/spell-checker
+      "This CDK deployment requires bootstrap stack version '6', but during the confirmation via SSM parameter /cdk-bootstrap/hnb659fds/version the following error occurred: AccessDeniedException",
+    expectedTopLevelErrorMessage:
+      'Unable to detect CDK bootstrap stack due to permission issues.',
+    errorName: 'BootstrapDetectionError',
+    expectedDownstreamErrorMessage:
+      // eslint-disable-next-line spellcheck/spell-checker
+      "This CDK deployment requires bootstrap stack version '6', but during the confirmation via SSM parameter /cdk-bootstrap/hnb659fds/version the following error occurred: AccessDeniedException",
+  },
+  {
+    errorMessage:
+      "This CDK deployment requires bootstrap stack version '6', found '5'. Please run 'cdk bootstrap'.",
+    expectedTopLevelErrorMessage:
+      'This AWS account and region has outdated CDK bootstrap stack.',
+    errorName: 'BootstrapOutdatedError',
+    expectedDownstreamErrorMessage:
+      "This CDK deployment requires bootstrap stack version '6', found '5'. Please run 'cdk bootstrap'.",
+  },
   {
     errorMessage: 'Amplify Backend not found in amplify/backend.ts',
     expectedTopLevelErrorMessage:

packages/backend-deployer/src/cdk_error_mapper.ts

@@ -118,6 +118,26 @@ export class CdkErrorMapper {
       errorName: 'BootstrapNotDetectedError',
       classification: 'ERROR',
     },
+    {
+      errorRegex:
+        /This CDK deployment requires bootstrap stack version \S+, found \S+\. Please run 'cdk bootstrap'\./,
+      humanReadableErrorMessage:
+        'This AWS account and region has outdated CDK bootstrap stack.',
+      resolutionMessage:
+        'Run `cdk bootstrap aws://{YOUR_ACCOUNT_ID}/{YOUR_REGION}` locally to re-bootstrap.',
+      errorName: 'BootstrapOutdatedError',
+      classification: 'ERROR',
+    },
+    {
+      errorRegex:
+        /This CDK deployment requires bootstrap stack version \S+, but during the confirmation via SSM parameter \S+ the following error occurred: AccessDeniedException/,
+      humanReadableErrorMessage:
+        'Unable to detect CDK bootstrap stack due to permission issues.',
+      resolutionMessage:
+        "Ensure that AWS credentials have an IAM policy that grants read access to 'arn:aws:ssm:*:*:parameter/cdk-bootstrap/*' SSM parameters.",
+      errorName: 'BootstrapDetectionError',
+      classification: 'ERROR',
+    },
     {
       errorRegex:
         /This CDK CLI is not compatible with the CDK library used by your application\. Please upgrade the CLI to the latest version\./,
@@ -326,6 +346,8 @@ export type CDKDeploymentError =
   | 'BackendBuildError'
   | 'BackendSynthError'
   | 'BootstrapNotDetectedError'
+  | 'BootstrapDetectionError'
+  | 'BootstrapOutdatedError'
   | 'CDKResolveAWSAccountError'
   | 'CDKVersionMismatchError'
   | 'CFNUpdateNotSupportedError'