Skip to content

Latest commit

 

History

History
 
 

apigw-rest-api-eventbridge-terraform

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

API Gateway REST API to EventBridge

This template creates an API Gateway REST API that puts an event to Amazon EventBridge. This pattern addresses some nuances with defining the VTL template mapping when integrating with EventBridge. An IAM permission for putting events to EventBridge is created for API Gateway.

Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/apigateway-rest-eventbridge-terraform

Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

  • Create an AWS account if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
  • AWS CLI installed and configured
  • Git Installed
  • Terraform installed

Deployment Instructions

  1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:
    git clone https://github.com/aws-samples/serverless-patterns
    
  2. Change directory to the pattern directory:
    cd serverless-patterns/apigateway-rest-eventbridge-terraform
    
  3. From the command line, initialize terraform to download and install the providers defined in the configuration:
    terraform init
    
  4. From the command line, apply the configuration in the main.tf file:
    terraform apply
    
  5. During the prompts:
    • Enter yes
  6. Note the outputs from the deployment process, these contain the resource names and/or ARNs which are used for testing.

How it works

This pattern creates an Amazon API gateway REST API endpoint. The endpoint uses service integrations to directly connect to Amazon EventBridge.

Testing

To test the endpoint first send data using the following command. Be sure to update the endpoint with endpoint of your stack.

curl --location --request POST '<your api endpoint>'/orders --header 'Content-Type: application/json' \
--data-raw '{ "items":[ {"Detail":"{\"data\":\"Order is created\"}", "DetailType":"Test", "Source":"com.inv.order"}]}'

Check the cloudwatch log group to see additional details on the event.

Cleanup

  1. Change directory to the pattern directory:
    cd serverless-patterns/apigateway-rest-eventbridge-terraform
    
  2. Delete all created resources
    terraform destroy
  3. During the prompts:
    • Enter yes
  4. Confirm all created resources has been deleted
    terraform show

Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0