CDK2添加CodePipeline Stage时出现读取'region'的TypeError问题

问题场景 #

在使用AWS CDK2构建CodePipeline并添加Stage时，触发TypeError: Cannot read properties of undefined(reading 'region')，错误指向pipeline.addStage代码行。

相关核心代码片段：

const aws = require('aws-sdk');
aws.config.update({
  region: 'us-east-1'
});
const codepipeline = require('aws-cdk-lib/aws-codepipeline');
const codepipeline_actions = require('aws-cdk-lib/aws-codepipeline-actions');

// 创建CodePipeline
const pipeline = new codepipeline.Pipeline(this, 'Pipeline', {
  env: {
    account: config.account,
    region: config.region,
  },
  pipelineName: config.pipelineName,
  crossAccountKeys: false,
  restartExecutionOnUpdate: true,
});

// 创建Source Artifact
const sourceOutput = new codepipeline.Artifact('SourceOutput');

// 问题根源所在
const sourceAction = new codepipeline_actions.S3SourceAction({
  actionName: 'S3Source',
  bucket: config.bucketName, // 错误：传入字符串而非IBucket对象
  bucketKey: config.bucketKey,
  output: sourceOutput,
  trigger: codepipeline_actions.S3Trigger.POLL,
});

// 添加Source Stage
pipeline.addStage({
  region: 'us-east-1',
  stageName: 'Source',
  actions: [sourceAction],
});

错误栈信息 #

TypeError: Cannot read properties of undefined(reading 'region')
at get effectiveRegion[as effectiveRegion](/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/private/rich-action.js:1:1063)
at get isCrossRegion[as isCrossRegion](/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/private/rich-action.js:1:498)
at Pipeline.ensureReplicationResourcesExistFor(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/pipeline.js:1:8351)
at Pipeline._attachActionToPipeline(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/pipeline.js:1:7708)
at Stage.attachActionToPipeline(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/private/stage.js:1:3087)
at Stage.addAction(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/private/stage.js:1:1716)
at new Stage(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/private/stage.js:1:678)
at Pipeline.addStage(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/node_modules/aws-cdk-lib/aws-codepipeline/lib/pipeline.js:1:6662)
at new CodedeployCodepipelineS3CdkStack(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/lib/codedeploy-codepipeline-s3-cdk-stack.js:207:14)
at Object.<anonymous>(/Users/userx/AWS-CDK/codedeploy-codepipeline-s3-cdk/bin/codedeploy-codepipeline-s3-cdk.js:9:1)
Node.js v18.0.0
子进程退出并返回错误1

已尝试但无效的方案 #

• 在aws-sdk中全局配置region：

  const aws = require('aws-sdk');
  aws.config.update({ region: 'us-east-1' });
  

• 在Pipeline构造函数的env参数中指定region和account
• 在addStage方法中显式指定region

根本原因与解决方法 #

原因 #

S3SourceAction的bucket参数要求传入IBucket类型的对象，而非字符串格式的桶名称。直接传字符串会导致CDK无法识别桶的区域信息，进而触发region读取失败的错误。

解决步骤 #

1. 导入AWS S3模块
2. 通过桶名称获取对应的IBucket对象（适用于已存在的桶），或者创建新的桶对象
3. 将IBucket对象传入S3SourceAction的bucket参数

修正后的代码：

// 新增导入S3模块
const s3 = require('aws-cdk-lib/aws-s3');

// ... 其他代码保持不变 ...

// 创建Source Artifact
const sourceOutput = new codepipeline.Artifact('SourceOutput');

// 获取已存在的S3桶对象
const sourceBucket = s3.Bucket.fromBucketName(this, 'SourceBucket', config.bucketName);

// 修正后的S3SourceAction
const sourceAction = new codepipeline_actions.S3SourceAction({
  actionName: 'S3Source',
  bucket: sourceBucket, // 传入IBucket对象而非字符串
  bucketKey: config.bucketKey,
  output: sourceOutput,
  trigger: codepipeline_actions.S3Trigger.POLL,
});

// ... 后续添加Stage的代码保持不变 ...

额外检查：确保config.region变量有有效值，避免Pipeline的env配置中region为undefined。

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