https://github.com/massdriver-cloud/aws-apigateway-rest-api
https://github.com/massdriver-cloud/aws-apigateway-rest-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/aws-apigateway-rest-api
- Owner: massdriver-cloud
- Created: 2023-01-18T18:33:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T19:11:17.000Z (9 months ago)
- Last Synced: 2025-01-23T03:13:43.122Z (5 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 39.1 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# aws-apigateway-rest-api
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
Serverless Rest API which can be integrated with various AWS services
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`dns`** *(object)*: Configuration to enable custom DNS and SSL Certs.
- **`enabled`** *(boolean)*: Enabling this option will allow you to define DNS for your API Gateway. Default: `True`.
- **`monitoring`** *(object)*
- **`mode`** *(string)*: Enable and customize APIGateway metric alarms. Default: `AUTOMATED`.
- **One of**
- Automated
- Custom
- Disabled
- **`rest_api`** *(object)*: API GATEWAY general configuration.
- **`endpoint_configuration`** *(string)*: API Gateways can be region bound, or edge optimized which will create a global presence. Must be one of: `['EDGE', 'REGIONAL']`.
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
- **`stage_name`** *(string)*: Deployments of API gateway are tied to a stage. Default: `live`.
## Examples
```json
{
"__name": "Wizard",
"dns": {
"enabled": false
},
"monitoring": {
"mode": "AUTOMATED"
},
"rest_api": {
"endpoint_configuration": "REGIONAL",
"region": "us-west-2",
"stage_name": "live"
}
}
```
```json
{
"__name": "Edge Optimized",
"rest_api": {
"endpoint_configuration": "EDGE"
}
}
```
```json
{
"__name": "Regional",
"rest_api": {
"endpoint_configuration": "REGIONAL"
}
}
```
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`aws_authentication`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`external_id`** *(string)*: An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
- **`api_gateway`** *(object)*: AWS API Gateway and it's Default Stage. Cannot contain additional properties.
- **`data`** *(object)*
- **`infrastructure`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name format for API Gateway and related resources.
Examples:
```json
"arn:partition:apigateway:region::/restapis/api-id"
```
```json
"arn:partition:apigateway:region::/restapis/api-id/stages/stage-id"
```
- **`root_resource_id`** *(string)*: Id of the API Gateway resource at the '/' route.
- **`stage_arn`** *(string)*: Amazon Resource Name format for API Gateway and related resources.
Examples:
```json
"arn:partition:apigateway:region::/restapis/api-id"
```
```json
"arn:partition:apigateway:region::/restapis/api-id/stages/stage-id"
```
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/aws-apigateway-rest-api/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/issues
[release_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/aws-apigateway-rest-api.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/aws-apigateway-rest-api/blob/main/LICENSE
[email_url]: mailto:[email protected]
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:[email protected]
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-apigateway-rest-api&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500