Redirects and rewrites example reference

This section includes example code for a variety of common redirect scenarios. You can use these examples to understand the syntax for creating your own redirects and rewrites.

Simple redirects and rewrites

You can use the following example code to permanently redirect a specific page to a new address.

^{JSON [{"source": "/original.html", "status": "301", "target": "/destination.html", "condition": null}]}

You can use the following example code to redirect any path under a folder to the same path under a different folder.

^{JSON [{"source": "/docs/<*>", "status": "301", "target": "/documents/<*>", "condition": null}]}

You can use the following example code to redirect all traffic to index.html as a rewrite. In this scenario, the rewrite makes it appear to the user that they have arrived at the original address.

^{JSON [{"source": "/<*>", "status": "200", "target": "/index.html", "condition": null}]}

You can use the following example code to use a rewrite to change the subdomain that appears to the user.

^{JSON [{"source": "https://mydomain.com", "status": "200", "target": "https://www.mydomain.com", "condition": null}]}

You can use the following example code to redirect to a different domain with a path prefix.

^{JSON [{"source": "https://mydomain.com", "status": "302", "target": "https://www.mydomain.com/documents/", "condition": null}]}

You can use the following example code to redirect paths under a folder that can’t be found to a custom 404 page.

^{JSON [{"source": "/<*>", "status": "404", "target": "/404.html", "condition": null}]}

Redirects for single page web apps (SPA)

Most SPA frameworks support HTML5 history.pushState() to change browser location without initiating a server request. This works for users who begin their journey from the root (or /index.html), but fails for users who navigate directly to any other page.

The following example uses regular expressions to set up a 200 rewrite for all files to index.html, except for the file extensions specified in the regular expression.

^{JSON [{"source": "</^[^.]+$|\.(?!(css|gif|ico|jpg|js|png|txt|svg|woff|woff2|ttf|map|json|webp)$)([^.]+$)/>", "status": "200", "target": "/index.html", "condition": null}]}

Reverse proxy rewrite

The following example uses a rewrite to proxy content from another location so that it appears to the user that the domain hasn’t changed.

^{JSON [{"source": "/images/<*>", "status": "200", "target": "https://images.otherdomain.com/<*>", "condition": null}]}

Trailing slashes and clean URLs

To create clean URL structures like about instead of about.html, static site generators such as Hugo generate directories for pages with an index.html (/about/index.html). Amplify automatically creates clean URLs by adding a trailing slash when required. The table below highlights different scenarios:

Placeholders

You can use the following example code to redirect paths in a folder structure to a matching structure in another folder.

^{JSON [{"source": "/docs/<year>/<month>/<date>/<itemid>", "status": "301", "target": "/documents/<year>/<month>/<date>/<itemid>", "condition": null}]}

Query strings and path parameters

You can use the following example code to redirect a path to a folder with a name that matches the value of a query string element in the original address:

^{JSON [{"source": "/docs?id=<my-blog-id-value>", "status": "301", "target": "/documents/<my-blog-id-value>", "condition": null}]}

You can use the following example code to redirect all paths that can’t be found at a given level of a folder structure to index.html in a specified folder.

^{JSON [{"source": "/documents/<x>/<y>/<z>", "status": "404", "target": "/documents/index.html", "condition": null}]}

Region-based redirects

You can use the following example code to redirect requests based on region.

^{JSON [{"source": "/documents", "status": "302", "target": "/documents/us/", "condition": "<US>"}]}

Using wildcard expressions in redirects and rewrites

You can use the wildcard expression, <*>, in the original address for a redirect or rewrite. You must place the expression at the end of the original address, and it must be unique. Amplify ignores original addresses that include more than one wildcard expression, or use it in a different placement.

The following is an example of a valid redirect with a wildcard expression.

The following two examples demonstrate invalid redirects with wildcard expressions.