Create an aws integration in Http API using AWS CDK

Question

I'm using AWS CDK to build a cloudformation stack with HttpApi in it. HttpApi will have an integration with SQS.

I have the following snippet:

import * as ApiGW2 from "@aws-cdk/aws-apigatewayv2-alpha";

const httpApi = new ApiGW2.HttpApi(this, "http-api", {
  apiName: "dev-api"
});

const int = new ApiGW2.HttpIntegration(this, "int1", {
  httpApi,
  integrationType: ApiGW2.HttpIntegrationType.AWS_PROXY,
  integrationSubtype: ApiGW2.HttpIntegrationSubtype.SQS_SEND_MESSAGE,
  payloadFormatVersion: ApiGW2.PayloadFormatVersion.VERSION_1_0,
})

But I get an error when running this code:

UPDATE_ROLLBACK_COMPLETE: Role ARN must be specified for AWS integration configuration with Subtype: SQS-SendMessage

fedonev · Accepted Answer · 2023-11-21 09:57:50Z

1

The API Gateway service needs permission to send messages to your queue. Create a role assumable by the API Gateway service. Grant the role send permissions on your queue. Pass the role to the integration in the credentials prop:

const sqsRole = new iam.Role(this, "Role", {
  assumedBy: new iam.ServicePrincipal("apigateway.amazonaws.com"),
});

myQueue.grantSendMessages(sqsRole);

const credentials = ApiGW2.IntegrationCredentials.fromRole(sqsRole);

const int = new ApiGW2.HttpIntegration(this, "int1", {
  httpApi,
  integrationType: ApiGW2.HttpIntegrationType.AWS_PROXY,
  integrationSubtype: ApiGW2.HttpIntegrationSubtype.SQS_SEND_MESSAGE,
  payloadFormatVersion: ApiGW2.PayloadFormatVersion.VERSION_1_0,
  credentials, // <-- connects the role to the integration
})

answered Nov 21, 2023 at 9:57

fedonev

26.2k2 gold badges43 silver badges60 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Aleksand Kondaurov Over a year ago

Thanks @fedonev! It works, the integration gets created but I can't use it in addRoute of HttpApi. httpApi.addRoutes({ path: "/toSqs", integration: int }) I’ve got compile error: Type HttpIntegration is missing the following properties from type HttpRouteIntegratio

fedonev Over a year ago

Glad to help, @AlexanderKondaurov. See the open GitHub issue apigatewayv2-integrations: Add support for SQS-SendMessage integration. The comments include a DIY implementation of a HttpRouteIntegration class for SQS-SendMessage.

Collectives™ on Stack Overflow

Create an aws integration in Http API using AWS CDK

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related