Repository navigation
Configure API GateWay 1box Endpoints
Alex edited this page Mar 4, 2019
·
1 revision
Configure API Gateway with custom domain names and SSL for all endpoints in the 1box environment.
- Use AWS Certificate Manager (ACM) to request a certificate for the desired custom domain name(s).
- Once the certificate(s) have been issued in ACM navigate to API Gateway.
- In API Gateway go to the Custom Domain Names link and click the blue "Create Custom Domain Name" button.
- Enter the desired custom domain name, select the appropriate certificate for that custom domain name, choose HTTP or WebSocket, and Edge Optimized or Regional - then click save.
- Once created, select "Show Base Path Mappings" or "Edit" then click "Add mapping".
- Name the Path, select the desired API, and the desired API's stage then click save.
- The last step is to create an alias record in Route 53 of type CNAME which points to the custom domain name's Target Domain Name created by AWS.
- For more detailed step-by-step instructions see this wiki
- 1box environment custom domain name format: [team]-[firstnamelastinitial].2edusite.com
Example: api-alexc.2edusite.com
- All custom domain names for API Gateway require a valid certificate and cannot be created without one.
- ACM certificate requests need to be verified via email or DNS. You may need help with this step as you may not have access to either the email inboxes or Route 53 to verify with DNS.
- Due to having SSL, all regional API Gateway custom domains require https:// to work and will return an error with http://.
- If using Regional APIs all resources and certificates must be in the same region.
- If using Edge Optimized APIs the certificate must be issued from US East-1.
- Similar to verifying ownership in ACM, to complete the last step above you may need help here as well since it requires Route 53 access.
- This wiki is specific to creating custom domain names for API Gateway APIs and does not include details on setting up APIs, Lambda functions, or DynamoDB.