AWS CDK导入Lambda调用addEnvironment报TS2339错误如何解决

lambda.Function.fromFunctionAttributes() 返回的是 IFunction 类型的只读引用，这个类型是CDK设计用来指代「外部已存在的Lambda资源」的抽象接口，不包含修改Lambda配置的方法——addEnvironment 是 lambda.Function 具体实现类的方法，仅对CDK自己创建、归属于当前CDK应用管辖的Lambda实例生效，因此调用时会触发TS类型错误。

硬编码ARN导入外部资源的方式本身不符合CDK跨资源访问的设计逻辑，不仅无法修改资源配置，后续还容易出现栈配置漂移、权限不一致的问题。

通过CDK原生的跨栈资源引用能力实现，不需要硬编码ARN导入：

1. 在GraphqlStack中对外暴露创建的Lambda实例 #

给GraphqlStack增加公开属性，把内部创建的Lambda实例暴露给其他栈使用：

export class GraphqlStack extends Stack {
  // 新增公开属性，对外暴露Lambda实例
  public readonly graphqlHandler: lambda.Function;
  constructor(scope: App, id: string, props: StackProps){
   super(scope, id, props);
   // 把创建的Lambda实例赋值给公开属性
   this.graphqlHandler = new lambda.Function(this, "graphqlHandler", {
      runtime: lambda.Runtime.GO_1_X,
      functionName: `${STAGE}-graphql`,
      code: lambda.Code.fromAsset(Path.join("..", "bin")),
      handler: "graphql",
      tracing: Tracing.ACTIVE,
      timeout: Duration.seconds(60),
      memorySize: 512,
      vpc: vpc,
      vpcSubnets: {
        subnets: vpc.privateSubnets,
      },
      securityGroups: [vpcSecurityGroup],
    });
    this.graphqlHandler.addEnvironment("DATABASE_USERNAME", DATABASE_USERNAME || "");
    this.graphqlHandler.addEnvironment("DATABASE_PASSWORD", DATABASE_PASSWORD || "");
  }
}

2. 扩展S3Stack的属性定义，接收传入的Lambda实例 #

先扩展S3Stack的Props类型，增加传入Lambda实例的字段，不需要再用fromFunctionAttributes导入资源：

// 扩展S3Stack专属的Props类型
interface S3StackProps extends StackProps {
  graphqlHandler: lambda.Function;
}

export class S3Stack extends Stack {
  constructor(scope: App, id: string, props: S3StackProps){
    super(scope, id, props);
    const bucketName = `${STAGE}-myfiles`;
    const graphLambda = props.graphqlHandler;
    // 此时调用addEnvironment无TS类型错误，CDK会自动把环境变量配置同步到Lambda
    graphLambda.addEnvironment("FILES_BUCKET_NAME", bucketName || "");
    s3Bucket.grantWrite(graphLambda);
  }
}

3. 在CDK应用入口处传递跨栈引用 #

在应用的入口文件（通常是bin/目录下的ts文件）实例化两个栈时，直接把GraphqlStack暴露的Lambda实例传给S3Stack即可：

const app = new cdk.App();
// 先实例化GraphQL栈
const graphqlStack = new GraphqlStack(app, `${STAGE}-GraphqlStack`, {
  // 原有栈配置，比如env参数等
});
// 实例化S3栈时传入Lambda实例
const s3Stack = new S3Stack(app, `${STAGE}-S3Stack`, {
  graphqlHandler: graphqlStack.graphqlHandler,
  // 原有S3栈配置
});

• 所有CDK中fromXxxAttributes、fromXxxArn类的方法，返回的都是只读的资源引用，仅可用于授权、关联其他资源，不能修改资源本身的配置
• 跨栈直接传递CDK创建的资源实例时，CDK会自动处理资源依赖关系、权限引用、配置同步，不会出现硬编码ARN带来的环境不一致、配置漂移问题
• 这种方式下CDK部署时会自动给Lambda添加对应的环境变量，不需要手动维护ARN信息，切换STAGE环境时也不需要修改硬编码的账号、区域参数

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