You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 20, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/providers/mappings/aws/apis.mdx
+29Lines changed: 29 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,3 +28,32 @@ During deployment the Nitric CLI builds your API's routes, methods and handlers:
28
28
- Lambda ARNs are injected into the API definition using the [x-amazon-apigateway-integration object](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html), creating an [API Gateway Integration](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/) for each.
29
29
- The API definition is deployed as an API Gateway v2 HTTP API, using the `$default` stage name
30
30
- IAM policies are created enabling API Gateway to execute the Lambdas
31
+
32
+
### Custom Domain Prerequisites
33
+
34
+
To support custom domains with APIs deployed to AWS your domain (or subdomain) will need to be setup as a [hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html) in Route 53.
35
+
36
+
The general steps to setup a hosted zone in Route 53 are as follows:
37
+
38
+
1. Navigate to Route 53 in the AWS Console
39
+
2. Select 'hosted zones' from the left navigation
40
+
3. Click 'Create hosted zone'
41
+
4. Enter your domain name and choose the 'Public hosted zone' type.
42
+
5. Click 'Create hosted zone'
43
+
6. You will now be provided with a set of NS DNS records to configure in the DNS provider for your domain
44
+
7. Create the required DNS records, then wait for the DNS changes to propagate
45
+
46
+
Once this is done you will be able to use the hosted zone domain or any direct subdomain with your Nitric APIs.
47
+
48
+
You can read more about how AWS suggests configuring hosted zones in their documentation on [Making Route 53 the DNS service for a domain that's in use](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/migrate-dns-domain-in-use.html) or [Making Route 53 the DNS service for an inactive domain](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/migrate-dns-domain-inactive.html).
49
+
50
+
<Note>
51
+
If the hosted zone was nitric.io, nitric.io or api.nitric.io would be
52
+
supported for APIs, but not public.api.nitric.io since that is a subdomain of
53
+
a subdomain.
54
+
</Note>
55
+
56
+
<Note>
57
+
DNS propagation of the NS records can take a few seconds to a few hours due to
0 commit comments