从自定义CDK资源引用Amplify生成资源时的报错修复方案

错误信息 #

尝试在自定义CDK栈中引用Amplify生成的Lambda函数时，出现以下TypeScript类型错误：

cdk-stack.ts(22,100): error TS2345: Argument of type 'this' is not assignable to parameter of type 'Stack'.
  Type 'cdkStack' is not assignable to type 'Stack'.
    Types of property 'tags' are incompatible.
      Property 'initialTagPriority' is missing in type 'import("<hidden>").TagManager' but required in type 'import("<hidden>").TagManager'.

问题代码 #

import * as cdk from 'aws-cdk-lib';
import * as AmplifyHelpers from '@aws-amplify/cli-extensibility-helper';
import { AmplifyDependentResourcesAttributes } from '../../types/amplify-dependent-resources-ref';
import { Construct } from 'constructs';

export class cdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps, amplifyResourceProps?: AmplifyHelpers.AmplifyResourceProps) {
    super(scope, id, props);
    /* Do not remove - Amplify CLI automatically injects the current deployment environment in this input parameter */
    new cdk.CfnParameter(this, 'env', {
      type: 'String',
      description: 'Current Amplify CLI env name',
    });

    const dependencies: AmplifyDependentResourcesAttributes = AmplifyHelpers.addResourceDependency(this,
      amplifyResourceProps.category,
      amplifyResourceProps.resourceName,
      [{
        category: "function",
        resourceName: "myFunction"
      }]
    );
    
    // ... rest of code commented out ...
  }
}

解决方法 #

这个错误的核心是CDK库（aws-cdk-lib）和Amplify扩展助手（@aws-amplify/cli-extensibility-helper）的版本不匹配，导致两者的TagManager类型定义不一致。按以下步骤解决：

• 对齐依赖版本：
  检查package.json中的aws-cdk-lib版本，确保@aws-amplify/cli-extensibility-helper的版本与Amplify CLI、CDK版本兼容。例如使用CDK v2时，需确保扩展助手适配v2版本。

• 更新依赖包：
  运行命令更新到兼容版本：

  npm install aws-cdk-lib@latest @aws-amplify/cli-extensibility-helper@latest
  

  若需要指定版本，可替换latest为匹配的版本号。

• 清理并重装依赖：
  删除node_modules目录和package-lock.json（或yarn.lock），重新执行npm install或yarn install，确保依赖完全更新。

• 重新生成Amplify类型文件：
  运行amplify push或amplify codegen，让Amplify CLI重新生成amplify-dependent-resources-ref.ts文件，避免旧类型定义导致的冲突。

• 临时类型断言（仅应急用）：
  若暂时无法更新版本，可通过类型断言绕过类型检查：

  const dependencies: AmplifyDependentResourcesAttributes = AmplifyHelpers.addResourceDependency(
    this as cdk.Stack,
    amplifyResourceProps.category,
    amplifyResourceProps.resourceName,
    [{
      category: "function",
      resourceName: "myFunction"
    }]
  );
  

  注意：这只是临时方案，长期来看必须对齐依赖版本才能彻底解决问题。

内容的提问来源于stack exchange，提问作者fuse117