跨CDK栈复用已有API Gateway并更新DEV阶段部署问题

问题背景 #

• 已通过独立CDK栈（CdkApiGateway）创建API Gateway，部署了/v1资源到DEV阶段
• 现在要通过多个Lambda服务的CDK栈，给已有API Gateway添加子资源（比如/user、/account），复用同一网关实现services.company.com/user/这类路径访问
• 已经用apigateway.RestApi.from_rest_api_attributes导入网关，新增资源在控制台资源列表可见，但未同步到已部署的DEV阶段
• 尝试创建新Deployment但阶段未更新，直接创建同名DEV阶段提示资源已存在

解决步骤 #

1. 正确关联Deployment与新增资源 #

导入网关后添加子资源时，必须确保Deployment依赖所有新增资源，同时通过动态Logical ID避免CDK复用旧Deployment。修改代码如下：

from aws_cdk import aws_apigateway as apigateway
from datetime import datetime

# 导入已有API Gateway
api = apigateway.RestApi.from_rest_api_attributes(
    self, 'company_api_id-dev',
    rest_api_id=api_gateway_id,
    root_resource_id=api_gateway_root_id
)

# 添加子资源（示例：/test1）
root_resource = api.root
test_resource = root_resource.add_resource("test1")
# 这里可以继续添加Lambda集成，比如：
# test_resource.add_method("GET", apigateway.LambdaIntegration(your_lambda_function))

# 生成动态时间戳作为Logical ID的一部分，确保每次部署生成新Deployment
timestamp = datetime.now().strftime("%Y%m%d%H%M%S")
deployment = apigateway.Deployment(self, f'api-deploy-{env_name}', api=api)
# 显式声明Deployment依赖新增资源，确保资源创建完成后再部署
deployment.node.add_dependency(test_resource)
# 覆盖Logical ID，避免CDK复用旧的Deployment资源
deployment.add_to_logical_id(timestamp)

2. 导入已有DEV阶段并关联新Deployment #

不能直接创建同名阶段，需通过apigateway.Stage.from_stage_attributes导入已有阶段，但CDK无法直接修改导入的阶段，提供两种可行方案：

方案A：使用AWS SDK自定义资源触发阶段更新

通过CDK的自定义资源调用AWS API更新已有阶段的Deployment：

from aws_cdk import CustomResource, aws_lambda as lambda_, aws_iam as iam
from constructs import Construct

class UpdateApiStage(Construct):
    def __init__(self, scope: Construct, id: str, stage_name: str, rest_api_id: str, deployment_id: str):
        super().__init__(scope, id)
        
        # 创建执行更新的Lambda函数
        update_lambda = lambda_.Function(
            self, 'UpdateApiStageLambda',
            runtime=lambda_.Runtime.PYTHON_3_11,
            handler='index.lambda_handler',
            code=lambda_.Code.from_inline("""
import boto3
def lambda_handler(event, context):
    apigateway = boto3.client('apigateway')
    apigateway.update_stage(
        restApiId=event['ResourceProperties']['RestApiId'],
        stageName=event['ResourceProperties']['StageName'],
        patchOperations=[{
            'op': 'replace',
            'path': '/deploymentId',
            'value': event['ResourceProperties']['DeploymentId']
        }]
    )
    return {'PhysicalResourceId': event['ResourceProperties']['StageName']}
            """),
            timeout=lambda_.Duration.seconds(30)
        )
        
        # 给Lambda添加更新API阶段的权限
        update_lambda.add_to_role_policy(iam.PolicyStatement(
            actions=['apigateway:UpdateStage'],
            resources=[f'arn:aws:apigateway:{self.region}::/restapis/{rest_api_id}/stages/{stage_name}']
        ))
        
        # 创建自定义资源触发更新
        CustomResource(
            self, 'UpdateStageResource',
            service_token=update_lambda.function_arn,
            properties={
                'RestApiId': rest_api_id,
                'StageName': stage_name,
                'DeploymentId': deployment.deployment_id
            }
        )

# 在你的栈中调用这个自定义资源
UpdateApiStage(self, 'UpdateDevStage',
    stage_name=env_name,
    rest_api_id=api_gateway_id,
    deployment_id=deployment.deployment_id
)

方案B：在初始ApiGateway栈中预留Deployment引用

如果有权限修改初始的CdkApiGateway栈，可以在该栈中导出Deployment的ARN或ID，然后在其他服务栈中导入并关联阶段。但这种方式耦合性较高，适合统一管理的场景。

3. 验证效果 #

部署完成后：

• 检查API Gateway控制台的DEV阶段，确认Deployment已更新为新创建的版本
• 测试新增的资源路径（如services.company.com/test1）是否正常访问

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