AWS CDK配置API Gateway与SQS集成时Content-Type报错排查

核心问题分析 #

你遇到的CloudFormation ValidationError，主要是因为API Gateway配置不完整，加上可能的参数格式问题导致的，以下是具体修复点：

1. 必须配置Method Response #

API Gateway要求Method Response和Integration Response一一对应，你当前只定义了集成响应，缺少方法响应配置，这是CloudFormation验证失败的关键原因。

2. 确认RequestParameters的VTL格式 #

虽然你给Content-Type加了单引号，但要确保VTL表达式在CDK中被正确解析。当前的写法"'application/x-www-form-urlencoded'"是正确的，但如果依然报错，可以尝试改用VTL工具函数：

{ "integration.request.header.Content-Type", "$util.escapeJavaScript('application/x-www-form-urlencoded')" }

3. 验证SQS集成Path的正确性 #

确保Path中的账号ID和队列名称完全匹配：

• props.Env.Account必须正确传入当前AWS账号ID
• 队列名称Communications-SendGridWebhook要和实际创建的SQS队列名称完全一致，包括大小写

修复后的完整代码示例 #

var integrationRole = new Role(this, "SendGrid-Webhook-Integration-Role", new RoleProps()
{
    AssumedBy = new ServicePrincipal("apigateway.amazonaws.com")
});

sqsFunc.Queue1.GrantSendMessages(integrationRole);

var restApi = new RestApi(this, "SendGrid-Webhook-API");

var requestParams = new Dictionary<string, string>
{
    { "integration.request.header.Content-Type", "'application/x-www-form-urlencoded'" }
};

var requestTemplate = new Dictionary<string, string>
{
    { "application/json",  "Action=SendMessage&MessageBody=$input.body"}
};

var integration = new AwsIntegration(new AwsIntegrationProps
{
    Service = "sqs",
    IntegrationHttpMethod = "POST",
    Path = $"{props.Env.Account}/Communications-SendGridWebhook",
    Options = new IntegrationOptions
    {
        CredentialsRole = integrationRole,
        PassthroughBehavior = PassthroughBehavior.NEVER,
        RequestParameters = requestParams,
        RequestTemplates = requestTemplate,
        IntegrationResponses = new List<IntegrationResponse>() {
            new IntegrationResponse { StatusCode = "200"}
        }.ToArray()
    }
});

// 关键：添加POST方法时配置对应的*Method Response*
restApi.Root.AddMethod("POST", integration, new MethodOptions
{
    MethodResponses = new List<MethodResponse>() {
        new MethodResponse { StatusCode = "200" }
    }.ToArray()
});

额外排查技巧 #

• 运行cdk deploy --verbose获取详细部署日志，能看到CloudFormation返回的具体错误细节，而不是模糊的ValidationError
• 检查集成角色的信任策略，确认apigateway.amazonaws.com被允许扮演该角色
• 验证SQS队列的权限，确保集成角色拥有sqs:SendMessage权限

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