API Gateway Models are defined using JSON Schema. You can reference a Model inside another Model using the $ref
field. If you are familiar with the OpenAPI Specification fka Swagger, you may have seen something like this:
{ |
To make model references work with API Gateway, you need to provide an absolute reference that is predefined by AWS: https://apigateway.amazonaws.com/restapis/$ApiId/models/$ModelName
Let’s translate this to a CloudFormation template:
{ |
That’s it. Now you can build sophisticated API Gateway models that reference each other in CloudFormation.
Read more:
- CloudFormation vs Engineers: How to protect your CloudFormation managed AWS account from human intervention
- A look at DynamoDB
- Cloud adaption strategy: event-based data synchronization
- Master the MB-220 Certification: Unlock Advanced Marketing Insights in 2025
- Builder’s Diary Vol. 4: Serverless Software Engineering