AWS CDK Python如何导入子目录模块并调用方法创建资源

1. 代码组织实践与推荐方案 #

这种模块化拆分是CDK Python非常常见的使用方式，完全可以实现，不用把所有逻辑都堆在单个栈文件的__init__方法里。行业通用的两种组织方案：

• 按资源类型拆分：按s3、ec2、lambda、rds等不同云资源类型建立子目录，每个子目录下存放对应资源的构造逻辑，适合资源通用性强、跨业务复用的场景
• 按业务模块拆分：按支付、用户、后台等不同业务域建立子目录，每个子目录下存放该业务域需要的所有关联资源逻辑，适合业务边界清晰的中大型项目
  核心要求是所有自定义的资源逻辑类都要继承CDK原生的Construct基类，不要用普通自定义类。

2. 无报错但资源未创建的原因与排查方法 #

根本原因 #

你创建的S3资源没有挂载到当前栈的资源树上，CDK合成CloudFormation模板时不会包含未挂载的资源，所以部署过程不会报错，但实际不会生成资源。绝大多数情况是你自定义的CreateS3Bucket类没有接收栈的scope参数，创建S3桶时也没有将资源绑定到当前栈的scope上。

排查方法 #

• 先执行cdk synth命令，查看输出的CloudFormation模板中是否存在AWS::S3::Bucket类型的资源定义，如果没有就确认是资源挂载问题
• 查看部署详细日志可以加-v参数执行cdk deploy -v，也可以直接登录AWS控制台进入CloudFormation页面，查看对应栈的事件日志确认资源创建记录

3. 多子目录导入的实现方法 #

你当前的setup.py配置已经满足要求，只要每个新增子目录下都添加空的__init__.py文件，就可以在顶层栈文件正常导入。只需要调整自定义资源类的写法即可，示例如下：

子目录资源类写法（create_s3_bucket.py） #

from aws_cdk import (
    core,
    aws_s3 as s3
)

# 继承Construct基类
class CreateS3Bucket(core.Construct):
    def __init__(self, scope: core.Construct, id: str, bucket_name: str, **kwargs) -> None:
        # 调用父类初始化，绑定父scope
        super().__init__(scope, id, **kwargs)
        
        # 创建资源时scope传self，自动挂载到父scope（即栈实例）上
        s3.Bucket(self, "CustomS3Bucket",
            bucket_name=bucket_name,
            versioned=True,
            removal_policy=core.RemovalPolicy.DESTROY
        )

顶层栈文件调用写法 #

from aws_cdk import core
from my_aws_s3.create_s3_bucket import CreateS3Bucket

class AwsCdkPythonStack(core.Stack):
    def __init__(self, scope: core.Construct, construct_id: str, **kwargs) -> None:
        super().__init__(scope, construct_id, **kwargs)
        
        # 直接实例化自定义资源类，传入当前栈实例作为scope即可
        CreateS3Bucket(self, "MyTestBucket", 
            bucket_name="your-unique-bucket-name-123"
        )

调整后重新执行cdk synth确认模板存在S3资源，再执行cdk deploy即可正常创建桶。

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