Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amplify-console-ug-021	amplify-console-ug.pdf	21	FrameworkMetadata object's properties. Key name Type String Required Description Yes The name of the framework. Deployment speciﬁcation 56 AWS Amplify Hosting Key version Type String Required Description User Guide Yes The version of the framework. It must be a valid semantic versioning (semver) string. Best practices for conﬁguring routing rules Routing rules provide a mechanism for routing incoming request paths to speciﬁc targets in the deployment bundle. In a deployment bundle, framework authors can emit ﬁles to the build output that are deployed to either of the following targets: • Static assets primitive – Files are contained in the .amplify-hosting/static directory. • Compute primitive – Files are contained in the .amplify-hosting/compute/default directory. Framework authors also provide an array of routing rules in the deploy manifest ﬁle. Each rule in the array is matched against the incoming request in sequential traversal order, until there’s a match. When there’s a matching rule, the request is routed to the target speciﬁed in the matching rule. Optionally, a fallback target can be speciﬁed for each rule. If the original target returns a 404 error, the request is routed to the fallback target. The deployment speciﬁcation requires the last rule in the traversal order to be a catch-all rule. A catch-all rule is speciﬁed with the /* path. If the incoming request doesn't match with any of the previous routes in the routing rules array, the request is routed to the catch-all rule target. For SSR frameworks like Nuxt.js, the catch-all rule target has to be the compute primitive. This is because SSR applications have server-side rendered pages with routes that aren't predictable at build time. For example, if a Nuxt.js application has a page at /blog/[slug] where [slug] is a dynamic route parameter. The catch-all rule target is the only way to route requests to these pages. In contrast, speciﬁc path patterns can be used to target routes that are known at build time. For example, Nuxt.js serves static assets from the /_nuxt path. This means that the /_nuxt/* path can be targeted by a speciﬁc routing rule that routes requests to the static assets primitive. Deployment speciﬁcation 57 AWS Amplify Hosting Public folder routing User Guide Most SSR frameworks provide the ability to serve mutable static assets from a public folder. Files like favicon.ico and robots.txt are typically kept inside the public folder and are served from the application's root URL. For example, the favicon.ico ﬁle is served from https:// example.com/favicon.ico. Note that there is no predictable path pattern for these ﬁles. They are almost entirely dictated by the ﬁle name. The only way to target ﬁles inside the public folder is to use the catch-all route. However, the catch-all route target has to be the compute primitive. We recommend one of the following approaches for managing your public folder. 1. Use a path pattern to target request paths that contain ﬁle extensions. For example, you can use /. to target all request paths that contain a ﬁle extension. Note that this approach can be unreliable. For example, if there are ﬁles without ﬁle extensions inside the public folder, they are not targeted by this rule. Another issue to be aware of with this approach is that the application could have pages with periods in their names. For example, a page at /blog/2021/01/01/hello.world will be targeted by the /. rule. This is not ideal since the page is not a static asset. However, you can add a fallback target to this rule to ensure that when there is a 404 error from the static primitive, the request falls back to the compute primitive. { "path": "/.", "target": { "kind": "Static" }, "fallback": { "kind": "Compute", "src": "default" } } 2. Identify the ﬁles in the public folder at build time and emit a routing rule for each ﬁle. This approach is not scalable since there is a limit of 25 rules imposed by the deployment speciﬁcation. { "path": "/favicon.ico", "target": { "kind": "Static" Deployment speciﬁcation 58 AWS Amplify Hosting } }, { "path": "/robots.txt", "target": { "kind": "Static" } } User Guide 3. Recommend that your framework users store all mutable static assets inside a sub-folder inside the public folder. In the following example, the user can store all mutable static assets inside the public/assets folder. Then, a routing rule with the path pattern /assets/* can be used to target all mutable static assets inside the public/assets folder. { "path": "/assets/*", "target": { "kind": "Static" } } 4. Specify a static fallback for the catch-all route. This approach has drawbacks that are described in more detail in the next Catch-all fallback routing section. Catch-all fallback routing For SSR frameworks such as Nuxt.js, where a catch-all route is speciﬁed for the compute primitive target, framework authors might consider specifying a static fallback for the
amplify-console-ug-022	amplify-console-ug.pdf	22	example, the user can store all mutable static assets inside the public/assets folder. Then, a routing rule with the path pattern /assets/* can be used to target all mutable static assets inside the public/assets folder. { "path": "/assets/", "target": { "kind": "Static" } } 4. Specify a static fallback for the catch-all route. This approach has drawbacks that are described in more detail in the next Catch-all fallback routing section. Catch-all fallback routing For SSR frameworks such as Nuxt.js, where a catch-all route is speciﬁed for the compute primitive target, framework authors might consider specifying a static fallback for the catch-all route to solve the public folder routing problem. However, this type of routing rule breaks server-side rendered 404 pages. For example, if the end user visits a page that doesn't exist, the application renders a 404 page with a status code of 404. However, if the catch-all route has a static fallback, the 404 page isn't be rendered. Instead, the request falls back to the static primitive and still ends up with a 404 status code, but the 404 page isn't be rendered. { "path": "/", "target": { "kind": "Compute", "src": "default" Deployment speciﬁcation 59 AWS Amplify Hosting }, "fallback": { "kind": "Static" } } Base path routing User Guide Frameworks that oﬀer the ability to modify the base path of the application are expected to prepend the base path to the static assets inside the .amplify-hosting/static directory. For example, if the base path is /folder1/folder2, then the build output for a static asset called main.css will be .amplify-hosting/static/folder1/folder2/main.css. This means that the routing rules also need to be updated to reﬂect the base path. For example, if the base path is /folder1/folder2, then the routing rule for the static assets in the public folder will look like the following. { "path": "/folder1/folder2/.", "target": { "kind": "Static" } } Similarly, server-side routes also need to have the base path prepended to them. For example, if the base path is /folder1/folder2, then the routing rule for the /api route will look like the following. { "path": "/folder1/folder2/api/", "target": { "kind": "Compute", "src": "default" } } However, the base path should not be prepended to the catch-all route. For example, if the base path is /folder1/folder2, then the catch-all route will remain like the following. { "path": "/", Deployment speciﬁcation 60 AWS Amplify Hosting "target": { "kind": "Compute", "src": "default" } } Nuxt.js routes examples The following is an example deploy-manifest.json ﬁle for a Nuxt application that demonstrates how to specify routing rules. { "version": 1, "routes": [ { "path": "/_nuxt/image", "target": { "kind": "ImageOptimization", "cacheControl": "public, max-age=3600, immutable" } }, { "path": "/_nuxt/builds/meta/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { "path": "/_nuxt/builds/", "target": { "cacheControl": "public, max-age=1, immutable", "kind": "Static" } }, { "path": "/_nuxt/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { Deployment speciﬁcation User Guide 61 AWS Amplify Hosting User Guide "path": "/.", "target": { "kind": "Static" }, "fallback": { "kind": "Compute", "src": "default" } }, { "path": "/", "target": { "kind": "Compute", "src": "default" } } ], "computeResources": [ { "name": "default", "entrypoint": "server.js", "runtime": "nodejs18.x" } ], "framework": { "name": "nuxt", "version": "3.8.1" } } The following is an example deploy-manifest.json ﬁle for Nuxt that demonstrates how to specify routing rules including base paths. { "version": 1, "routes": [ { "path": "/base-path/_nuxt/image", "target": { "kind": "ImageOptimization", "cacheControl": "public, max-age=3600, immutable" } }, Deployment speciﬁcation 62 AWS Amplify Hosting { "path": "/base-path/_nuxt/builds/meta/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" User Guide } }, { "path": "/base-path/_nuxt/builds/", "target": { "cacheControl": "public, max-age=1, immutable", "kind": "Static" } }, { "path": "/base-path/_nuxt/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { "path": "/base-path/.", "target": { "kind": "Static" }, "fallback": { "kind": "Compute", "src": "default" } }, { "path": "/", "target": { "kind": "Compute", "src": "default" } } ], "computeResources": [ { "name": "default", "entrypoint": "server.js", "runtime": "nodejs18.x" Deployment speciﬁcation 63 AWS Amplify Hosting } ], "framework": { "name": "nuxt", "version": "3.8.1" } } User Guide For more information about using the routes attribute, see Using the routes attribute. Deploying an Express server using the deployment manifest This example explains how to deploy a basic Express server using the Amplify Hosting deployment speciﬁcation. You can leverage the provided deployment manifest to specify routing, compute resources, and other conﬁgurations. Set up an Express server locally before deploying to Amplify Hosting 1. Create a new directory for your project and install Express and Typescript. mkdir express-app cd express-app # The following command will prompt you for information about your project npm init # Install express, typescript and types npm install express --save npm install typescript ts-node @types/node @types/express --save-dev 2. Add a tsconfig.json ﬁle to the root of your project with the following
amplify-console-ug-023	amplify-console-ug.pdf	23	to deploy a basic Express server using the Amplify Hosting deployment speciﬁcation. You can leverage the provided deployment manifest to specify routing, compute resources, and other conﬁgurations. Set up an Express server locally before deploying to Amplify Hosting 1. Create a new directory for your project and install Express and Typescript. mkdir express-app cd express-app # The following command will prompt you for information about your project npm init # Install express, typescript and types npm install express --save npm install typescript ts-node @types/node @types/express --save-dev 2. Add a tsconfig.json ﬁle to the root of your project with the following contents. { "compilerOptions": { "target": "es6", "module": "commonjs", "outDir": "./dist", "strict": true, "esModuleInterop": true, "skipLibCheck": true, "forceConsistentCasingInFileNames": true Deploying an Express server 64 AWS Amplify Hosting }, "include": ["src/*/.ts"], "exclude": ["node_modules"] } User Guide 3. Create a directory named src in your project root. 4. Create an index.ts ﬁle in the src directory. This will be the entry point to the application that starts an Express server. The server should be conﬁgured to listen on port 3000. // src/index.ts import express from 'express'; const app: express.Application = express(); const port = 3000; app.use(express.text()); app.listen(port, () => { console.log(`server is listening on ${port}`); }); // Homepage app.get('/', (req: express.Request, res: express.Response) => { res.status(200).send("Hello World!"); }); // GET app.get('/get', (req: express.Request, res: express.Response) => { res.status(200).header("x-get-header", "get-header-value").send("get-response- from-compute"); }); //POST app.post('/post', (req: express.Request, res: express.Response) => { res.status(200).header("x-post-header", "post-header- value").send(req.body.toString()); }); //PUT app.put('/put', (req: express.Request, res: express.Response) => { res.status(200).header("x-put-header", "put-header- value").send(req.body.toString()); }); Deploying an Express server 65 AWS Amplify Hosting User Guide //PATCH app.patch('/patch', (req: express.Request, res: express.Response) => { res.status(200).header("x-patch-header", "patch-header- value").send(req.body.toString()); }); // Delete app.delete('/delete', (req: express.Request, res: express.Response) => { res.status(200).header("x-delete-header", "delete-header-value").send(); }); 5. Add the following scripts to your package.json ﬁle. "scripts": { "start": "ts-node src/index.ts", "build": "tsc", "serve": "node dist/index.js" } 6. Create a directory named public in the root of your project. Then create a ﬁle named hello- world.txt with the following contents. Hello world! 7. Add a .gitignore ﬁle to your project root with the following contents. .amplify-hosting dist node_modules Set up the Amplify deployment manifest 1. Create a ﬁle named deploy-manifest.json in your project's root directory. 2. Copy and paste the following manifest into your deploy-manifest.json ﬁle. { "version": 1, "framework": { "name": "express", "version": "4.18.2" }, "imageSettings": { "sizes": [ Deploying an Express server 66 User Guide AWS Amplify Hosting 100, 200, 1920 ], "domains": [], "remotePatterns": [], "formats": [], "minimumCacheTTL": 60, "dangerouslyAllowSVG": false }, "routes": [ { "path": "/_amplify/image", "target": { "kind": "ImageOptimization", "cacheControl": "public, max-age=3600, immutable" } }, { "path": "/.", "target": { "kind": "Static", "cacheControl": "public, max-age=2" }, "fallback": { "kind": "Compute", "src": "default" } }, { "path": "/", "target": { "kind": "Compute", "src": "default" } } ], "computeResources": [ { "name": "default", "runtime": "nodejs18.x", "entrypoint": "index.js" } ] Deploying an Express server 67 AWS Amplify Hosting } User Guide The manifest describes how Amplify Hosting should handle the deployment of your application. The primary settings are the following. • version – Indicates the version of the deployment speciﬁcation that you're using. • framework – Adjust this to specify your Express server setup. • imageSettings – This section is optional for an Express server unless you're handling image optimization. • routes – These are critical for directing traﬃc to the right parts of your app. The "kind": "Compute" route directs traﬃc to your server logic. • computeResources – Use this section to specify your Express server's runtime and entry point. Next, set up a post-build script that moves the built application artifacts into the .amplify- hosting deployment bundle. The directory structure aligns with the Amplify Hosting deployment speciﬁcation. Set up the post-build script 1. Create a directory named bin in your project root. 2. Create a ﬁle named postbuild.sh in the bin directory. Add the following contents to the postbuild.sh ﬁle. #!/bin/bash rm -rf ./.amplify-hosting mkdir -p ./.amplify-hosting/compute cp -r ./dist ./.amplify-hosting/compute/default cp -r ./node_modules ./.amplify-hosting/compute/default/node_modules cp -r public ./.amplify-hosting/static cp deploy-manifest.json ./.amplify-hosting/deploy-manifest.json 3. Add a postbuild script to your package.json ﬁle. The ﬁle should look like the following. Deploying an Express server 68 AWS Amplify Hosting User Guide "scripts": { "start": "ts-node src/index.ts", "build": "tsc", "serve": "node dist/index.js", "postbuild": "chmod +x bin/postbuild.sh && ./bin/postbuild.sh" } 4. Run the following command to build your application. npm run build 5. (Optional) Adjust your routes for Express. You can modify the routes in your deployment manifest to ﬁt your Express server. For example, if you don't have any static assets in the public directory, you might only need the catch-all route "path": "/" directing to Compute. This will depend on your server's setup. Your ﬁnal directory structure should look like the following. express-app/ ### .amplify-hosting/ # ### compute/ # # ### default/ # # ### node_modules/ # # ### index.js
amplify-console-ug-024	amplify-console-ug.pdf	24	dist/index.js", "postbuild": "chmod +x bin/postbuild.sh && ./bin/postbuild.sh" } 4. Run the following command to build your application. npm run build 5. (Optional) Adjust your routes for Express. You can modify the routes in your deployment manifest to ﬁt your Express server. For example, if you don't have any static assets in the public directory, you might only need the catch-all route "path": "/" directing to Compute. This will depend on your server's setup. Your ﬁnal directory structure should look like the following. express-app/ ### .amplify-hosting/ # ### compute/ # # ### default/ # # ### node_modules/ # # ### index.js # ### static/ # # ### hello.txt # ### deploy-manifest.json ### bin/ # ### .amplify-hosting/ # # ### compute/ # # # ### default/ # # ### static/ # ### postbuild.sh ### dist/ # ### index.js ### node_modules/ ### public/ # ### hello.txt ### src/ # ### index.ts ### deploy-manifest.json Deploying an Express server 69 AWS Amplify Hosting ### package.json ### package-lock.json ### tsconfig.json Deploy your server User Guide 1. Push your code to your Git repository and then deploy your app to Amplify Hosting. 2. Update your build settings to point baseDirectory to .amplify-hosting as follows. During the build, Amplify will detect the manifest ﬁle in the .amplify-hosting directory and deploy your Express server as conﬁgured. version: 1 frontend: phases: preBuild: commands: - nvm use 18 - npm install build: commands: - npm run build artifacts: baseDirectory: .amplify-hosting files: - '*/' 3. To verify that your deployment was successful and that your server is running correctly, visit your app at the default URL provided by Amplify Hosting. Image optimization integration for framework authors Framework authors can integrate Amplify's image optimization feature by using the Amplify Hosting deployment speciﬁcation. To enable image optimization, your deployment manifest must contain a routing rule that targets the image optimization service. The following example demonstrates how to conﬁgure the routing rule. // .amplify-hosting/deploy-manifest.json { "routes": [ Image optimization for framework authors 70 AWS Amplify Hosting { "path": "/images/", "target": { "kind": "ImageOptimization", "cacheControl": "public, max-age=31536000, immutable" User Guide } } ] } For more information about conﬁguring image optimization settings using the deployment speciﬁcation, see Using the Amplify Hosting deployment speciﬁcation to conﬁgure build output . Understanding the Image optimization API Image optimization can be invoked at runtime via an Amplify app's domain URL, at the path deﬁned by the routing rule. GET https://{appDomainName}/{path}?{queryParams} Image optimization imposes the following rules on images. • Amplify can't optimize GIF, APNG and SVG formats or convert them to another format. • SVG images aren't served unless the dangerouslyAllowSVG setting is enabled. • The width or height of a source images can't exceed 11 MB or 9,000 pixels. • The size limit of an optimized image is 4 MB. • HTTPS is the only protocol supported for sourcing images with remote URLs. HTTP headers The Accept request HTTP header is used to specify the image formats, expressed as MIME types, allowed by the client (usually a web browser). The image optimization service will attempt to convert the image to the speciﬁed format. The value speciﬁed for this header will have a higher priority than the format query parameter. For example, a valid value for the Accept header is image/png, image/webp, /* . The formats setting speciﬁed in the Amplify deployment manifest will restrict the formats to those in the list. Even if the Accept header asks for a speciﬁc format, it will be ignored if the format isn't in the allow list. Image optimization for framework authors 71 AWS Amplify Hosting URI request parameters User Guide The following table describes the URI request parameters for Image optimization. Query parameter Type Required Description Example url String Yes width Number Yes height Number No A relative path or absolute URL to the source image. For a remote URL, ?url=http s%3A%2F%2 Fwww.exam ple.com%2 Fbuffalo. only the https png ?width=800 ?height=600 protocol is supported. Value must be URL encoded. The width in pixels of the optimized image. The height in pixels of the optimized image. If not speciﬁed, the image will be auto scaled to match the width. ﬁt Enum values: No cover, contain, fill, inside, outside How the image is resized to ﬁt the speciﬁed width and height. ?width=80 0&height= 600&fit=c over Image optimization for framework authors 72 AWS Amplify Hosting Query parameter Type Required Description Example User Guide position Enum values: No center, top, right, bottom, left trim Number No extend Object No ?fit=cont ain&posit ion=centre ?trim=50 ?extend=1 0_0_5_0 A position to be used when ﬁt is cover or contain. Trims pixels from all edges that contain values similar to the speciﬁed background color of the top- left pixel. Adds pixels to the edges of the image using the color derived from the nearest edge pixels. The format is {top}_{ri
amplify-console-ug-025	amplify-console-ug.pdf	25	to ﬁt the speciﬁed width and height. ?width=80 0&height= 600&fit=c over Image optimization for framework authors 72 AWS Amplify Hosting Query parameter Type Required Description Example User Guide position Enum values: No center, top, right, bottom, left trim Number No extend Object No ?fit=cont ain&posit ion=centre ?trim=50 ?extend=1 0_0_5_0 A position to be used when ﬁt is cover or contain. Trims pixels from all edges that contain values similar to the speciﬁed background color of the top- left pixel. Adds pixels to the edges of the image using the color derived from the nearest edge pixels. The format is {top}_{ri ght}_{bot tom}_{lef t} where each value is the number of pixels to add. Image optimization for framework authors 73 AWS Amplify Hosting Query parameter Type Required Description Example User Guide extract Object No Crops the image to the speciﬁed ?extract= 10_0_5_0 rectangle delimited by top, left, width and height. The format is {left}_{t op}_{widt h}_{right} where each value is the number of pixels to crop. The desired output format for the optimized image. The quality of the image, from 1 to 100. Only used when converting the format of the image. Rotates the image by the speciﬁed angle in number of degrees. ?format=w ebp ?quality=50 ?rotate=45 format String No quality Number No rotate Number No Image optimization for framework authors 74 AWS Amplify Hosting Query parameter Type Required Description Example User Guide ﬂip Boolean No ﬂop Boolean No sharpen Number No median Number No ?flip ?flop ?sharpen=1 ?sharpen=3 Mirrors the image verticall y (up-down) on the x-axis. This always occurs before rotation, if any. Mirrors the image horizonta lly (left-right) on the y-axis. This always occurs before rotation, if any. Sharpenin g enhances the deﬁnitio n of edges in the image. Valid values are between 0.000001 and 10. Applies a median ﬁlter. This removes noise or smoothes the edges of an image. Image optimization for framework authors 75 AWS Amplify Hosting Query parameter Type Required Description Example User Guide blur Number No gamma Number No negate Boolean No normalize Boolean No ?blur=20 ?gamma=1 ?negate ?normalize Applies a Gaussian blur of the speciﬁed sigma. Valid values are from 0.3 to 1,000. Applies a gamma correctio n to improve the perceived brightness of a resized image. Value must be between 1.0 and 3.0. Inverts the colors of the image. Enhances image contrast by stretching its luminance to cover a full dynamic range. Image optimization for framework authors 76 AWS Amplify Hosting Query parameter Type Required Description Example User Guide threshold Number No tint String No grayscale Boolean No ?threshol d=155 ?tint=#77 43CE ?grayscale Replaces any pixel in the image with a black pixel, if its intensity is less than the speciﬁed threshold. Or with a white pixel if it's greater than the threshold. Valid values are between 0 and 255. Tints the image using the provided RGB while preservin g the image luminance. Turns the image into grayscale (black and white). Response status codes The following list describes the response status codes for image optimization. Success - HTTP status code 200 The request was fullﬁlled successfully. Image optimization for framework authors 77 AWS Amplify Hosting User Guide BadRequest - HTTP status code 400 • An input query parameter was speciﬁed incorrectly. • The remote URL is not listed as allowed in the remotePatterns setting. • The remote URL doesn't resolve to an image. • The requested width or height are not listed as allowed in the sizes setting. • The image requested is SVG but the dangerouslyAllowSvg setting is disabled. Not Found - HTTP status code 404 The source image was not found. Content too large - HTTP status code 413 Either the source image or the optimized image exceed the maximum allowed size in bytes. Understanding optimized image caching Amplify Hosting caches optimized images on our CDN so that subsequent requests to the same image, with the same query parameters, are served from the cache. The cache Time to live (TTL) is controlled by the Cache-Control header. The following list describes your options for specifying the Cache-Control header. • Using the Cache-Control key within the routing rule that targets image optimization. • Using custom headers deﬁned in the Amplify app. • For remote images, the Cache-Control header returned by the remote image is honored. The minimumCacheTTL speciﬁed in the image optimization settings deﬁnes the lower bound of the Cache-Control max-age directive. For example, if a remote image URL responds with a Cache- Control s-max-age=10, but the value of minimumCacheTTL is 60, then 60 is used. Using open source adapters for any SSR framework You can use any SSR framework build adapter that has been created for integration with Amplify Hosting. Each framework that oﬀers an adapter determines how the adapter is conﬁgured and connected to their build process. Typically, you will
amplify-console-ug-026	amplify-console-ug.pdf	26	For remote images, the Cache-Control header returned by the remote image is honored. The minimumCacheTTL speciﬁed in the image optimization settings deﬁnes the lower bound of the Cache-Control max-age directive. For example, if a remote image URL responds with a Cache- Control s-max-age=10, but the value of minimumCacheTTL is 60, then 60 is used. Using open source adapters for any SSR framework You can use any SSR framework build adapter that has been created for integration with Amplify Hosting. Each framework that oﬀers an adapter determines how the adapter is conﬁgured and connected to their build process. Typically, you will install the adapter as an npm development dependency. After you create an app with a framework, use the framework's documentation to learn how to install the Amplify Hosting adapter and conﬁgure it in your application's conﬁguration ﬁle. Using open source adapters for any SSR framework 78 AWS Amplify Hosting User Guide Next, create an amplify.yml ﬁle in your project's root directory. In the amplify.yml ﬁle, set the baseDirectory to your application's build output directory. The framework runs the adapter during the build process to transform the output into the Amplify Hosting deployment bundle. The name of the build output directory can be anything, but the .amplify-hosting ﬁlename has signiﬁcance. Amplify ﬁrst looks for a directory deﬁned as the baseDirectory. If it exists, Amplify looks for the build output there. If the directory doesn't exist, Amplify looks for the build output inside .amplify-hosting, even if it has not been deﬁned by the customer. The following is an example of the build settings for an app. The baseDirectory is set to .amplify-hosting to indicate that the build output is in the .amplify-hosting folder. As long as the contents of the .amplify-hosting folder match the Amplify Hosting deployment speciﬁcation, the app will deploy successfully. version: 1 frontend: preBuild: commands: - npm install build: commands: - npm run build artifacts: baseDirectory: .amplify-hosting After your app is conﬁgured to use a framework adapter, you can deploy it to Amplify Hosting. For detailed instructions, see Deploying an SSR app to Amplify Using open source adapters for any SSR framework 79 AWS Amplify Hosting User Guide Deploying a static website to Amplify from an Amazon S3 bucket You can use the integration between Amplify Hosting and Amazon S3 to host static website content stored on S3 with just a few clicks. Deploying to Amplify Hosting provides you with the following beneﬁts and features. • Automatic deployment to the globally available AWS content delivery network (CDN) powered by CloudFront • HTTPS support • Easily connect your website to a custom domain using the Amplify console • Bring your own Custom SSL certiﬁcates • Monitor your website with built in access logs and CloudWatch metrics • Set up password protection for your website • Create redirect and rewrites rules in the Amplify console You can start the deployment process from the Amplify console, the AWS CLI, or the AWS SDKs. You can only deploy to Amplify from an Amazon S3 general purpose bucket located in your own account. Amplify doesn't support cross-account S3 bucket access. When you deploy your application from an Amazon S3 general purpose bucket to Amplify Hosting, AWS charges are based on Amplify's pricing model. For more information, see AWS Amplify Pricing. Important Amplify Hosting is not available in all of the AWS Regions where Amazon S3 is available. To deploy a static website to Amplify Hosting, the Amazon S3 general purpose bucket containing your website must be located in a region where Amplify is available. For the list of regions where Amplify is available, see Amplify endpoints in the Amazon Web Services General Reference. See the following topics to learn how to deploy and update a static website from Amazon S3 to Amplify Hosting. 80 AWS Amplify Hosting Topics User Guide • Deploying a static website from S3 using the Amplify console • Creating a bucket policy to deploy a static website from S3 using the AWS SDKs • Updating a static website deployed to Amplify from an S3 bucket • Updating an S3 deployment to use a bucket and preﬁx instead of a .zip ﬁle Deploying a static website from S3 using the Amplify console Use the following instructions to deploy a new static website from an Amazon S3 general purpose bucket using the Amplify console. To deploy a static website from an Amazon S3 general purpose bucket using the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose Create new app. 3. On the Start building with Amplify page, choose Deploy without Git. 4. Choose Next. 5. On the Start a manual deployment page, do the following. a. b. For App name, enter the name of your
amplify-console-ug-027	amplify-console-ug.pdf	27	console Use the following instructions to deploy a new static website from an Amazon S3 general purpose bucket using the Amplify console. To deploy a static website from an Amazon S3 general purpose bucket using the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose Create new app. 3. On the Start building with Amplify page, choose Deploy without Git. 4. Choose Next. 5. On the Start a manual deployment page, do the following. a. b. For App name, enter the name of your app. For Branch name, enter the name of the branch to deploy. For Method, choose Amazon S3. For the S3 location of objects to host, choose Browse. Select the Amazon S3 general purpose bucket to use, then select Choose preﬁx. 6. 7. 8. Choose Save and deploy. Creating a bucket policy to deploy a static website from S3 using the AWS SDKs You can use the AWS SDKs to deploy a static website from Amazon S3 to Amplify Hosting. If you deploy your website using an SDK, you must create your own bucket policy that grants Amplify Hosting permission to retrieve the objects in your S3 bucket. Deploying from the Amplify console 81 AWS Amplify Hosting User Guide To learn more about creating bucket policies, see Bucket policies for Amazon S3 in the Amazon Simple Storage Service User Guide. The following example bucket policy grants Amplify Hosting permissions to list buckets and retrieve bucket objects for the speciﬁed AWS account, Amplify application id, and branch. To use this example: • Replace amzn-s3-demo-website-bucket/prefix with the name of your website's bucket and preﬁx. • Replace 111122223333 with your AWS account id. • Replace region-id with the AWS Region that your Amplify application is located in, such as us-east-1. • Replace app_id with you Amplify application id. This information is available in the Amplify console. • Replace branch_name with your branch name. Note In your bucket policy, the aws:SourceArn must be a URL-encoded (percent-encoding) branch ARN. { "Version": "2008-10-17", "Statement": [ { "Sid": "AllowAmplifyToListPrefix_appid_branch_prefix_", "Effect": "Allow", "Principal": { "Service": "amplify.amazonaws.com" }, "Action": "s3:ListBucket", "Resource": "arn:aws:s3:::amzn-s3-demo-website-bucket/prefix/", "Condition": { "StringEquals": { "aws:SourceAccount": "111122223333", "aws:SourceArn": "arn%3Aaws%3Aamplify%3Aregion- id%3A111122223333%3Aapps%2Fapp_id%2Fbranches%2Fbranch_name", Creating a bucket policy to deploy using the SDKs 82 AWS Amplify Hosting User Guide "s3:prefix": "" } } }, { "Sid": "AllowAmplifyToReadPrefix__appid_branch_prefix_", "Effect": "Allow", "Principal": { "Service": "amplify.amazonaws.com" }, "Action": "s3:GetObject", "Resource": "arn:aws:s3:::amzn-s3-demo-website-bucket/prefix/", "Condition": { "StringEquals": { "aws:SourceAccount": "111122223333", "aws:SourceArn": "arn%3Aaws%3Aamplify%3Aregion- id%3A111122223333%3Aapps%2Fapp_id%2Fbranches%2Fbranch_name" } } }, { "Effect": "Deny", "Principal": "", "Action": "s3:", "Resource": "arn:aws:s3:::amzn-s3-demo-website-bucket/*", "Condition": { "Bool": { "aws:SecureTransport": "false" } } } ] } Updating a static website deployed to Amplify from an S3 bucket If you update any of the objects for a static website in general purpose S3 bucket hosted on Amplify, you must redeploy the application to Amplify Hosting to cause the changes to take eﬀect. Amplify Hosting doesn't automatically detect changes to the S3 bucket. We recommend that you use the AWS Command Line Interface (CLI) to update your website. Updating a static website deployed from an S3 bucket 83 AWS Amplify Hosting Sync updates to S3 User Guide After you make changes to your website's project ﬁles, use the following s3 sync command to synchronize the changes that you made to your local source directory with your target Amazon S3 general purpose bucket. To use this example, replace <source> with the name of your local directory and <target> with the name of your Amazon S3 bucket. aws s3 sync <source> <target> Redeploy the website to Amplify Hosting Use the following amplify start-deployment command to redeploy your updated application in an Amazon S3 bucket to Amplify Hosting. To use this example, replace <app_id> with the id of your Amplify application, <branch_name> with the name of your branch, and s3://amzn-s3-demo- website-bucket/prefix with your S3 bucket and preﬁx. . aws amplify start-deployment --app-id <app_id> --branch-name <branch_name> --source- url s3://amzn-s3-demo-website-bucket/prefix --source-url-type BUCKET_PREFIX Updating an S3 deployment to use a bucket and preﬁx instead of a .zip ﬁle If you already have an existing static website deployed to Amplify Hosting from a .zip ﬁle in an Amazon S3 general purpose bucket, you can update the application deployment to use the bucket name and preﬁx that contain the objects to host. This type of deployment eliminates the need to upload a separate ﬁle to your bucket that contains the zipped contents of the build output. To migrate a static website from a .zip ﬁle to the bucket contents 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the manually deployed app that you want to migrate from using a .zip ﬁle to using the application ﬁles directly. 3. On the application's
amplify-console-ug-028	amplify-console-ug.pdf	28	to use the bucket name and preﬁx that contain the objects to host. This type of deployment eliminates the need to upload a separate ﬁle to your bucket that contains the zipped contents of the build output. To migrate a static website from a .zip ﬁle to the bucket contents 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the manually deployed app that you want to migrate from using a .zip ﬁle to using the application ﬁles directly. 3. On the application's Overview page, choose Deploy updates. 4. On the Deploy updates page, for Method, choose Amazon S3. Updating an S3 deployment to use a bucket and preﬁx instead of a .zip ﬁle 84 AWS Amplify Hosting User Guide 5. For the S3 location of objects to host, choose Browse. Select the bucket to use, then select Choose preﬁx. 6. Choose Save and deploy. Updating an S3 deployment to use a bucket and preﬁx instead of a .zip ﬁle 85 AWS Amplify Hosting User Guide Deploying an application to Amplify without a Git repository Manual deployments enable you to publish your web app with Amplify Hosting without connecting a Git provider. You can drag and drop a zipped folder from your desktop and host your site in seconds. Alternatively, you can reference assets in an Amazon S3 bucket or specify a public URL to the location where your ﬁles are stored. Note Manual deployments have a maximum .zip ﬁle size limit of 5GB due to Amazon S3 copy operation constraints. If any of your build artifacts exceed this size, consider breaking them into smaller archives or using an alternative deployment method. For Amazon S3, you can also set up AWS Lambda triggers to update your site each time new assets are uploaded. See the Deploy ﬁles stored on Amazon S3, Dropbox, or your Desktop to the AWS Amplify console blog post for more details about setting up this scenario. Amplify Hosting does not support manual deploys for server-side rendered (SSR) apps. For more information, see Deploying server-side rendered applications with Amplify Hosting. Drag and drop manual deployments To manually deploy an app using drag and drop 1. 2. Sign in to the AWS Management Console and open the Amplify console. In the upper right corner, choose Create new app. 3. On the Start building with Amplify page, choose Deploy without Git. Then, choose Next. 4. On the Start a manual deployment page, for App name, enter the name of your app. 5. 6. 7. For Branch name, enter a meaningful name, such as development or production. For Method, choose Drag and drop. Either drag and drop a folder from your desktop onto the drop zone or use Choose .zip folder to select the ﬁle from your computer. The ﬁle that you drag and drop or select must be a a zipped folder that contains the contents of your build output. Drag and drop manual deployments 86 AWS Amplify Hosting 8. Choose Save and deploy. User Guide Amazon S3 or URL manual deployment Note If you are deploying a static website from S3, the following procedure requires that you upload a zipped folder with the contents of your build output to your S3 bucket. We recommend that you deploy a static website directly from S3 using the bucket name and preﬁx. For more information about this simpliﬁed process, see Deploying a static website to Amplify from an Amazon S3 bucket. To manually deploy an app from Amazon S3 or a public URL 1. 2. Sign in to the AWS Management Console and open the Amplify console. In the upper right corner, choose Create new app. 3. On the Start building with Amplify page, choose Deploy without Git. Then, choose Next. 4. On the Start a manual deployment page, for App name, enter the name of your app. 5. 6. 7. For Branch name, enter a meaningful name, such as development or production. For Method, choose either Amazon S3 or Any URL. The procedure for uploading your ﬁles depends on the upload method. • Amazon S3 a. For S3 location of objects to host, choose Browse S3. Then, select the name of the Amazon S3 bucket from the list. Access control lists (ACLs) must be enabled for the bucket you select. For more information, see Troubleshooting Amazon S3 bucket access for manual deployments. Select the name of the .zip ﬁle to deploy. Choose Choose preﬁx. b. c. • Any URL • For Resource URL, enter the URL to the .zip ﬁle to deploy. 8. Choose Save and deploy. Amazon S3 or URL manual deployment 87 AWS Amplify Hosting Note User Guide When you create the zipped folder, make sure you zip the contents of
amplify-console-ug-029	amplify-console-ug.pdf	29	choose Browse S3. Then, select the name of the Amazon S3 bucket from the list. Access control lists (ACLs) must be enabled for the bucket you select. For more information, see Troubleshooting Amazon S3 bucket access for manual deployments. Select the name of the .zip ﬁle to deploy. Choose Choose preﬁx. b. c. • Any URL • For Resource URL, enter the URL to the .zip ﬁle to deploy. 8. Choose Save and deploy. Amazon S3 or URL manual deployment 87 AWS Amplify Hosting Note User Guide When you create the zipped folder, make sure you zip the contents of your build output and not the top level folder. For example, if your build output generates a folder named “build” or “public”, ﬁrst navigate into that folder, select all of the contents, and zip it from there. If you do not do this, you will see an “Access Denied” error because the site's root directory will not be initialized properly. Troubleshooting Amazon S3 bucket access for manual deployments When you create an Amazon S3 bucket, you use its Amazon S3 Object Ownership setting to control whether access control lists (ACLs) are enabled or disabled for the bucket. To manually deploy an app to Amplify from an Amazon S3 bucket, ACLs must be enabled on the bucket. If you get an AccessControlList error when you deploy from an Amazon S3 bucket, the bucket was created with ACLs disabled and you must enable them in the Amazon S3 console. For instructions, see Setting Object Ownership on an existing bucket in the Amazon Simple Storage Service User Guide. Troubleshooting Amazon S3 bucket access for manual deployments 88 AWS Amplify Hosting User Guide Using IAM roles with Amplify applications An IAM role is an IAM identity with speciﬁc permissions. The role's permissions determine what the identity can and cannot do in AWS. You can create IAM roles in your AWS account and use them to delegate permissions to Amplify Hosting. To learn more about roles, see IAM roles in the IAM User Guide. You can use the following types of IAM roles to grant Amplify Hosting the permissions it needs to perform actions on your behalf or run compute code that accesses other AWS resources. IAM service role Amplify assumes this role to perform actions on your behalf. This role is required for applications with backend resources. IAM SSR Compute role Allows a server-side rendered (SSR) application to securely access speciﬁc AWS resources. IAM SSR CloudWatch Logs role When you deploy an SSR app, the app requires an IAM service role that Amplify assumes to allow Amplify to access Amazon CloudWatch Logs. Topics • Adding a service role with permissions to deploy backend resources • Adding an SSR Compute role to allow access to AWS resources • Adding a service role with permissions to access CloudWatch Logs Adding a service role with permissions to deploy backend resources Amplify requires permissions to deploy backend resources with your front end. You use a service role to accomplish this. A service role is the AWS Identity and Access Management (IAM) role that provides Amplify Hosting with permissions to deploy, create, and manage backends on your behalf. When you are creating a new app that requires an IAM service role, you can either allow Amplify Hosting to automatically create a service role for you or you can select an IAM role that you have Adding a service role to deploy backend resources 89 AWS Amplify Hosting User Guide already created. In this section, you will learn how to create an Amplify service role that has account administrative permissions and explicity allows direct access to resources that Amplify applications require to deploy, create, and manage backends. Creating an Amplify service role in the IAM console To create a service role 1. Open the IAM console and choose Roles from the left navigation bar, then choose Create role. 2. On the Select trusted entity page, choose AWS service. For Use case, select Amplify - Backend Deployment, then choose Next. 3. On the Add permissions page, choose Next. 4. On the Name, view, and create page, for Role name enter a meaningful name, such as AmplifyConsoleServiceRole-AmplifyRole. 5. Accept all the defaults and choose Create role. 6. Return to the Amplify console to attach the role to your app. • If you are in the process of deploying a new app, do the following: a. Refresh the list of service roles. b. Select the role you just created. For this example, it should look like AmplifyConsoleServiceRole-AmplifyRole. c. Choose Next and follow the steps to complete your app deployment. • If you have an existing app, do the following: a. In the navigation pane, choose App settings, then choose IAM roles. b. On the IAM roles page, in the Service role section, choose
amplify-console-ug-030	amplify-console-ug.pdf	30	and choose Create role. 6. Return to the Amplify console to attach the role to your app. • If you are in the process of deploying a new app, do the following: a. Refresh the list of service roles. b. Select the role you just created. For this example, it should look like AmplifyConsoleServiceRole-AmplifyRole. c. Choose Next and follow the steps to complete your app deployment. • If you have an existing app, do the following: a. In the navigation pane, choose App settings, then choose IAM roles. b. On the IAM roles page, in the Service role section, choose Edit. c. On the Service role page, select the role you just created from the Service role list. d. Choose Save. 7. Amplify now has permissions to deploy backend resources for your app. Editing a service role's trust policy to prevent confused deputy The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action. For more information, see Cross-service confused deputy prevention. Creating an Amplify service role in the IAM console 90 AWS Amplify Hosting User Guide Currently, the default trust policy for the Amplify-Backend Deployment service role enforces the aws:SourceArn and aws:SourceAccount global context condition keys to prevent against confused deputy. However, if you previously created an Amplify-Backend Deployment role in your account, you can update the role's trust policy to add these conditions to protect against confused deputy. Use the following example to restrict access to apps in your account. Replace the Region and application ID in the example with your own information. "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:amplify:us-east-1:123456789012:apps/*" }, "StringEquals": { "aws:SourceAccount": "123456789012" } } For instructions on editing the trust policy for a role using the AWS Management Console, see Modifying a role (console) in the IAM User Guide. Adding an SSR Compute role to allow access to AWS resources This integration, enables you to assign an IAM role to the Amplify SSR Compute service to allow your server-side rendered (SSR) application to securely access speciﬁc AWS resources based on the role's permissions. For example, you can allow your app's SSR compute functions to securely access other AWS services or resources, such as Amazon Bedrock or an Amazon S3 bucket, based on the permissions deﬁned in the assigned IAM role. The IAM SSR Compute role provides temporary credentials, eliminating the need to hardcode long-lived security credentials in environment variables. Using the IAM SSR Compute role aligns with the AWS security best practices of granting least-privilege permissions and using short-term credentials when possible. The instructions later in this section describe how to create a policy with custom permissions and attach the policy to a role. When you create the role, you must attach a custom trust policy that gives Amplify permission to assume the role. If the trust relationship isn't deﬁned correctly, you will get an error when you try to add the role. The following custom trust policy grants Amplify permission to assume the role. Adding an SSR Compute role 91 AWS Amplify Hosting User Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "Statement1", "Effect": "Allow", "Principal": { "Service": [ "amplify.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] } You can associate an IAM role in your AWS account with an existing SSR application using the Amplify console, AWS SDKs, or the AWS CLI. The role that you attach is automatically associated with the Amplify SSR compute service, granting it the permissions that you specify to access other AWS resources. As your application's needs change over time, you can modify the attached IAM role without redeploying your application. This provides ﬂexibility and reduces application downtime. Important You are responsible for conﬁguring your application to meet your security and compliance objectives. This includes managing your SSR Compute role, which should be conﬁgured to have the minimum set of permissions needed to support your use case. For more information, see Managing IAM SSR Compute role security. Creating an SSR Compute role in the IAM console Before you can attach an IAM SSR Compute role to an Amplify application, the role must already exist in your AWS account. In this section, you will learn how to create an IAM policy and attach it to a role that Amplify can assume to access speciﬁc AWS resources. We recommend that you follow the AWS best practice of granting least-privilege permissions when creating an IAM role. The IAM SSR Compute role is called only from SSR compute functions and therefore should only grant the permissions required to run the code. Creating an SSR Compute role in the IAM console 92 AWS Amplify Hosting User Guide You can use the AWS Management Console, AWS CLI, or SDKs to create policies in IAM. For more interformation, see Deﬁne
amplify-console-ug-031	amplify-console-ug.pdf	31	learn how to create an IAM policy and attach it to a role that Amplify can assume to access speciﬁc AWS resources. We recommend that you follow the AWS best practice of granting least-privilege permissions when creating an IAM role. The IAM SSR Compute role is called only from SSR compute functions and therefore should only grant the permissions required to run the code. Creating an SSR Compute role in the IAM console 92 AWS Amplify Hosting User Guide You can use the AWS Management Console, AWS CLI, or SDKs to create policies in IAM. For more interformation, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. The following instructions demonstrate how to use the IAM console to create an IAM policy that deﬁnes the permissions to grant to the Amplify Compute service. To use the IAM console JSON policy editor to create a policy 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the navigation pane on the left, choose Policies. 3. Choose Create policy. 4. 5. In the Policy editor section, choose the JSON option. Type or paste a JSON policy document. 6. When you are ﬁnished adding permissions to the policy, choose Next. 7. On the Review and create page, type a Policy Name and a Description (optional) for the policy that you are creating. Review Permissions deﬁned in this policy to see the permissions that are granted by your policy. 8. Choose Create policy to save your new policy. After you create a policy, use the following instructions to attach the policy to an IAM role. To create a role that grants Amplify permissions to speciﬁc AWS resources 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 2. In the navigation pane of the console, choose Roles and then choose Create role. 3. Choose the Custom trust policy role type. 4. In the Custom trust policy section, enter the custom trust policy for the role. A role trust policy is required and deﬁnes the principals that you trust to assume the role. Copy and paste the following trust policy to grant the Amplify service permission to assume this role. { Creating an SSR Compute role in the IAM console 93 AWS Amplify Hosting User Guide "Version": "2012-10-17", "Statement": [ { "Sid": "Statement1", "Effect": "Allow", "Principal": { "Service": [ "amplify.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] } 5. Resolve any security warnings, errors, or general warnings generated during policy validation, and then choose Next. 6. On the Add permissions page, search for the name of the policy that you created in the previous procedure and select it. Then choose Next. 7. 8. 9. For Role name, enter a role name. Role names must be unique within your AWS account. They are not distinguished by case. For example, you cannot create roles named both PRODROLE and prodrole. Because other AWS resources might reference the role, you cannot edit the name of the role after it has been created. (Optional) For Description, enter a description for the new role. (Optional) Choose Edit in the Step 1: Select trusted entities or Step 2: Add permissions sections to edit the custom policy and permissions for the role. 10. Review the role and then choose Create role. Adding an IAM SSR Compute role to an Amplify app After you have created an IAM role in your AWS account, you can associate it with an app in the Amplify console. To add an SSR Compute role to an app in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the app to add a Compute role to. Adding an IAM SSR Compute role to an Amplify app 94 AWS Amplify Hosting User Guide 3. 4. 5. In the navigation pane, choose App settings, and then choose IAM roles. In the Compute role section, choose Edit. In the Default role list, search for the name of the role you want to attach and select it. For this example, you can choose the name of the role you created in the previous procedure. By default, the role that you select will be associated with all branches of your app. If the role's trust relationship isn't deﬁned correctly, you will get an error and you won't be able to add the role. 6. (optional) If your application is in a public repository and uses auto-branch creation or has web previews for pull requests enabled, we don't recommend using an app-level role. Instead, attach the Compute role only to branches that require access to speciﬁc resources. To override the default app-level behavior and attach a role
amplify-console-ug-032	amplify-console-ug.pdf	32	of the role you created in the previous procedure. By default, the role that you select will be associated with all branches of your app. If the role's trust relationship isn't deﬁned correctly, you will get an error and you won't be able to add the role. 6. (optional) If your application is in a public repository and uses auto-branch creation or has web previews for pull requests enabled, we don't recommend using an app-level role. Instead, attach the Compute role only to branches that require access to speciﬁc resources. To override the default app-level behavior and attach a role to a speciﬁc branch, do the following: a. b. For Branch, select the name of the branch to use. For Compute role, select the name of the role to associate with the branch. 7. Choose, Save. Managing IAM SSR Compute role security Security is a shared responsibility between AWS and you. You are responsible for conﬁguring your application to meet your security and compliance objectives. This includes managing your SSR Compute role, which should be conﬁgured to have the minimum set of permissions needed to support your use case. Credentials for the SSR Compute role that you specify are immediately available in the runtime of your SSR function. If your SSR code exposes these credentials, either intentionally, due to a bug, or by permitting remote code execution (RCE), an unauthorized user can gain access to the SSR role and its permissions. When an application in a public repository uses an SSR Compute role and auto-branch creation or web previews for pull requests, you need to carefully manage which branches can access the role. We recommend that you don't use an app-level role. Instead, you should attach a Compute role at the branch-level. This allows you to grant permissions only to the branches that require access to speciﬁc resources. If your role's credentials are exposed, take the following actions to remove all access to the role's credentials. 1. Revoke all sessions Managing IAM SSR Compute role security 95 AWS Amplify Hosting User Guide For instructions on immediately revoking all permissions to the role's credentials, see Revoke IAM role temporary security credentials. 2. Delete the role from the Amplify console This action takes immediate eﬀect. You don't need to redeploy your application. To delete a Compute role in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the app to remove the Compute role from. 3. 4. 5. In the navigation pane, choose App settings, and then choose IAM roles. In the Compute role section, choose Edit. To delete the Default role, choose the X to the right of the role's name. 6. Choose Save. Adding a service role with permissions to access CloudWatch Logs Amplify sends information about your SSR runtime to Amazon CloudWatch Logs in your AWS account. When you deploy an SSR app, the app requires an IAM service role that Amplify assumes when calling other services on your behalf. You can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created. If you choose to allow Amplify to create an IAM role for you, the role will already have the permissions to create CloudWatch Logs. If you create your own IAM role, you will need to add the following permissions to your policy to allow Amplify to access Amazon CloudWatch Logs. logs:CreateLogStream logs:CreateLogGroup logs:DescribeLogGroups logs:PutLogEvents Adding a service role to access CloudWatch Logs 96 AWS Amplify Hosting User Guide Setting up custom domains You can connect an app that you’ve deployed with Amplify Hosting to a custom domain. When you use Amplify to deploy your web app, Amplify hosts it for you on the default amplifyapp.com domain with a URL such as https://branch-name.d1m7bkiki6tdw1.amplifyapp.com. When you connect your app to a custom domain, users see that your app is hosted on a custom URL, such as https://www.example.com. You can purchase a custom domain through an accredited domain registrar such as Amazon Route 53 or GoDaddy. Route 53 is Amazon’s Domain Name System (DNS) web service. For more information about using Route 53, see What is Amazon Route 53. For a list of third-party accredited domain registrars, see the Accredited Registrar Directory at the ICANN website. When you set up your custom domain, you can use the default managed certiﬁcate that Amplify provisions for you or you can use your own custom certiﬁcate. You can change the certiﬁcate in use for the domain at any time. For detailed information about managing certiﬁcates, see Using SSL/ TLS certiﬁcates. Before you proceed with setting up a custom domain, verify that you have met the following prerequisites. • You own
amplify-console-ug-033	amplify-console-ug.pdf	33	more information about using Route 53, see What is Amazon Route 53. For a list of third-party accredited domain registrars, see the Accredited Registrar Directory at the ICANN website. When you set up your custom domain, you can use the default managed certiﬁcate that Amplify provisions for you or you can use your own custom certiﬁcate. You can change the certiﬁcate in use for the domain at any time. For detailed information about managing certiﬁcates, see Using SSL/ TLS certiﬁcates. Before you proceed with setting up a custom domain, verify that you have met the following prerequisites. • You own a registered domain name. • You have a certiﬁcate issued by or imported into AWS Certiﬁcate Manager. • You have deployed your app to Amplify Hosting. For more information about completing this step, see Getting started with deploying an app to Amplify Hosting. • You have a basic knowledge of domains and DNS terminology. For more information about domains and DNS, see Understanding DNS terminology and concepts. Topics • Understanding DNS terminology and concepts • Using SSL/TLS certiﬁcates • Adding a custom domain managed by Amazon Route 53 97 AWS Amplify Hosting User Guide • Adding a custom domain managed by a third-party DNS provider • Updating DNS records for a domain managed by GoDaddy • Updating the SSL/TLS certiﬁcate for a domain • Managing subdomains • Setting up wildcard subdomains • Setting up automatic subdomains for an Amazon Route 53 custom domain • Troubleshooting custom domains Understanding DNS terminology and concepts If you are unfamiliar with the terms and concepts associated with Domain Name System (DNS), the following topics can help you understand the procedures for adding custom domains. DNS terminology The following are a list of terms common to DNS. They can help you understand the procedures for adding custom domains. CNAME A Canonical Record Name (CNAME) is a type of DNS record that masks the domain for a set of webpages and makes them appear as though they are located elsewhere. A CNAME points a subdomain to a fully qualiﬁed domain name (FQDN). For example, you can create a new CNAME record to map the subdomain www.example.com, where www is the subdomain, to the FQDN domain branch-name.d1m7bkiki6tdw1.cloudfront.net assigned to your app in the Amplify console. ANAME An ANAME record is like a CNAME record, but at the root level. An ANAME points the root of your domain to an FQDN. That FQDN points to an IP address. Name server A name server is a server on the internet that's specialized in handling queries regarding the location of a domain name’s various services. If you set up your domain in Amazon Route 53, a list of name servers are already assigned to your domain. Understanding DNS terminology and concepts 98 AWS Amplify Hosting NS record User Guide An NS record points to name servers that look up your domain details. DNS veriﬁcation A Domain Name System (DNS) is like a phone book that translates human-readable domain names into computer-friendly IP addresses. When you type https://google.com into a browser, a lookup operation is performed in the DNS provider to ﬁnd the IP Address of the server that hosts the website. DNS providers contain records of domains and their corresponding IP Addresses. The most commonly used DNS records are CNAME, ANAME, and NS records. Amplify uses a CNAME record to verify that you own your custom domain. If you host your domain with Route 53, veriﬁcation is done automatically on your behalf. However, if you host your domain with a third-party provider such as GoDaddy, you have to manually update your domain’s DNS settings and add a new CNAME record provided by Amplify. Custom domain activation process When you connect your Amplify app to a custom domain in the Amplify console, there are several steps that Amplify must complete before you can view your app using your custom domain. The following list describes each step in the domain set up and activation process. SSL/TLS creation If you are using a managed certiﬁcate, AWS Amplify issues an SSL/TLS certiﬁcate for setting up a secure custom domain. SSL/TLS conﬁguration and veriﬁcation Before issuing a managed certiﬁcate, Amplify veriﬁes that you are the owner of the domain. For domains managed by Amazon Route 53, Amplify automatically updates the DNS veriﬁcation record. For domains managed outside of Route 53, you must manually add the DNS veriﬁcation record provided in the Amplify console into your domain with a third-party DNS provider. If you are using a custom certiﬁcate, you are responsible for validating domain ownership. DNS veriﬁcation 99 AWS Amplify Hosting Domain activation User Guide The domain is successfully veriﬁed. For domains managed outside of Route 53, you need to manually add the CNAME records provided in the Amplify console into your domain with a
amplify-console-ug-034	amplify-console-ug.pdf	34	owner of the domain. For domains managed by Amazon Route 53, Amplify automatically updates the DNS veriﬁcation record. For domains managed outside of Route 53, you must manually add the DNS veriﬁcation record provided in the Amplify console into your domain with a third-party DNS provider. If you are using a custom certiﬁcate, you are responsible for validating domain ownership. DNS veriﬁcation 99 AWS Amplify Hosting Domain activation User Guide The domain is successfully veriﬁed. For domains managed outside of Route 53, you need to manually add the CNAME records provided in the Amplify console into your domain with a third-party DNS provider. Using SSL/TLS certiﬁcates An SSL/TLS certiﬁcate is a digital document that allows web browsers to identify and establish encrypted network connections to web sites using the secure SSL/TLS protocol. When you set up your custom domain, you can use the default managed certiﬁcate that Amplify provisions for you or you can use your own custom certiﬁcate. With a managed certiﬁcate, Amplify issues an SSL/TLS certiﬁcate for all domains connected to your app so that all traﬃc is secured through HTTPS/2. The default certiﬁcate generated by AWS Certiﬁcate Manager (ACM) is valid for 13 months and renews automatically as long as your app is hosted with Amplify. Warning Amplify can't renew the certiﬁcate if the CNAME veriﬁcation record has been modiﬁed or deleted in the DNS settings with your domain provider. You must delete and add the domain again in the Amplify console. To use a custom certiﬁcate, you must ﬁrst obtain a certiﬁcate from the third-party certiﬁcate authority of your choice. Amplify Hosting supports two types of certiﬁcates: RSA (Rivest-Shamir- Adleman) and ECDSA (Elliptic Curve Digital Signature Algorithm). Each certiﬁcate type must conform to the following requirements. RSA certiﬁcates • Amplify Hosting supports 1024-bit, 2048-bit, 3072-bit, and 4096-bit RSA keys. • AWS Certiﬁcate Manager (ACM) issues RSA certiﬁcates with up to 2048-bit keys. • To use a 3072-bit or 4096-bit RSA certiﬁcate, obtain the certiﬁcate externally and import it into ACM. It will then be available for use with Amplify Hosting. ECDSA certiﬁcates Using SSL/TLS certiﬁcates 100 AWS Amplify Hosting User Guide • Amplify Hosting supports 256-bit keys. • Use the prime256v1 elliptic curve to obtain an ECDSA certiﬁcate for Amplify Hosting. After you obtain a certiﬁcate, import it into AWS Certiﬁcate Manager. ACM is a service that lets you easily provision, manage, and deploy public and private SSL/TLS certiﬁcates for use with AWS services and your internal connected resources. Make sure you request or import the certiﬁcate in the US East (N. Virginia) (us-east-1) Region. Ensure that your custom certiﬁcate covers all of the subdomains you plan to add. You can use a wildcard at the beginning of your domain name to cover multiple subdomains. For example, if your domain is example.com, you can include the wildcard domain *.example.com. This will cover subdomains such as product.example.com and api.example.com. After your custom certiﬁcate is available in ACM, you will be able to select it during the domain set up process. For instructions on importing certiﬁcates into AWS Certiﬁcate Manager, see Importing certiﬁcates into AWS Certiﬁcate Manager in the AWS Certiﬁcate Manager User Guide. If you renew or reimport your custom certiﬁcate in ACM, Amplify refreshes the certiﬁcate data associated with your custom domain. In the case of imported certiﬁcates, ACM doesn't manage the renewals automatically. You are responsible for renewing your custom certiﬁcates and importing them again. You can change the certiﬁcate in use for a domain at any time. For example, you can switch from the default managed certiﬁcate to a custom certiﬁcate or change from a custom certiﬁcate to a managed certiﬁcate. In addition, you can change the custom certiﬁcate in use to a diﬀerent custom certiﬁcate. For instructions on updating certiﬁcates, see Update the SSL/TLS certiﬁcate for a domain. Adding a custom domain managed by Amazon Route 53 Amazon Route 53 is a highly available and scalable DNS service. For more information, see Amazon Route 53 in the Amazon Route 53 Developer Guide. If you already have a Route 53 domain, use the following instructions to connect your custom domain to your Amplify app. To add a custom domain managed by Route 53 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to connect to a custom domain. Adding a custom domain managed by Amazon Route 53 101 AWS Amplify Hosting User Guide 3. In the navigation pane, choose Hosting, Custom domains. 4. On the Custom domains page, choose Add domain. 5. Enter the name of your root domain. For example, if the name of your domain is https:// example.com, enter example.com. As you start typing, any root domains that you already manage in Route 53 appear in the list. You can choose
amplify-console-ug-035	amplify-console-ug.pdf	35	Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to connect to a custom domain. Adding a custom domain managed by Amazon Route 53 101 AWS Amplify Hosting User Guide 3. In the navigation pane, choose Hosting, Custom domains. 4. On the Custom domains page, choose Add domain. 5. Enter the name of your root domain. For example, if the name of your domain is https:// example.com, enter example.com. As you start typing, any root domains that you already manage in Route 53 appear in the list. You can choose the domain you want to use from the list. If you don't already own the domain and it is available, you can purchase the domain in Amazon Route 53. 6. After you enter your domain name, choose Conﬁgure domain. 7. By default, Amplify automatically creates two subdomain entries for your domain. For example, if your domain name is example.com, you will see the subdomains https:// www.example.com and https://example.com with a redirect set up from the root domain to the www subdomain. (Optional) You can modify the default conﬁguration if you want to add subdomains only. To change the default conﬁguration, choose Rewrites and redirects from the navigation pane, then conﬁgure your domain. 8. Choose the SSL/TLS certiﬁcate to use. You can either use the default managed certiﬁcate that Amplify provisions for you, or a custom third-party certiﬁcate that you have imported into AWS Certiﬁcate Manager. • • Use the default Amplify managed certiﬁcate. • Choose Amplify managed certiﬁcate. Use a custom third-party certiﬁcate. a. b. Choose Custom SSL certiﬁcate. Select the certiﬁcate to use from the list. 9. Choose Add domain. Note It can take up to 24 hours for the DNS to propagate and to issue the certiﬁcate. For help with resolving errors that occur, see Troubleshooting custom domains. Adding a custom domain managed by Amazon Route 53 102 AWS Amplify Hosting User Guide Adding a custom domain managed by a third-party DNS provider If you are not using Amazon Route 53 to manage your domain, you can add a custom domain managed by a third-party DNS provider to your app deployed with Amplify. If you are using GoDaddy, see the section called “Updating DNS records for a domain managed by GoDaddy” for instructions speciﬁc to this provider. To add a custom domain managed by a third-party DNS provider 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to add a custom domain to. 3. In the navigation pane, choose Hosting, Custom domains. 4. On the Custom domains page, choose Add domain. 5. Enter the name of your root domain. For example, if the name of your domain is https:// example.com, enter example.com. 6. Amplify detects that you are not using a Route 53 domain and gives you the option to create a hosted zone in Route 53. • To create a hosted zone in Route 53 a. Choose Create hosted zone on Route 53. b. Choose Conﬁgure domain. c. Hosted zone name servers are displayed in the console. Go to your DNS provider's website and add the name servers to your DNS settings. d. e. Select I have added the above name servers to my domain registry. Proceed to step seven. • To continue with manual conﬁguration a. Choose Manual conﬁguration b. Choose Conﬁgure domain. c. Proceed to step seven. 7. By default, Amplify automatically creates two subdomain entries for your domain. For example, if your domain name is example.com, you will see the subdomains https:// Adding a custom domain managed by a third-party DNS provider 103 AWS Amplify Hosting User Guide www.example.com and https://example.com with a redirect set up from the root domain to the www subdomain. (Optional) You can modify the default conﬁguration if you want to add subdomains only. To change the default conﬁguration, choose Rewrites and redirects from the navigation pane and conﬁgure your domain. 8. Choose the SSL/TLS certiﬁcate to use. You can either use the default managed certiﬁcate that Amplify provisions for you, or a custom third-party certiﬁcate that you have imported into AWS Certiﬁcate Manager. • • Use the default Amplify managed certiﬁcate. • Choose Amplify managed certiﬁcate. Use a custom third-party certiﬁcate. a. b. Choose Custom SSL certiﬁcate. Select the certiﬁcate to use from the list. 9. Choose Add domain. 10. If you chose Create hosted zone on Route 53 in step six, proceed to step 15. If you chose Manual conﬁguration, in step six, you must update your DNS records with your third-party domain provider. On the Actions menu, choose View DNS records. The following screenshot shows the DNS records displayed in the console. Adding a custom domain managed by a third-party DNS provider 104 AWS Amplify Hosting
amplify-console-ug-036	amplify-console-ug.pdf	36	Amplify managed certiﬁcate. • Choose Amplify managed certiﬁcate. Use a custom third-party certiﬁcate. a. b. Choose Custom SSL certiﬁcate. Select the certiﬁcate to use from the list. 9. Choose Add domain. 10. If you chose Create hosted zone on Route 53 in step six, proceed to step 15. If you chose Manual conﬁguration, in step six, you must update your DNS records with your third-party domain provider. On the Actions menu, choose View DNS records. The following screenshot shows the DNS records displayed in the console. Adding a custom domain managed by a third-party DNS provider 104 AWS Amplify Hosting User Guide 11. Do one of the following: • If you're using GoDaddy, go to Updating DNS records for a domain managed by GoDaddy. • If you're using a diﬀerent third-party DNS provider, go to the next step in this procedure. 12. Go to your DNS provider's website, log in to your account, and locate the DNS management settings for your domain. You will conﬁgure two CNAME records. 13. Conﬁgure the ﬁrst CNAME record to point your subdomain to the AWS validation server. If the Amplify console displays a DNS record for verifying ownership of your subdomain such as _c3e2d7eaf1e656b73f46cd6980fdc0e.example.com, enter only _c3e2d7eaf1e656b73f46cd6980fdc0e for the CNAME record subdomain name. The following screenshot shows the location of the veriﬁcation record to use. Adding a custom domain managed by a third-party DNS provider 105 AWS Amplify Hosting User Guide If the the Amplify console displays an ACM validation server record such as _cjhwou20vhu2exampleuw20vuyb2ovb9.j9s73ucn9vy.acm-validations.aws, enter _cjhwou20vhu2exampleuw20vuyb2ovb9.j9s73ucn9vy.acm-validations.aws for the CNAME record value. The following screenshot shows the location of the ACM veriﬁcation record to use. Adding a custom domain managed by a third-party DNS provider 106 AWS Amplify Hosting User Guide Amplify uses this information to verify ownership of your domain and generate an SSL/TLS certiﬁcate for your domain. Once Amplify validates ownership of your domain, all traﬃc will be served using HTTPS/2. Note The default Amplify certiﬁcate generated by AWS Certiﬁcate Manager (ACM) is valid for 13 months and renews automatically as long as your app is hosted with Amplify. Amplify can't renew the certiﬁcate if the CNAME veriﬁcation record has been modiﬁed or deleted. You must delete and add the domain again in the Amplify console. Important It is important that you perform this step soon after adding your custom domain in the Amplify console. The AWS Certiﬁcate Manager (ACM) immediately starts attempting to verify ownership. Over time, the checks become less frequent. If you add or update your CNAME records a few hours after you create your app, this can cause your app to get stuck in the pending veriﬁcation state. 14. Conﬁgure a second CNAME record to point your subdomains to the Amplify domain. For example, if your subdomain is www.example.com, enter www for the subdomain name. If the Amplify console displays the domain for your app as d111111abcdef8.cloudfront.net, enter d111111abcdef8.cloudfront.net for the Amplify domain. If you have production traﬃc, we recommended you update this CNAME record after your domain status shows as AVAILABLE in the Amplify console. The following screenshot shows the location of the domain name record to use. Adding a custom domain managed by a third-party DNS provider 107 AWS Amplify Hosting User Guide 15. Conﬁgure the ANAME/ALIAS record to point to the root domain of your app (for example https://example.com). An ANAME record points the root of your domain to a hostname. If you have production traﬃc, we recommended that you update your ANAME record after your domain status shows as AVAILABLE in the console. For DNS providers that don't have ANAME/ALIAS support, we strongly recommend migrating your DNS to Route 53. For more information, see Conﬁguring Amazon Route 53 as your DNS service. Note Veriﬁcation of domain ownership and DNS propagation for third-party domains can take up to 48 hours. For help resolving errors that occur, see Troubleshooting custom domains. Updating DNS records for a domain managed by GoDaddy If GoDaddy is your DNS provider, use the following instructions to update your DNS records in the GoDaddy UI to ﬁnish connecting your Amplify app to your GoDaddy domain. To add a custom domain managed by GoDaddy 1. Before you can update your DNS records with GoDaddy, complete steps one through nine of the procedure the section called “Adding a custom domain managed by a third-party DNS provider”. Updating DNS records for a domain managed by GoDaddy 108 AWS Amplify Hosting User Guide 2. 3. Log in to your GoDaddy account. In your list of domains, ﬁnd the domain to add and choose Manage DNS. 4. On the DNS page, GoDaddy displays a list of records for your domain in the DNS Records section. You need to add two new CNAME records. 5. Create the ﬁrst CNAME record to point your subdomains to the Amplify domain.
amplify-console-ug-037	amplify-console-ug.pdf	37	GoDaddy, complete steps one through nine of the procedure the section called “Adding a custom domain managed by a third-party DNS provider”. Updating DNS records for a domain managed by GoDaddy 108 AWS Amplify Hosting User Guide 2. 3. Log in to your GoDaddy account. In your list of domains, ﬁnd the domain to add and choose Manage DNS. 4. On the DNS page, GoDaddy displays a list of records for your domain in the DNS Records section. You need to add two new CNAME records. 5. Create the ﬁrst CNAME record to point your subdomains to the Amplify domain. a. b. c. d. In the DNS Records section, choose Add New Record. For Type, choose CNAME. For Name, enter only the subdomain. For example, if your subdomain is www.example.com, enter www for Name. For Value, look at your DNS records in the Amplify console and then enter the value. If the Amplify console displays the domain for your app as d111111abcdef8.cloudfront.net, enter d111111abcdef8.cloudfront.net for Value. The following screenshot shows the location of the domain name record to use. e. Choose Save. 6. Create the second CNAME record to point to the AWS Certiﬁcate Manager (ACM) validation server. A single validated ACM generates an SSL/TLS certiﬁcate for your domain. a. b. For Type, choose CNAME. For Name, enter the subdomain. Updating DNS records for a domain managed by GoDaddy 109 AWS Amplify Hosting User Guide For example, if the DNS record in the Amplify console for verifying ownership of your subdomain is _c3e2d7eaf1e656b73f46cd6980fdc0e.example.com, enter only _c3e2d7eaf1e656b73f46cd6980fdc0e for Name. The following screenshot shows the location of the veriﬁcation record to use. c. For Value, enter the ACM validation certiﬁcate. For example, if the validation server is _cjhwou20vhu2exampleuw20vuyb2ovb9.j9s73ucn9vy.acm-validations.aws, enter _cjhwou20vhu2exampleuw20vuyb2ovb9.j9s73ucn9vy.acm-validations.aws for Value. The following screenshot shows the location of the ACM veriﬁcation record to use. Updating DNS records for a domain managed by GoDaddy 110 AWS Amplify Hosting User Guide d. Choose Save. Note The default Amplify certiﬁcate generated by AWS Certiﬁcate Manager (ACM) is valid for 13 months and renews automatically as long as your app is hosted with Amplify. Amplify can't renew the certiﬁcate if the CNAME veriﬁcation record has been modiﬁed or deleted. You must delete and add the domain again in the Amplify console. 7. This step is not required for subdomains. GoDaddy doesn’t support ANAME/ALIAS records. For DNS providers that do not have ANAME/ALIAS support, we strongly recommend migrating your DNS to Amazon Route 53. For more information, see Conﬁguring Amazon Route 53 as your DNS service. If you want to keep GoDaddy as your provider and update the root domain, add Forwarding and set up a domain forward: a. On the DNS page, locate the menu at the top of the page and choose Forwarding. b. c. d. e. In the Domain section, choose Add Forwarding. Choose http://, and then enter the name of your subdomain to forward to (for example, www.example.com) for the Destination URL. For Forward Type, choose Temporary (302). Choose, Save. Updating DNS records for a domain managed by GoDaddy 111 AWS Amplify Hosting User Guide Updating the SSL/TLS certiﬁcate for a domain You can change the SSL/TLS certiﬁcate that is in use for a domain at any time. For example, you can change from using a managed certiﬁcate to using a custom certiﬁcate. This is helpful if you want to manage the certiﬁcate and its expiration notiﬁcations. You can also change the custom certiﬁcate that is in use for the domain. Making changes to the SSL certiﬁcate won't incur any downtime for your active domain. For more information about certiﬁcates, see Using SSL/TLS certiﬁcates. Use the following procedure to update the type of certiﬁcate or the custom certiﬁcate that is in use for a domain. To update a domain's certiﬁcate 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to update. 3. In the navigation pane, choose Hosting, Custom domains. 4. On the Custom domains page, choose Domain conﬁguration. 5. On the details page for your domain, locate the Custom SSL certiﬁcate section. The procedure for updating your certiﬁcate varies depending on the type of change you want to make. • • To change from a custom certiﬁcate to the default Amplify managed certiﬁcate • Choose Amplify managed certiﬁcate. To change from a managed certiﬁcate to a custom certiﬁcate a. b. Choose Custom SSL certiﬁcate. Select the certiﬁcate to use from the list. • To change a custom certiﬁcate to a diﬀerent custom certiﬁcate • For Custom SSL certiﬁcate, select the new certiﬁcate to use from the list. 6. Choose Save. The status details for the domain will indicate that Amplify has initiated the SSL creation process for a managed certiﬁcate or the conﬁguration process for a custom certiﬁcate. Updating the
amplify-console-ug-038	amplify-console-ug.pdf	38	• To change from a custom certiﬁcate to the default Amplify managed certiﬁcate • Choose Amplify managed certiﬁcate. To change from a managed certiﬁcate to a custom certiﬁcate a. b. Choose Custom SSL certiﬁcate. Select the certiﬁcate to use from the list. • To change a custom certiﬁcate to a diﬀerent custom certiﬁcate • For Custom SSL certiﬁcate, select the new certiﬁcate to use from the list. 6. Choose Save. The status details for the domain will indicate that Amplify has initiated the SSL creation process for a managed certiﬁcate or the conﬁguration process for a custom certiﬁcate. Updating the SSL/TLS certiﬁcate for a domain 112 AWS Amplify Hosting User Guide Managing subdomains A subdomain is the part of your URL that appears before your domain name. For example, www is the subdomain of www.amazon.com and aws is the subdomain of aws.amazon.com. If you already have a production website, you might want to only connect a subdomain. Subdomains can also be multilevel, for example beta.alpha.example.com has the multilevel subdomain beta.alpha. To add a subdomain only 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to add a subdomain to. 3. In the navigation pane, choose Hosting, and then choose Custom domains. 4. On the Custom domains page, choose Add domain. 5. Enter the name of your root domain and then choose Conﬁgure domain. For example, if the name of your domain is https://example.com, enter example.com. 6. Choose Exclude root and modify the name of the subdomain. For example if the domain is example.com you can modify it to only add the subdomain alpha. 7. Choose Add domain. To add a multilevel subdomain 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to add a multilevel subdomain to. 3. In the navigation pane, choose Hosting, and then choose Custom domains. 4. On the Custom domains page, choose Add domain. 5. Enter the name of a domain with a subdomain, choose Exclude root, and modify the subdomain to add a new level. For example, if you have a domain called alpha.example.com and you want to create a multilevel subdomain beta.alpha.example.com, you would enter beta as the subdomain value. 6. Choose Add domain. Managing subdomains 113 AWS Amplify Hosting User Guide To add or edit a subdomain After adding a custom domain to an app, you can edit an existing subdomain or add a new subdomain. 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose your app that you want to manage subdomains for. 3. In the navigation pane, choose Hosting, and then choose Custom domains. 4. On the Custom domains page, choose Domain conﬁguration. 5. 6. In the Subdomains section, you can edit your existing subdomains as needed. (Optional) To add a new subdomain, choose Add new. 7. Choose Save. Setting up wildcard subdomains Amplify Hosting now supports wildcard subdomains. A wildcard subdomain is a catch-all subdomain that enables you to point existing and non-existing subdomains to a speciﬁc branch of your application. When you use a wildcard to associate all subdomains in an app to a speciﬁc branch, you can serve the same content to your app's users in any subdomain and avoid conﬁguring each subdomain individually. To create a wildcard subdomain, specify an asterisk () as the subdomain name. For example, if you specify the wildcard subdomain .example.com for a speciﬁc branch of your app, any URL that ends with example.com will be routed to the branch. In this case, requests for dev.example.com and prod.example.com will be routed to the .example.com subdomain. Note that Amplify supports wildcard subdomains only for a custom domain. You can't use this feature with the default amplifyapp.com domain. The following requirements apply to wildcard subdomains: • The subdomain name must be speciﬁed with an asterisk () only. • You can't use a wildcard to replace part of a subdomain name, like this: domain.example.com. • You can't replace a subdomain in the middle of a domain name, like this: subdomain..example.com. • By default, all Amplify provisioned certiﬁcates cover all subdomains for a custom domain. To add or edit a subdomain 114 AWS Amplify Hosting User Guide To add or delete a wildcard subdomain After adding a custom domain to an app, you can add a wildcard subdomain for an app branch. 1. Sign in to the AWS Management Console and open the Amplify Hosting console. 2. Choose your app that you want to manage wildcard subdomains for. 3. In the navigation pane, choose Hosting, and then choose Custom domains. 4. On the Custom domains page, choose Domain conﬁguration. 5. In the Subdomains section, you can add or delete wildcard subdomains. • To add a new wildcard subdomain a.
amplify-console-ug-039	amplify-console-ug.pdf	39	a subdomain 114 AWS Amplify Hosting User Guide To add or delete a wildcard subdomain After adding a custom domain to an app, you can add a wildcard subdomain for an app branch. 1. Sign in to the AWS Management Console and open the Amplify Hosting console. 2. Choose your app that you want to manage wildcard subdomains for. 3. In the navigation pane, choose Hosting, and then choose Custom domains. 4. On the Custom domains page, choose Domain conﬁguration. 5. In the Subdomains section, you can add or delete wildcard subdomains. • To add a new wildcard subdomain a. b. c. Choose Add new. For the subdomain, enter an *. For your app branch, select a branch name from the list. d. Choose Save. • To delete a wildcard subdomain a. Choose Remove next to the subdomain name. Traﬃc to a subdomain that is not explicitly conﬁgured stops, and Amplify Hosting returns a 404 status code to those requests. b. Choose Save. Setting up automatic subdomains for an Amazon Route 53 custom domain After an app is connected to a custom domain in Route 53, Amplify enables you to automatically create subdomains for newly connected branches. For example, if you connect your dev branch, Amplify can automatically create dev.exampledomain.com. When you delete a branch, any associated subdomains are automatically deleted. To set up automatic subdomain creation for newly connected branches 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose an app that is connected to a custom domain managed in Route 53. 3. In the navigation pane, choose Hosting, and then choose Custom domains. To add or delete a wildcard subdomain 115 AWS Amplify Hosting User Guide 4. On the Custom domains page, choose Domain conﬁguration. 5. In the Automatic subdomain creation section, turn on the feature. Note This feature is available only for root domains, for example, exampledomain.com. The Amplify console doesn't display this check box if your domain is already a subdomain, such as dev.exampledomain.com. Web previews with subdomains After you enable Automatic subdomain creation using the preceding instructions, your app’s pull request web previews will also be accessible with automatically created subdomains. When a pull request is closed, the associated branch and subdomain are automatically deleted. For more information on setting up web previews for pull requests, see Web previews for pull requests. Troubleshooting custom domains If you encounter issues when adding a custom domain to an app in the AWS Amplify console, consult Troubleshooting custom domains in the Amplify troubleshooting chapter. If you don't see a solution to your issue there, contact Support. For more information, see Creating a support case in the AWS Support User Guide. Web previews with subdomains 116 AWS Amplify Hosting User Guide Conﬁguring the build settings for an app When you deploy an application, Amplify automatically detects the frontend framework and associated build settings by inspecting the app's package.json ﬁle in your Git repository. You have the following options for storing your app's build settings: • Save the build settings in the Amplify console - The Amplify console autodetects build settings and saves them so that they can be accessed by the Amplify console. Amplify applies these settings to all of your branches unless there is an amplify.yml ﬁle stored in your repository. • Save the build settings in your repository - Download the amplify.yml ﬁle and add it to the root of your repository. Note Build settings is visible in the Amplify console's Hosting menu only when an app is set up for continuous deployment and connected to a git repository. For instructions on this type of deployment, see Getting started. Understanding the build speciﬁcation The build speciﬁcation for an Amplify application is a collection of YAML settings and build commands that Amplify uses to run your build. The following list describes these settings and how they are used. version The Amplify YAML version number. appRoot The path within the repository that this application resides in. Ignored unless multiple applications are deﬁned. env Add environment variables to this section. You can also add environment variables using the console. Understanding the build speciﬁcation 117 AWS Amplify Hosting backend User Guide Run Amplify CLI commands to provision a backend, update Lambda functions, or GraphQL schemas as part of continuous deployment. frontend Run frontend build commands. test Run commands during a test phase. Learn how to add tests to your app. build phases The frontend, backend, and test have three phases that represent the commands run during each sequence of the build. • preBuild - The preBuild script runs before the actual build starts, but after Amplify installs dependencies. • build - Your build commands. • postBuild - The post-build script runs after the build has ﬁnished and Amplify has copied all the necessary artifacts to
amplify-console-ug-040	amplify-console-ug.pdf	40	to provision a backend, update Lambda functions, or GraphQL schemas as part of continuous deployment. frontend Run frontend build commands. test Run commands during a test phase. Learn how to add tests to your app. build phases The frontend, backend, and test have three phases that represent the commands run during each sequence of the build. • preBuild - The preBuild script runs before the actual build starts, but after Amplify installs dependencies. • build - Your build commands. • postBuild - The post-build script runs after the build has ﬁnished and Amplify has copied all the necessary artifacts to the output directory. buildpath The path to use to run the build. Amplify uses this path to locate your build artifacts. If you don't specify a path, Amplify uses the monorepo app root, for example apps/app. artifacts>base-directory The directory in which your build artifacts exist. artifacts>ﬁles Specify ﬁles from your artifacts you want to deploy. Enter */ to include all ﬁles. cache Speciﬁes build-time dependencies such as the node_modules folder. During the ﬁrst build, paths provided here are cached. On subsequent builds, Amplify restores the cache to the same paths before it runs your commands. Amplify considers all provided cache paths to be relative to your project root. However, Amplify doesn't allow traversing outside of the project root. For example, if you specify an absolute path, the build will succeed without an error, but the path won't be cached. Understanding the build speciﬁcation 118 AWS Amplify Hosting User Guide Build speciﬁcation YAML syntax reference The following example of a build speciﬁcation demonstrates the basic YAML syntax. version: 1 env: variables: key: value backend: phases: preBuild: commands: - enter command build: commands: - enter command postBuild: commands: - enter command frontend: buildpath: phases: preBuild: commands: - cd react-app - npm ci build: commands: - npm run build artifacts: files: - location - location discard-paths: yes baseDirectory: location cache: paths: - path # A cache path relative to the project root - path # Traversing outside of the project root is not allowed test: phases: preTest: commands: - enter command Understanding the build speciﬁcation 119 User Guide AWS Amplify Hosting test: commands: - enter command postTest: commands: - enter command artifacts: files: - location - location configFilePath: location baseDirectory: location Editing the build speciﬁcation in the Amplify console You can customize an application's build settings by editing the build speciﬁcation in the Amplify console. The build settings are applied to all the branches in your app, except for the branches that have an amplify.yml ﬁle saved in the Git repository. To edit build settings in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to edit the build settings for. 3. In the navigation pane, choose Hosting, then choose Build settings. 4. On the Build settings page, in the App build speciﬁcation section, choose Edit. 5. In the Edit build spec window, enter your updates. 6. Choose Save. You can use the examples described in the following topics to update your build settings for speciﬁc scenarios. Topics • Setting branch-speciﬁc build settings with scripting • Setting a command to navigate to a subfolder • Deploying the backend with the front end for a Gen 1 app • Setting the output folder • Installing packages as part of a build Editing the build speciﬁcation 120 AWS Amplify Hosting • Using a private npm registry • Installing OS packages • Setting key-value storage for every build • Skipping the build for a commit • Turning oﬀ automatic builds on every commit • Conﬁguring diﬀ based frontend build and deploy • Conﬁguring diﬀ based backend builds for a Gen 1 app User Guide Setting branch-speciﬁc build settings with scripting You can use bash shell scripting to set branch-speciﬁc build settings. For example, the following script uses the system environment variable $AWS_BRANCH to run one set of commands if the branch name is main and a diﬀerent set of commands if the branch name is dev. frontend: phases: build: commands: - if [ "${AWS_BRANCH}" = "main" ]; then echo "main branch"; fi - if [ "${AWS_BRANCH}" = "dev" ]; then echo "dev branch"; fi Setting a command to navigate to a subfolder For monorepos, users want to be able to cd into a folder to run the build. After you run the cd command, it applies to all stages of your build so you don’t need to repeat the command in separate phases. version: 1 env: variables: key: value frontend: phases: preBuild: commands: - cd react-app - npm ci build: Setting branch-speciﬁc build settings with scripting 121 AWS Amplify Hosting commands: - npm run build User Guide Deploying the backend with the front end for a Gen 1 app Note This section
amplify-console-ug-041	amplify-console-ug.pdf	41	branch"; fi Setting a command to navigate to a subfolder For monorepos, users want to be able to cd into a folder to run the build. After you run the cd command, it applies to all stages of your build so you don’t need to repeat the command in separate phases. version: 1 env: variables: key: value frontend: phases: preBuild: commands: - cd react-app - npm ci build: Setting branch-speciﬁc build settings with scripting 121 AWS Amplify Hosting commands: - npm run build User Guide Deploying the backend with the front end for a Gen 1 app Note This section applies to Amplify Gen 1 applications only. A Gen 1 backend is created using Amplify Studio and the Amplify command line interface (CLI). The amplifyPush command is a helper script that helps you with backend deployments. The build settings below automatically determine the correct backend environment to deploy for the current branch. version: 1 env: variables: key: value backend: phases: build: commands: - amplifyPush --simple Setting the output folder The following build settings set the output directory to the public folder. frontend: phases: commands: build: - yarn run build artifacts: baseDirectory: public Installing packages as part of a build You can use the npm or yarn commands to install packages during the build. Deploying the backend with the front end for a Gen 1 app 122 User Guide AWS Amplify Hosting frontend: phases: build: commands: - npm install -g <package> - <package> deploy - yarn run build artifacts: baseDirectory: public Using a private npm registry You can add references to a private registry in your build settings or add it as an environment variable. build: phases: preBuild: commands: - npm config set <key> <value> - npm config set registry https://registry.npmjs.org - npm config set always-auth true - npm config set email hello@amplifyapp.com - yarn install Installing OS packages Amplify's AL2023 image runs your code with a non-privileged user named amplify. Amplify grants this user privileges to run OS commands using the Linux sudo command. If you want to install OS packages for missing dependencies, you can use commands such as yum and rpm with sudo. The following example build section demonstrates the syntax for installing an OS package using the sudo command. build: phases: preBuild: commands: - sudo yum install -y <package> Using a private npm registry 123 AWS Amplify Hosting User Guide Setting key-value storage for every build The envCache provides key-value storage at build time. Values stored in the envCache can only be modiﬁed during a build and can be re-used at the next build. Using the envCache, we can store information on the deployed environment and make it available to the build container in successive builds. Unlike values stored in the envCache, changes to environment variables during a build are not persisted to future builds. Example usage: envCache --set <key> <value> envCache --get <key> Skipping the build for a commit To skip an automatic build on a particular commit, include the text [skip-cd] at the end of the commit message. Turning oﬀ automatic builds on every commit You can conﬁgure Amplify to turn oﬀ automatic builds on every code commit. To set up, choose App settings, Branch settings, and then locate the Branches section that lists the connected branches. Select a branch, and then choose Actions, Disable auto build. New commits to that branch will no longer start a new build. Conﬁguring diﬀ based frontend build and deploy You can conﬁgure Amplify to use diﬀ based frontend builds. If enabled, at the start of each build Amplify attempts to run a diﬀ on either your appRoot, or the /src/ folder by default. If Amplify doesn't ﬁnd any diﬀerences, it skips the frontend build, test (if conﬁgured), and deploy steps, and does not update your hosted app. To conﬁgure diﬀ based frontend build and deploy 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to conﬁgure diﬀ based frontend build and deploy for. 3. In the navigation pane, choose Hosting, Environment variables. Setting key-value storage for every build 124 AWS Amplify Hosting User Guide 4. 5. In the Environment variables section, choose Manage variables. The procedure for conﬁguring the environment variable varies depending on whether you are enabling or disabling diﬀ based frontend build and deploy. • To enable diﬀ based frontend build and deploy a. b. In the Manage variables section, under Variable, enter AMPLIFY_DIFF_DEPLOY. For Value, enter true. • To disable diﬀ based frontend build and deploy • Do one of the following: • • In the Manage variables section, locate AMPLIFY_DIFF_DEPLOY. For Value, enter false. Remove the AMPLIFY_DIFF_DEPLOY environment variable. 6. Choose Save. Optionally, you can set the AMPLIFY_DIFF_DEPLOY_ROOT environment variable to override the default path with a path relative to the root of your repo, such
amplify-console-ug-042	amplify-console-ug.pdf	42	variable varies depending on whether you are enabling or disabling diﬀ based frontend build and deploy. • To enable diﬀ based frontend build and deploy a. b. In the Manage variables section, under Variable, enter AMPLIFY_DIFF_DEPLOY. For Value, enter true. • To disable diﬀ based frontend build and deploy • Do one of the following: • • In the Manage variables section, locate AMPLIFY_DIFF_DEPLOY. For Value, enter false. Remove the AMPLIFY_DIFF_DEPLOY environment variable. 6. Choose Save. Optionally, you can set the AMPLIFY_DIFF_DEPLOY_ROOT environment variable to override the default path with a path relative to the root of your repo, such as dist. Conﬁguring diﬀ based backend builds for a Gen 1 app Note This section applies to Amplify Gen 1 applications only. A Gen 1 backend is created using Amplify Studio and the Amplify command line interface (CLI). You can conﬁgure Amplify Hosting to use diﬀ based backend builds using the AMPLIFY_DIFF_BACKEND environment variable. When you enable diﬀ based backend builds, at the start of each build Amplify attempts to run a diﬀ on the amplify folder in your repository. If Amplify doesn't ﬁnd any diﬀerences, it skips the backend build step, and doesn't update your backend resources. If your project doesn't have an amplify folder in your repository, Amplify ignores the value of the AMPLIFY_DIFF_BACKEND environment variable. If you currently have custom commands speciﬁed in the build settings of your backend phase, conditional backend builds won't work. If you want those custom commands to run, you must move them to the frontend phase of your build settings in your app's amplify.yml ﬁle. Conﬁguring diﬀ based backend builds for a Gen 1 app 125 AWS Amplify Hosting User Guide To conﬁgure diﬀ based backend builds 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to conﬁgure diﬀ based backend builds for. 3. 4. 5. In the navigation pane, choose Hosting, Environment variables. In the Environment variables section, choose Manage variables. The procedure for conﬁguring the environment variable varies depending on whether you are enabling or disabling diﬀ based backend builds. • To enable diﬀ based backend builds a. b. In the Manage variables section, under Variable, enter AMPLIFY_DIFF_BACKEND. For Value, enter true. • To disable diﬀ based backend builds • Do one of the following: • • In the Manage variables section, locate AMPLIFY_DIFF_BACKEND. For Value, enter false. Remove the AMPLIFY_DIFF_BACKEND environment variable. 6. Choose Save. Conﬁguring monorepo build settings When you store multiple projects or microservices in a single repository, it is called a monorepo. You can use Amplify Hosting to deploy applications in a monorepo without creating multiple build conﬁgurations or branch conﬁgurations. Amplify supports apps in generic monorepos as well as apps in monorepos created using npm workspace, pnpm workspace, Yarn workspace, Nx, and Turborepo. When you deploy your app, Amplify automatically detects the monorepo build tool that you are using. Amplify automatically applies build settings for apps in an npm workspace, Yarn workspace or Nx. Turborepo and pnpm apps require additional conﬁguration. For more information, see Conﬁguring Turborepo and pnpm monorepo apps. You can save the build settings for a monorepo in the Amplify console or you can download the amplify.yml ﬁle and add it to the root of your repository. Amplify applies the settings saved in Conﬁguring monorepo build settings 126 AWS Amplify Hosting User Guide the console to all of your branches unless it ﬁnds an amplify.yml ﬁle in your repository. When an amplify.yml ﬁle is present, its settings override any build settings saved in the Amplify console. Monorepo build speciﬁcation YAML syntax reference The YAML syntax for a monorepo build speciﬁcation diﬀers from the YAML syntax for a repo that contains a single application. For a monorepo, you declare each project in a list of applications. You must provide the following additional appRoot key for each application you declare in your monorepo build speciﬁcation: appRoot The root, within the repository, that the application starts in. This key must exist, and have the same value as the AMPLIFY_MONOREPO_APP_ROOT environment variable. For instructions on setting this environment variable, see Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable. The following monorepo build speciﬁcation example demonstrates how to declare multiple Amplify applications in the same repo. The two apps, react-app, and angular-app are declared in the applications list. The appRoot key for each app indicates that the app is located in the apps root folder in the repo. The buildpath attribute is set to / to run and build the app from the monorepo project root. The baseDirectory attribute is the relative path of buildpath. Monorepo build speciﬁcation YAML syntax version: 1 applications: - appRoot: apps/react-app env: variables: key: value backend: phases: preBuild: commands: - enter command build: commands: - enter command Monorepo build speciﬁcation YAML syntax reference 127 AWS Amplify Hosting
amplify-console-ug-043	amplify-console-ug.pdf	43	in the same repo. The two apps, react-app, and angular-app are declared in the applications list. The appRoot key for each app indicates that the app is located in the apps root folder in the repo. The buildpath attribute is set to / to run and build the app from the monorepo project root. The baseDirectory attribute is the relative path of buildpath. Monorepo build speciﬁcation YAML syntax version: 1 applications: - appRoot: apps/react-app env: variables: key: value backend: phases: preBuild: commands: - enter command build: commands: - enter command Monorepo build speciﬁcation YAML syntax reference 127 AWS Amplify Hosting User Guide postBuild: commands: - enter command frontend: buildPath: / # Run install and build from the monorepo project root phases: preBuild: commands: - enter command - enter command build: commands: - enter command artifacts: files: - location - location discard-paths: yes baseDirectory: location cache: paths: - path - path test: phases: preTest: commands: - enter command test: commands: - enter command postTest: commands: - enter command artifacts: files: - location - location configFilePath: location baseDirectory: location - appRoot: apps/angular-app env: variables: key: value Monorepo build speciﬁcation YAML syntax reference 128 User Guide AWS Amplify Hosting backend: phases: preBuild: commands: - enter command build: commands: - enter command postBuild: commands: - enter command frontend: phases: preBuild: commands: - enter command - enter command build: commands: - enter command artifacts: files: - location - location discard-paths: yes baseDirectory: location cache: paths: - path - path test: phases: preTest: commands: - enter command test: commands: - enter command postTest: commands: - enter command artifacts: files: - location Monorepo build speciﬁcation YAML syntax reference 129 AWS Amplify Hosting User Guide - location configFilePath: location baseDirectory: location An app using the following example build speciﬁcation, will be built under the project root and the build artifacts will be located at /packages/nextjs-app/.next. applications: - frontend: buildPath: '/' # run install and build from monorepo project root phases: preBuild: commands: - npm install build: commands: - npm run build --workspace=nextjs-app artifacts: baseDirectory: packages/nextjs-app/.next files: - '*/' cache: paths: - node_modules/*/ appRoot: packages/nextjs-app Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable When you deploy an app stored in a monorepo, the app's AMPLIFY_MONOREPO_APP_ROOT environment variable must have the same value as the path of the app root, relative to the root of your repository. For example, a monorepo named ExampleMonorepo with a root folder named apps, that contains, app1, app2, and app3 has the following directory structure: ExampleMonorepo apps app1 app2 app3 Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable 130 AWS Amplify Hosting User Guide In this example, the value of the AMPLIFY_MONOREPO_APP_ROOT environment variable for app1 is apps/app1. When you deploy a monorepo app using the Amplify console, the console automatically sets the AMPLIFY_MONOREPO_APP_ROOT environment variable using the value that you specify for the path to the app's root. However, if your monorepo app already exists in Amplify or is deployed using AWS CloudFormation, you must manually set the AMPLIFY_MONOREPO_APP_ROOT environment variable in the Environment variables section in the Amplify console. Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable automatically during deployment The following instructions demonstrate how to deploy a monorepo app with the Amplify console. Amplify automatically sets the AMPLIFY_MONOREPO_APP_ROOT environment variable using the app's root folder that you specify in the console. To deploy a monorepo app with the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose Create new app in the upper right corner. 3. On the Start building with Amplify page, choose your Git provider, then choose Next. 4. On the Add repository branch page, do the following: a. Choose the name of your repository from the list. b. Choose the name of the branch to use. c. d. e. Select My app is a monorepo Enter the path to your app in your monorepo, for example, apps/app1. Choose Next. 5. On the App settings page, you can use the default settings or customize the build settings for your app. In the Environment variables section, Amplify sets AMPLIFY_MONOREPO_APP_ROOT to the path you speciﬁed in step 4d. 6. Choose Next. 7. On the Review page, choose Save and deploy. Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable 131 AWS Amplify Hosting User Guide Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable for an existing app Use the following instructions to manually set the AMPLIFY_MONOREPO_APP_ROOT environment variable for an app that is already deployed to Amplify, or has been created using CloudFormation. To set the AMPLIFY_MONOREPO_APP_ROOT environment variable for an existing app 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the name of the app to set the environment variable for. 3. In the navigation pane, choose Hosting, and then choose Environment variables. 4. On the Environment variables page, choose Manage variables. 5. In the Manage variables section, do the following: a.
amplify-console-ug-044	amplify-console-ug.pdf	44	AMPLIFY_MONOREPO_APP_ROOT environment variable for an existing app Use the following instructions to manually set the AMPLIFY_MONOREPO_APP_ROOT environment variable for an app that is already deployed to Amplify, or has been created using CloudFormation. To set the AMPLIFY_MONOREPO_APP_ROOT environment variable for an existing app 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the name of the app to set the environment variable for. 3. In the navigation pane, choose Hosting, and then choose Environment variables. 4. On the Environment variables page, choose Manage variables. 5. In the Manage variables section, do the following: a. b. c. d. Choose Add new. For Variable, enter the key AMPLIFY_MONOREPO_APP_ROOT. For Value, enter the path to the app, for example apps/app1. For Branch, by default Amplify applies the environment variable to all branches. 6. Choose Save. Conﬁguring Turborepo and pnpm monorepo apps The Turborepo and pnpm workspace monorepo build tools get conﬁguration information from .npmrc ﬁles. When you deploy a monorepo app created with one of these tools, you must have an .npmrc ﬁle in your project root directory. In the .npmrc ﬁle, set the linker for installing Node packages to hoisted. You can copy the following line to your ﬁle. node-linker=hoisted For more information about .npmrc ﬁles and settings, see pnpm .npmrc in the pnpm documentation. Pnpm is not included in the Amplify default build container. For pnpm workspace and Turborepo apps, you must add a command to install pnpm in the preBuild phase of your app's build settings. Conﬁguring Turborepo and pnpm monorepo apps 132 AWS Amplify Hosting User Guide The following example excerpt from a build speciﬁcation shows a preBuild phase with a command to install pnpm. version: 1 applications: - frontend: phases: preBuild: commands: - npm install -g pnpm Conﬁguring Turborepo and pnpm monorepo apps 133 AWS Amplify Hosting User Guide Feature branch deployments and team workﬂows Amplify Hosting is designed to work with feature branch and GitFlow workﬂows. Amplify uses Git branches to create a new deployment each time you connect a new branch in your repository. After you connect your ﬁrst branch, you create additional feature branches. To add a branch to an app 1. Choose the app you want to add a branch to. 2. Choose App settings, then Branch settings. 3. On the Branch settings page, choose Add branch. 4. Select a branch from your repository. 5. Choose Add branch. 6. Redeploy your app. After you add a branch, your app has two deployments available at the Amplify default domains, such as https://main.appid.amplifyapp.com and https://dev.appid.amplifyapp.com. This may vary from team-to-team, but typically the main branch tracks release code and is your production branch. The develop branch is used as an integration branch to test new features. This enables beta testers to test unreleased features on the develop branch deployment, without aﬀecting any of the production end users on the main branch deployment. Topics • Team workﬂows with fullstack Amplify Gen 2 apps • Team workﬂows with fullstack Amplify Gen 1 apps • Pattern-based feature branch deployments • Automatic build-time generation of Amplify conﬁg (Gen 1 apps only) • Conditional backend builds (Gen 1 apps only) • Use Amplify backends across apps (Gen 1 apps only) 134 AWS Amplify Hosting User Guide Team workﬂows with fullstack Amplify Gen 2 apps AWS Amplify Gen 2 introduces a TypeScript-based, code-ﬁrst developer experience for deﬁning backends. To learn about fullstack workﬂows with Amplify Gen 2 applications, see Fullstack workﬂows in the Amplify docs. Team workﬂows with fullstack Amplify Gen 1 apps A feature branch deployment consists of a frontend, and an optional backend environment. The frontend is built and deployed to a global content delivery network (CDN), while the backend is deployed by Amplify Studio or the Amplify CLI to AWS. To learn how to set up this deployment scenario, see Building a backend for an application. Amplify Hosting continuously deploys backend resources such as GraphQL APIs and Lambda functions with your feature branch deployments. You can use the following branching models to deploy your backend and frontend with Amplify Hosting. Feature branch workﬂow • Create prod, test, and dev backend environments with Amplify Studio or the Amplify CLI. • Map the prod backend to the main branch. • Map the test backend to the develop branch. • Team members can use the dev backend environment for testing individual feature branches. Team workﬂows with fullstack Amplify Gen 2 apps 135 AWS Amplify Hosting User Guide 1. Install the Amplify CLI to initialize a new Amplify project. npm install -g @aws-amplify/cli 2. Initialize a prod backend environment for your project. If you don’t have a project, create one using bootstrap tools like create-react-app or Gatsby. create-react-app next-unicorn cd next-unicorn amplify init ? Do you want to use an existing environment? (Y/n): n ? Enter a
amplify-console-ug-045	amplify-console-ug.pdf	45	to the main branch. • Map the test backend to the develop branch. • Team members can use the dev backend environment for testing individual feature branches. Team workﬂows with fullstack Amplify Gen 2 apps 135 AWS Amplify Hosting User Guide 1. Install the Amplify CLI to initialize a new Amplify project. npm install -g @aws-amplify/cli 2. Initialize a prod backend environment for your project. If you don’t have a project, create one using bootstrap tools like create-react-app or Gatsby. create-react-app next-unicorn cd next-unicorn amplify init ? Do you want to use an existing environment? (Y/n): n ? Enter a name for the environment: prod ... amplify push 3. Add test and dev backend environments. amplify env add ? Do you want to use an existing environment? (Y/n): n ? Enter a name for the environment: test ... amplify push Feature branch workﬂow 136 AWS Amplify Hosting amplify env add ? Do you want to use an existing environment? (Y/n): n ? Enter a name for the environment: dev ... amplify push User Guide 4. Push code to a Git repository of your choice (in this example we’ll assume you pushed to main). git commit -am 'Added dev, test, and prod environments' git push origin main 5. Visit Amplify in the AWS Management Console to see your current backend environment. Navigate a level up from the breadcrumb to view a list of all backend environments created in the Backend environments tab. Feature branch workﬂow 137 AWS Amplify Hosting User Guide 6. Switch to the Frontend environments tab and connect your repository provider and main branch. 7. On the build settings page, select an existing backend environment to set up continuous deployment with the main branch. Choose prod from the list and grant the service role to Feature branch workﬂow 138 AWS Amplify Hosting User Guide Amplify. Choose Save and deploy. After the build completes you will get a main branch deployment available at https://main.appid.amplifyapp.com. 8. Connect develop branch in Amplify (assume develop and main branch are the same at this point). Choose the test backend environment. Feature branch workﬂow 139 AWS Amplify Hosting User Guide 9. Amplify is now set up. You can start working on new features in a feature branch. Add backend functionality by using the dev backend environment from your local workstation. git checkout -b newinternet amplify env checkout dev amplify add api ... amplify push 10.After you ﬁnish working on the feature, commit your code, create a pull request to review internally. git commit -am 'Decentralized internet v0.1' git push origin newinternet 11.To preview what the changes will look like, go to the Amplify console and connect your feature branch. Note: If you have the AWS CLI installed on your system (Not the Amplify CLI), you can connect a branch directly from your terminal. You can ﬁnd your appid by going to App settings > General > AppARN: arn:aws:amplify:<region>:<region>:apps/<appid> aws amplify create-branch --app-id <appid> --branch-name <branchname> aws amplify start-job --app-id <appid> --branch-name <branchname> --job-type RELEASE 12.Your feature will be accessible at https://newinternet.appid.amplifyapp.com to share with your teammates. If everything looks good merge the PR to the develop branch. git checkout develop git merge newinternet git push 13.This will kickoﬀ a build that will update the backend as well as the frontend in Amplify with a branch deployment at https://dev.appid.amplifyapp.com. You can share this link with internal stakeholders so they can review the new feature. 14.Delete your feature branch from Git, Amplify, and remove the backend environment from the cloud (you can always spin up a new one based on by running ‘amplify env checkout prod’ and running ‘amplify env add’). git push origin --delete newinternet aws amplify delete-branch --app-id <appid> --branch-name <branchname> amplify env remove dev Feature branch workﬂow 140 AWS Amplify Hosting GitFlow workﬂow User Guide GitFlow uses two branches to record the history of the project. The main branch tracks release code only, and the develop branch is used as an integration branch for new features. GitFlow simpliﬁes parallel development by isolating new development from completed work. New development (such as features and non-emergency bug ﬁxes) is done in feature branches. When the developer is satisﬁed that the code is ready for release, the feature branch is merged back into the integration develop branch. The only commits to the main branch are merges from release branches and hotﬁx branches (to ﬁx emergency bugs). The diagram below shows a recommended setup with GitFlow. You can follow the same process as described in the feature branch workﬂow section above. Per-developer sandbox • Each developer in a team creates a sandbox environment in the cloud that is separate from their local computer. This allows developers to work in isolation from each other without overwriting other team members’ changes. • Each branch in Amplify has its own backend.
amplify-console-ug-046	amplify-console-ug.pdf	46	feature branch is merged back into the integration develop branch. The only commits to the main branch are merges from release branches and hotﬁx branches (to ﬁx emergency bugs). The diagram below shows a recommended setup with GitFlow. You can follow the same process as described in the feature branch workﬂow section above. Per-developer sandbox • Each developer in a team creates a sandbox environment in the cloud that is separate from their local computer. This allows developers to work in isolation from each other without overwriting other team members’ changes. • Each branch in Amplify has its own backend. This ensures that the Amplify uses the Git repository as a single source of truth from which to deploy changes, rather than relying on GitFlow workﬂow 141 AWS Amplify Hosting User Guide developers on the team to manually push their backend or front end to production from their local computers. 1. Install the Amplify CLI to initialize a new Amplify project. npm install -g @aws-amplify/cli 2. Initialize a mary backend environment for your project. If you don’t have a project, create one using bootstrap tools like create-react-app or Gatsby. Per-developer sandbox 142 AWS Amplify Hosting cd next-unicorn amplify init ? Do you want to use an existing environment? (Y/n): n ? Enter a name for the environment: mary ... amplify push User Guide 3. Push code to a Git repository of your choice (in this example we’ll assume you pushed to main. git commit -am 'Added mary sandbox' git push origin main 4. Connect your repo > main to Amplify. 5. The Amplify console will detect backend environments created by the Amplify CLI. Choose Create new environment from the dropdown and grant the service role to Amplify. Choose Save and deploy. After the build completes you will get a main branch deployment available at https://main.appid.amplifyapp.com with a new backend environment that is linked to the branch. 6. Connect develop branch in Amplify (assume develop and main branch are the same at this point) and choose Create Pattern-based feature branch deployments Pattern-based branch deployments allow you to automatically deploy branches that match a speciﬁc pattern to Amplify. Product teams using feature branch or GitFlow workﬂows for their releases, can now deﬁne patterns such as release** to automatically deploy Git branches that begin with ‘release’ to a shareable URL. 1. Choose App settings, then Branch settings. 2. On the Branch settings page, choose Edit. 3. Select Branch autodetection to automatically connect branches to Amplify that match a pattern set. 4. In the Branch autodetection - patterns box, enter the patterns for automatically deploying branches. • * – Deploys all branches in your repository. • release* – Deploys all branches that begin with the word ‘release'. Pattern-based feature branch deployments 143 AWS Amplify Hosting User Guide • release/ – Deploys all branches that match a ‘release /’ pattern. • Specify multiple patterns in a comma-separated list. For example, release, feature*. 5. Set up automatic password protection for all branches that are automatically created by selecting Branch autodetection access control . 6. For Gen 1 applications built with an Amplify backend, you can choose to create a new environment for every connected branch, or point all branches to an existing backend. 7. Choose Save. Pattern-based feature branch deployments for an app connected to a custom domain You can use pattern-based feature branch deployments for an app connected to an Amazon Route 53 custom domain. • For instructions on setting up pattern-based feature branch deployments, see Setting up automatic subdomains for an Amazon Route 53 custom domain • For instructions on connecting an Amplify app to a custom domain managed in Route 53, see Adding a custom domain managed by Amazon Route 53 • For more information about using Route 53, see What is Amazon Route 53. Automatic build-time generation of Amplify conﬁg (Gen 1 apps only) Note The information in this section is for Gen 1 apps only. If you want to automatically deploy infrastructure and application code changes from feature branches for a Gen 2 app, see Fullstack branch deployments in the Amplify docs Amplify supports the automatic build-time generation of the Amplify conﬁg aws-exports.js ﬁle for Gen 1 apps. By turning oﬀ full stack CI/CD deployments, you enable your app to autogenerate the aws-exports.js ﬁle and ensure that updates are not made to your backend at build-time. Pattern-based feature branch deployments for an app connected to a custom domain 144 AWS Amplify Hosting User Guide To autogenerate aws-exports.js at build-time 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to edit. 3. Choose the Hosting environments tab. 4. Locate the branch to edit and choose Edit. 5. On the Edit target backend page, uncheck Enable full-stack continuous deployments (CI/ CD) to turn oﬀ full-stack
amplify-console-ug-047	amplify-console-ug.pdf	47	full stack CI/CD deployments, you enable your app to autogenerate the aws-exports.js ﬁle and ensure that updates are not made to your backend at build-time. Pattern-based feature branch deployments for an app connected to a custom domain 144 AWS Amplify Hosting User Guide To autogenerate aws-exports.js at build-time 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to edit. 3. Choose the Hosting environments tab. 4. Locate the branch to edit and choose Edit. 5. On the Edit target backend page, uncheck Enable full-stack continuous deployments (CI/ CD) to turn oﬀ full-stack CI/CD for this backend. 6. Select an existing service role to give Amplify the permissions it requires to make changes to your app backend. If you need to create a service role, choose Create new role. For more information about creating a service role, see Adding a service role with permissions to deploy backend resources. 7. Choose Save. Amplify applies these changes the next time you build the app. Automatic build-time generation of Amplify conﬁg (Gen 1 apps only) 145 AWS Amplify Hosting User Guide Conditional backend builds (Gen 1 apps only) Note The information in this section is for Gen 1 apps only. Amplify Gen 2 introduces a TypeScript-based, code-ﬁrst developer experience. Therefore, this feature isn't necessary for Gen 2 backends. Amplify supports conditional backend builds on all branches in a Gen 1 app. To conﬁgure conditional backend builds, set the AMPLIFY_DIFF_BACKEND environment variable to true. Enabling conditional backend builds will help speed up builds where changes are made only to the frontend. When you enable diﬀ based backend builds, at the start of each build, Amplify attempts to run a diﬀ on the amplify folder in your repository. If Amplify doesn't ﬁnd any diﬀerences, it skips the backend build step, and doesn't update your backend resources. If your project doesn't have an amplify folder in your repository, Amplify ignores the value of the AMPLIFY_DIFF_BACKEND environment variable. For instructions on setting the AMPLIFY_DIFF_BACKEND environment variable, see Conﬁguring diﬀ based backend builds for a Gen 1 app. If you currently have custom commands speciﬁed in the build settings of your backend phase, conditional backend builds won't work. If you want those custom commands to run, you must move them to the frontend phase of your build settings in your app's amplify.yml ﬁle. For more information about updating the amplify.yml ﬁle, see Understanding the build speciﬁcation. Use Amplify backends across apps (Gen 1 apps only) Note The information in this section is for Gen 1 apps only. If you want to share backend resources for a Gen 2 app, see Share resources across branches in the Amplify docs Amplify enables you to reuse existing backend environments across all of your Gen 1 apps in a given region. You can do this when you create a new app, connect a new branch to an existing app, or update an existing frontend to point to a diﬀerent backend environment. Conditional backend builds (Gen 1 apps only) 146 AWS Amplify Hosting User Guide Reuse backends when creating a new app To reuse a backend when creating a new Amplify app 1. 2. Sign in to the AWS Management Console and open the Amplify console. To create a new backend to use for this example, do the following: a. In the navigation pane, choose All apps. b. Choose New app, Build an app. c. Enter a name for your app, such as Example-Amplify-App. d. Choose Conﬁrm deployment. 3. To connect a frontend to your new backend, choose the Hosting environments tab. 4. Choose your git provider, and then choose Connect branch. 5. On the Add repository branch page, for Recently updated repositories, choose your repository name. For Branch, select the branch from your repository to connect. 6. On the Build settings, page do the following: a. b. For App name, select the app to use for adding a backend environment. You can choose the current app or any other app in the current region. For Environment, select the name of the backend environment to add. You can use an existing environment or create a new one. c. By default, full-stack CI/CD is turned oﬀ. Turning oﬀ full-stack CI/CD causes the app to run in pull only mode. At build time, Amplify will automatically generate the aws- exports.js ﬁle only, without modifying your backend environment. d. Select an existing service role to give Amplify the permissions it requires to make changes to your app backend. If you need to create a service role, choose Create new role. For more information about creating a service role, see Adding a service role with permissions to deploy backend resources. e. Choose Next. 7. Choose Save and deploy. Reuse backends when creating a new app 147 AWS Amplify Hosting User
amplify-console-ug-048	amplify-console-ug.pdf	48	oﬀ full-stack CI/CD causes the app to run in pull only mode. At build time, Amplify will automatically generate the aws- exports.js ﬁle only, without modifying your backend environment. d. Select an existing service role to give Amplify the permissions it requires to make changes to your app backend. If you need to create a service role, choose Create new role. For more information about creating a service role, see Adding a service role with permissions to deploy backend resources. e. Choose Next. 7. Choose Save and deploy. Reuse backends when creating a new app 147 AWS Amplify Hosting User Guide Reuse backends when connecting a branch to an existing app To reuse a backend when connecting a branch to an existing Amplify app 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to connect a new branch to. 3. 4. In the navigation pane, choose App Settings, General. In the Branches section, choose Connect a branch. 5. On the Add repository branch page, for Branch, select the branch from your repository to connect. 6. 7. For App name, select the app to use for adding a backend environment. You can choose the current app or any other app in the current region. For Environment, select the name of the backend environment to add. You can use an existing environment or create a new one. 8. If you need to set up a service role to give Amplify the permissions it requires to make changes to your app backend, the console prompts you to perform this task. For more information about creating a service role, see Adding a service role with permissions to deploy backend resources. 9. By default, full-stack CI/CD is turned oﬀ. Turning oﬀ full-stack CI/CD causes the app to run in pull only mode. At build time, Amplify will automatically generate the aws-exports.js ﬁle only, without modifying your backend environment. 10. Choose Next. 11. Choose Save and deploy. Edit an existing frontend to point to a diﬀerent backend To edit a frontend Amplify app to point to a diﬀerent backend 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to edit the backend for. 3. Choose the Hosting environments tab. 4. Locate the branch to edit and choose Edit. Reuse backends when connecting a branch to an existing app 148 AWS Amplify Hosting User Guide 5. On the Select a backend environment to use with this branch page, for App name, select the frontend app that you want to edit the backend environment for. You can choose the current app or any other app in the current region. 6. For Backend environment, select the name of the backend environment to add. 7. By default, full-stack CI/CD is enabled. Uncheck this option to turn oﬀ full-stack CI/CD for this backend. Turning oﬀ full-stack CI/CD causes the app to run in pull only mode. At build time, Amplify will automatically generate the aws-exports.js ﬁle only, without modifying the backend environment. 8. Choose Save. Amplify applies these changes the next time you build the app. Edit an existing frontend to point to a diﬀerent backend 149 AWS Amplify Hosting User Guide Building a backend for an application With AWS Amplify you can build a fullstack application with data, authentication, storage, and frontend hosting that is deployed to AWS. AWS Amplify Gen 2 introduces a TypeScript-based, code-ﬁrst developer experience for deﬁning backends. To learn how to use Amplify Gen 2 to build and connect a backend to your app, see Build & connect backend in the Amplify docs. If you are looking for the documentation for building a backend for a Gen 1 app, using the CLI and Amplify Studio, see Build & connect backend in the Gen 1 Amplify docs. Topics • Create a backend for a Gen 2 app • Create a backend for a Gen 1 app Create a backend for a Gen 2 app For a tutorial that guides you through the steps for creating an Amplify Gen 2 fullstack application with a TypeScript-based backend, see Get started in the Amplify docs. Create a backend for a Gen 1 app In this tutorial, you will set up a fullstack CI/CD workﬂow with Amplify. You will deploy a frontend app to Amplify Hosting. Then you will create a backend using Amplify Studio. Finally, you will connect the cloud backend to the frontend app. Prerequisites Before you begin this tutorial, complete the following prerequisites. Sign up for an AWS account If you are not already an AWS customer, you need to create an AWS account by following the online instructions. Signing up enables you to access Amplify and other AWS services that you can use with your application. Create a backend for a
amplify-console-ug-049	amplify-console-ug.pdf	49	this tutorial, you will set up a fullstack CI/CD workﬂow with Amplify. You will deploy a frontend app to Amplify Hosting. Then you will create a backend using Amplify Studio. Finally, you will connect the cloud backend to the frontend app. Prerequisites Before you begin this tutorial, complete the following prerequisites. Sign up for an AWS account If you are not already an AWS customer, you need to create an AWS account by following the online instructions. Signing up enables you to access Amplify and other AWS services that you can use with your application. Create a backend for a Gen 2 app 150 AWS Amplify Hosting Create a Git repository User Guide Amplify supports GitHub, Bitbucket, GitLab, and AWS CodeCommit. Push your application to your Git repository. Install the Amplify Command Line Interface (CLI) For instructions, see Install the Amplify CLI in the Amplify Framework Documentation. Step 1: Deploy a frontend If you have an existing frontend app in a git repository that you want to use for this example, you can proceed to the instructions for deploying a frontend app. If you need to create a new frontend app to use for this example, you can follow the Create React App instructions in the Create React App documentation. To deploy a frontend app 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, choose New app, then Host web app in the upper right corner. 3. Select your GitHub, Bitbucket, GitLab, or AWS CodeCommit repository provider and then choose Continue. 4. Amplify authorizes access to your git repository. For GitHub repositories, Amplify now uses the GitHub Apps feature to authorize Amplify access. For more information about installing and authorizing the GitHub App, see Setting up Amplify access to GitHub repositories. 5. On the Add repository branch page do the following: a. b. c. In the Recently updated repositories list, select the name of the repository to connect. In the Branch list, select the name of the repository branch to connect. Choose Next. 6. On the Conﬁgure build settings page, choose Next. 7. On the Review page, choose Save and deploy. When the deployment is complete, you can view your app on the amplifyapp.com default domain. Step 1: Deploy a frontend 151 AWS Amplify Hosting Note User Guide To augment the security of your Amplify applications, the amplifyapp.com domain is registered in the Public Suﬃx List (PSL). For further security, we recommend that you use cookies with a __Host- preﬁx if you ever need to set sensitive cookies in the default domain name for your Amplify applications. This practice will help to defend your domain against cross-site request forgery attempts (CSRF). For more information see the Set- Cookie page in the Mozilla Developer Network. Step 2: Create a backend Now that you have deployed a frontend app to Amplify Hosting, you can create a backend. Use the following instructions to create a backend with a simple database and GraphQL API endpoint. To create a backend 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, select the app that you created in Step 1. 3. On the app homepage, choose the Backend environments tab, then choose Get started. This initiates the set up process for a default staging environment. 4. After the set up ﬁnishes, choose Launch Studio to access the staging backend environment in Amplify Studio. Amplify Studio is a visual interface to create and manage your backend and accelerate your frontend UI development. For more information about Amplify Studio, see the Amplify Studio documentation. Use the following instructions to create a simple database using the Amplify Studio visual backend builder interface. Create a data model 1. On the home page for your app's staging environment, choose Create data model. This opens the data model designer. 2. On the Data modeling page, choose Add model. 3. For the title, enter Todo. Step 2: Create a backend 152 AWS Amplify Hosting 4. Choose Add a ﬁeld. 5. For Field name, enter Description. User Guide The following screenshot is an example of how your data model will look in the designer. 6. Choose Save and Deploy. 7. Return to the Amplify Hosting console and the staging environment deployment will be in progress. During deployment, Amplify Studio creates all the required AWS resources in the backend, including an AWS AppSync GraphQL API to access data and an Amazon DynamoDB table to host the Todo items. Amplify uses AWS CloudFormation to deploy your backend, which enables you to store your backend deﬁnition as infrastructure-as-code. Step 3: Connect the backend to the frontend Now that you have deployed a frontend and created a cloud backend that contains a data model, you need to connect them.
amplify-console-ug-050	amplify-console-ug.pdf	50	Choose Save and Deploy. 7. Return to the Amplify Hosting console and the staging environment deployment will be in progress. During deployment, Amplify Studio creates all the required AWS resources in the backend, including an AWS AppSync GraphQL API to access data and an Amazon DynamoDB table to host the Todo items. Amplify uses AWS CloudFormation to deploy your backend, which enables you to store your backend deﬁnition as infrastructure-as-code. Step 3: Connect the backend to the frontend Now that you have deployed a frontend and created a cloud backend that contains a data model, you need to connect them. Use the following instructions to pull your backend deﬁnition down to your local app project with the Amplify CLI. To connect a cloud backend to a local frontend 1. Open a terminal window and navigate to the root directory of your local project. 2. Run the following command in the terminal window, replacing the red text with the unique app ID and backend environment name for your project. Step 3: Connect the backend to the frontend 153 AWS Amplify Hosting User Guide amplify pull --appId abcd1234 --envName staging 3. Follow the instructions in the terminal window to complete the project set up. Now you can conﬁgure the build process to add the backend to the continuous deployment workﬂow. Use the following instructions to connect a frontend branch with a backend in the Amplify Hosting console. To connect a frontend app branch and cloud backend 1. On the app homepage, choose the Hosting environments tab. 2. Locate the main branch and choose Edit. 3. In the Edit target backend window, for Environment, select the name of the backend to connect. In this example, choose the staging backend that you created in Step 2. By default, full-stack CI/CD is enabled. Uncheck this option to turn oﬀ full-stack CI/CD for this backend. Turning oﬀ full-stack CI/CD causes the app to run in pull only mode. At build time, Amplify will automatically generate the aws-exports.js ﬁle only, without modifying your backend environment. 4. Next, you must set up a service role to give Amplify the permissions it requires to make changes to your app backend. You can either use an existing service role or create a new one. For instructions, see Adding a service role with permissions to deploy backend resources. 5. After adding a service role, return to the Edit target backend window and choose Save. Step 3: Connect the backend to the frontend 154 AWS Amplify Hosting User Guide 6. To ﬁnish connecting the staging backend to the main branch of the frontend app, perform a new build of your project. Do one of the following: • • From your git repository, push some code to initiate a build in the Amplify console. In the Amplify console, navigate to the app's build details page and choose Redeploy this version. Next steps Set up feature branch deployments Follow our recommended workﬂow to set up feature branch deployments with multiple backend environments. Create a frontend UI in Amplify Studio Use Studio to build your frontend UI with a set of ready-to-use UI components, and then connect it to your app backend. For more information and tutorials, see the user guide for Amplify Studio in the Amplify Framework Documentation. Next steps 155 AWS Amplify Hosting User Guide Setting up redirects and rewrites for an Amplify application Redirects enable a web server to reroute navigation from one URL to another. Common reasons for using redirects include to customize the appearance of a URL, to avoid broken links, to move the hosting location of an app or site without changing its address, and to change a requested URL to the form needed by a web app. Understanding the redirects that Amplify supports Amplify supports the following redirect types in the console. Permanent redirect (301) 301 redirects are intended for lasting changes to the destination of a web address. Search engine ranking history of the original address applies to the new destination address. Redirection occurs on the client-side, so a browser navigation bar shows the destination address after redirection. Common reasons to use 301 redirects include: • To avoid a broken link when the address of a page changes. • To avoid a broken link when a user makes a predictable typo in an address. Temporary redirect (302) 302 redirects are intended for temporary changes to the destination of a web address. Search engine ranking history of the original address doesn’t apply to the new destination address. Redirection occurs on the client-side, so a browser navigation bar shows the destination address after redirection. Common reasons to use 302 redirects include: • To provide a detour destination while repairs are made to an original address. • To provide test pages for A/B comparison of a user interface. Understanding the
amplify-console-ug-051	amplify-console-ug.pdf	51	changes. • To avoid a broken link when a user makes a predictable typo in an address. Temporary redirect (302) 302 redirects are intended for temporary changes to the destination of a web address. Search engine ranking history of the original address doesn’t apply to the new destination address. Redirection occurs on the client-side, so a browser navigation bar shows the destination address after redirection. Common reasons to use 302 redirects include: • To provide a detour destination while repairs are made to an original address. • To provide test pages for A/B comparison of a user interface. Understanding the redirects that Amplify supports 156 AWS Amplify Hosting Note User Guide If your app is returning an unexpected 302 response, the error is likely caused by changes you've made to your app’s redirect and custom header conﬁguration. To resolve this issue, verify that your custom headers are valid, and then re-enable the default 404 rewrite rule for your app. Rewrite (200) 200 redirects (rewrites) are intended to show content from the destination address as if it were served from the original address. Search engine ranking history continues to apply to the original address. Redirection occurs on the server-side, so a browser navigation bar shows the original address after redirection. Common reasons to use 200 redirects include: • To redirect an entire site to a new hosting location without changing the address of the site. • To redirect all traﬃc to a single page web app (SPA) to its index.html page for handling by a client-side router function. Not Found (404) 404 redirects occur when a request points to an address that doesn’t exist. The destination page of a 404 is displayed instead of the requested one. Common reasons a 404 redirect occurs include: • To avoid a broken link message when a user enters a bad URL. • To point requests to nonexistent pages of a web app to its index.html page for handling by a client-side router function. Understanding the order of redirects Redirects are applied from the top of the list down. Make sure that your ordering has the eﬀect you intend. For example, the following order of redirects causes all requests for a given path under / docs/ to redirect to the same path under /documents/, except /docs/speciﬁc-ﬁlename.html which redirects to /documents/diﬀerent-ﬁlename.html: /docs/specific-filename.html /documents/different-filename.html 301 Understanding the order of redirects 157 AWS Amplify Hosting /docs/<> /documents/<> User Guide The following order of redirects ignores the redirection of speciﬁc-ﬁlename.html to diﬀerent- ﬁlename.html: /docs/<> /documents/<> /docs/specific-filename.html /documents/different-filename.html 301 Understanding how Amplify forwards query parameters You can use query parameters for more control over your URL matches. Amplify forwards all query parameters to the destination path for 301 and 302 redirects, with the following exceptions: • If the original address includes a query string set to a speciﬁc value, Amplify doesn't forward query parameters. In this case, the redirect only applies to requests to the destination URL with the speciﬁed query value. • If the destination address for the matching rule has query parameters, query parameters aren't forwarded. For example, if the destination address for the redirect is https://example- target.com?q=someParam, query parameters aren't passed through. Creating and editing redirects in the Amplify console You can create and edit redirects for an application in the Amplify console. Before you get started, you will need the following information about the parts of a redirect. An original address The address the user requested. A destination address The address that actually serves the content that the user sees. A redirect type Types include a permanent redirect (301), a temporary redirect (302), a rewrite (200), or not found (404). A two letter country code (optional) A value you can include to segment the user experience of your app by geographical region. Understanding how Amplify forwards query parameters 158 AWS Amplify Hosting User Guide To create a redirect in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app you want to create a redirect for. 3. In the navigation pane, choose Hosting, and then choose Rewrites and redirects. 4. On the Rewrites and redirects page, choose Manage redirects. 5. Manually add or update redirects in the Rewrites and redirects JSON editor. a. b. c. d. For source, specify the original address the user requested. For status, specify the type of redirect. For target, specify the destination address that renders the content to the user. (Optional) For condition, enter a two letter country code condition. 6. Choose Save. Redirects and rewrites example reference This section provides examples for a variety of common redirect scenarios. You can use these examples to understand the JSON syntax for creating your own redirects and rewrites in the Amplify console JSON editor. Note Original address domain matching is case-insensitive. Topics •
amplify-console-ug-052	amplify-console-ug.pdf	52	the Rewrites and redirects JSON editor. a. b. c. d. For source, specify the original address the user requested. For status, specify the type of redirect. For target, specify the destination address that renders the content to the user. (Optional) For condition, enter a two letter country code condition. 6. Choose Save. Redirects and rewrites example reference This section provides examples for a variety of common redirect scenarios. You can use these examples to understand the JSON syntax for creating your own redirects and rewrites in the Amplify console JSON editor. Note Original address domain matching is case-insensitive. Topics • Simple redirects and rewrites • Redirects for single page web apps (SPA) • Reverse proxy rewrite • Trailing slashes and clean URLs • Placeholders • Query strings and path parameters • Region-based redirects • Using wildcard expressions in redirects and rewrites Example redirects and rewrites 159 AWS Amplify Hosting User Guide Simple redirects and rewrites You can use the following example to permanently redirect a speciﬁc page to a new address. Original address Destination Address Redirect Type Country Code /original.html /destinat permanent ion.html redirect (301) JSON format [ { "source": "/original.html", "status": "301", "target": "/destination.html", "condition": null } ] You can use the following example to redirect any path under a folder to the same path under a diﬀerent folder. Original address Destination Address Redirect Type Country Code /docs/<> /documents/<> permanent redirect (301) JSON format [ { "source": "/docs/<>", "status": "301", "target": "/documents/<>", "condition": null } Simple redirects and rewrites 160 AWS Amplify Hosting ] User Guide You can use the following example to redirect all traﬃc 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. Original address Destination Address Redirect Type Country Code /<> /index.html rewrite (200) JSON format [ { "source": "/<>", "status": "200", "target": "/index.html", "condition": null } ] You can use the following example to use a rewrite to change the subdomain that appears to the user. Original address Destination Address Redirect Type Country Code https://m ydomain.com https://w ww.mydoma in.com rewrite (200) JSON format [ { "source": "https://mydomain.com", "status": "200", "target": "https://www.mydomain.com", "condition": null } ] Simple redirects and rewrites 161 AWS Amplify Hosting User Guide You can use the following example to redirect to a diﬀerent domain with a path preﬁx. Original address Destination Address Redirect Type Country Code https://m ydomain.com https://w ww.mydoma in.com/do cuments temporary redirect (302) JSON format [ { "source": "https://mydomain.com", "status": "302", "target": "https://www.mydomain.com/documents/", "condition": null } ] You can use the following example to redirect paths under a folder that can’t be found to a custom 404 page. Original address Destination Address Redirect Type Country Code /<> /404.html not found (404) JSON format [ { "source": "/<>", "status": "404", "target": "/404.html", "condition": null } ] Simple redirects and rewrites 162 AWS Amplify Hosting User Guide 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 ﬁles to index.html, except for the ﬁle extensions speciﬁed in the regular expression. Original address Destination Address Redirect Type Country Code </^[^.]+$\|\.(?! /index.html 200 (css\|gif\|ico \|jpg\|js\|png\| txt\|svg\|woff\| woff2\|ttf\|map\| json\|webp)$)([^ .]+$)/> JSON format [ { "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. HTTPS is the only protocol supported for reverse proxies. Redirects for single page web apps (SPA) 163 AWS Amplify Hosting User Guide Original address Destination Address Redirect Type Country Code /images/<> rewrite (200) https://i mages.oth erdomain.com/ <> JSON format [ { "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 diﬀerent scenarios: User inputs in browser URL in the address bar Document served /about /about /about.html /about (when about.htm /about/ /about/index.html l returns 404) /about/ /about/ /about/index.html Trailing slashes and clean URLs 164 AWS Amplify Hosting Placeholders User Guide You can use the following example to redirect paths in a folder structure to a matching structure in another folder. Original address Destination Address Redirect Type Country Code /docs/<year>/ /documents/ permanent <month>/<date> <year>/<month>/ redirect (301) /<itemid> <date>/<it emid> JSON format [ { "source": "/docs/<year>/<month>/<date>/<itemid>", "status": "301", "target": "/documents/<year>/<month>/<date>/<itemid>", "condition": null } ]
amplify-console-ug-053	amplify-console-ug.pdf	53	a trailing slash when required. The table below highlights diﬀerent scenarios: User inputs in browser URL in the address bar Document served /about /about /about.html /about (when about.htm /about/ /about/index.html l returns 404) /about/ /about/ /about/index.html Trailing slashes and clean URLs 164 AWS Amplify Hosting Placeholders User Guide You can use the following example to redirect paths in a folder structure to a matching structure in another folder. Original address Destination Address Redirect Type Country Code /docs/<year>/ /documents/ permanent <month>/<date> <year>/<month>/ redirect (301) /<itemid> <date>/<it emid> JSON format [ { "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 to redirect a path to a folder with a name that matches the value of a query string element in the original address: Original address Destination Address Redirect Type Country Code /docs?id=<my- /documents/<my- permanent blog-id-value blog-post-id- redirect (301) value> JSON format [ Placeholders 165 AWS Amplify Hosting { "source": "/docs?id=<my-blog-id-value>", "status": "301", "target": "/documents/<my-blog-id-value>", "condition": null } ] Note User Guide Amplify forwards all query string parameters to the destination path for 301 and 302 redirects. However, if the original address includes a query string set to a speciﬁc value, as demonstrated in this example, Amplify doesn't forward query parameters. In this case, the redirect applies only to requests to the destination address with the speciﬁed query value id. You can use the following example to redirect all paths that can’t be found at a given level of a folder structure to index.html in a speciﬁed folder. Original address Destination Address Redirect Type Country Code /documents/ index.html not found (404) /documents/ <folder>/ <child-folder>/ <grand-child- folder> JSON format [ { "source": "/documents/<x>/<y>/<z>", "status": "404", "target": "/documents/index.html", "condition": null } ] Query strings and path parameters 166 AWS Amplify Hosting Region-based redirects User Guide You can use the following example to redirect requests based on region. Original address Destination Address Redirect Type Country Code /documents /documents/us/ temporary <US> redirect (302) JSON format [ { "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 diﬀerent placement. The following is an example of a valid redirect with a wildcard expression. Original address Destination Address Redirect Type Country Code /docs/<> /documents/<> permanent redirect (301) The following two examples demonstrate invalid redirects with wildcard expressions. Region-based redirects 167 AWS Amplify Hosting User Guide Original address Destination Address Redirect Type Country Code /docs/<>/ content /docs/<>/ content/<> /documents/<>/ permanent content redirect (301) /documents/<>/ permanent content/<*> redirect (301) Using wildcard expressions in redirects and rewrites 168 AWS Amplify Hosting User Guide Using environment variables in an Amplify application Environment variables are key-value pairs that you can add to your application's settings to make them available to Amplify Hosting. As a best practice, you can use environment variables to expose application conﬁguration data. All environment variables that you add are encrypted to prevent rogue access. Amplify enforces the following constraints on the environment variables that you create. • Amplify doesn't allow you to create environment variable names with an AWS preﬁx. This preﬁx is reserved for Amplify internal use only. • The value of an environment variable can't exceed 5500 characters. Important Don't use environment variables to store secrets. For a Gen 2 app, use the Secret management feature in the Amplify console. For more information, see Secrets and environment vars in the Amplify Documentation. For a Gen 1 app, store secrets in an environment secret created using the AWS Systems Manager Parameter Store. For more information, see Managing environment secrets. Amplify environment variable reference The following environment variables are accessible by default within the Amplify console. Variable name Description Example value _BUILD_TIMEOUT The build timeout duration in minutes. 30 The minimum value is 5. The maximum value is 120. _LIVE_UPDATES The tool will be upgraded to the latest version. [{"name":"Amplify CLI","pkg":"@aws-a Amplify environment variable reference 169 AWS Amplify Hosting User Guide Variable name Description Example value mplify/cli","type" :"npm","version":" latest"}] true USER_DISABLE_TESTS The test step is skipped during a build. You can disable tests for all branches or speciﬁc branches in an app. This environment variable is used for apps that perform tests during the build phase. For more information about setting this variable, see Turning oﬀ tests for an Amplify application or branch. AWS_APP_ID AWS_BRANCH AWS_BRANCH_ARN The app ID of the current build abcd1234 The branch name of the current build The branch Amazon Resource Name (ARN) of the current build main, develop, beta, v2.0 aws:arn:amplify:us -west-2:1234567890 12:appname/branch/ ... AWS_CLONE_URL The
amplify-console-ug-054	amplify-console-ug.pdf	54	Variable name Description Example value mplify/cli","type" :"npm","version":" latest"}] true USER_DISABLE_TESTS The test step is skipped during a build. You can disable tests for all branches or speciﬁc branches in an app. This environment variable is used for apps that perform tests during the build phase. For more information about setting this variable, see Turning oﬀ tests for an Amplify application or branch. AWS_APP_ID AWS_BRANCH AWS_BRANCH_ARN The app ID of the current build abcd1234 The branch name of the current build The branch Amazon Resource Name (ARN) of the current build main, develop, beta, v2.0 aws:arn:amplify:us -west-2:1234567890 12:appname/branch/ ... AWS_CLONE_URL The clone URL used to fetch the git repository contents git@github.com:<us er-name>/<repo-nam AWS_COMMIT_ID e>.git abcd1234 The commit ID of the current build “HEAD” for rebuilds Amplify environment variable reference 170 AWS Amplify Hosting User Guide Variable name Description Example value AWS_JOB_ID The job ID of the current build. 0000000001 This includes some padding of ‘0’ so it always has the same length. AWS_PULL_REQUEST_ID The pull request ID of pull request web preview build. 1 This environment variable is not available when using AWS CodeCommit as your repository provider. AWS_PULL_REQUEST_S OURCE_BRANCH The name of the feature branch for a pull request featureA preview being submitted to an application branch in the Amplify console. AWS_PULL_REQUEST_D ESTINATION_BRANCH The name of the application branch in the Amplify console main that a feature branch pull request is being submitted to. The Amazon client ID 123456 The Amazon client secret example123456 The Facebook client ID 123456 The Facebook client secret example123456 AMPLIFY_AMAZON_CLI ENT_ID AMPLIFY_AMAZON_CLI ENT_SECRET AMPLIFY_FACEBOOK_C LIENT_ID AMPLIFY_FACEBOOK_C LIENT_SECRET Amplify environment variable reference 171 AWS Amplify Hosting User Guide Variable name Description Example value AMPLIFY_GOOGLE_CLI ENT_ID AMPLIFY_GOOGLE_CLI ENT_SECRET AMPLIFY_DIFF_DEPLOY AMPLIFY_DIFF_DEPLO Y_ROOT AMPLIFY_DIFF_BACKEND AMPLIFY_BACKEND_PU LL_ONLY The Google client ID 123456 The Google client secret example123456 Enable or disable diﬀ based frontend deployment. For true more information, see Conﬁguring diﬀ based frontend build and deploy. The path to use for diﬀ based frontend deployment comparisons, relative to the root of your repository. Enable or disable diﬀ based backend builds. This applies to Gen 1 apps only. For more information, see Conﬁguring diﬀ based backend builds for a Gen 1 app Amplify manages this environment variable. This applies to Gen 1 apps only. For more information, see Edit an existing frontend to point to a diﬀerent backend dist true true Amplify environment variable reference 172 AWS Amplify Hosting User Guide Variable name Description Example value AMPLIFY_BACKEND_APP_ID abcd1234 Amplify manages this environment variable. This applies to Gen 1 apps only. For more information, see Edit an existing frontend to point to a diﬀerent backend AMPLIFY_SKIP_BACKE ND_BUILD If you do not have a backend section in your build speciﬁca true tion and want to disable backend builds, set this environment variable to true. This applies to Gen 1 apps only. AMPLIFY_ENABLE_DEB UG_OUTPUT Set this variable to true to print a stack trace in the logs. true AMPLIFY_MONOREPO_A PP_ROOT AMPLIFY_USERPOOL_ID This is helpful for debugging backend build errors. The path to use to specify the app root of a monorepo app, relative to the root of your repository. The ID for the Amazon Cognito user pool imported for auth apps/react-app us-west-2_example Amplify environment variable reference 173 AWS Amplify Hosting User Guide Variable name Description Example value AMPLIFY_WEBCLIENT_ID The ID for the app client to be used by web applications 123456 The app client must be conﬁgured with access to the Amazon Cognito user pool speciﬁed by the AMPLIFY_U SERPOOL_ID environment variable. AMPLIFY_NATIVECLIENT_ID The ID for the app client to be used by native applications 123456 The app client must be conﬁgured with access to the Amazon Cognito user pool speciﬁed by the AMPLIFY_U SERPOOL_ID environment variable. AMPLIFY_IDENTITYPOOL_ID The ID for the Amazon Cognito identity pool example-identitypo ol-id AMPLIFY_PERMISSION S_BOUNDARY_ARN The ARN for the IAM policy to use as a permissions arn:aws:iam::12345 6789012:policy/exa AMPLIFY_DESTRUCTIV E_UPDATES boundary that applies to all mple-policy IAM roles created by Amplify. true Set this environment variable to true to allow a GraphQL API to be updated with schema operations that can potentially cause data loss. Amplify environment variable reference 174 AWS Amplify Hosting Note User Guide The AMPLIFY_AMAZON_CLIENT_ID and AMPLIFY_AMAZON_CLIENT_SECRET environment variables are OAuth tokens, not an AWS access key and secret key. Frontend framework environment variables If you are developing your app with a frontend framework that supports its own environment variables, it is important to understand that these are not the same as the environment variables you conﬁgure in the Amplify console. For example, React (preﬁxed REACT_APP) and Gatsby (preﬁxed GATSBY), enable you to create runtime environment variables that those frameworks automatically bundle into your frontend production build. To understand the eﬀects of using these environment variables to store values, refer to the documentation for the frontend framework you are using. Storing sensitive values, such as API
amplify-console-ug-055	amplify-console-ug.pdf	55	key and secret key. Frontend framework environment variables If you are developing your app with a frontend framework that supports its own environment variables, it is important to understand that these are not the same as the environment variables you conﬁgure in the Amplify console. For example, React (preﬁxed REACT_APP) and Gatsby (preﬁxed GATSBY), enable you to create runtime environment variables that those frameworks automatically bundle into your frontend production build. To understand the eﬀects of using these environment variables to store values, refer to the documentation for the frontend framework you are using. Storing sensitive values, such as API keys, inside these frontend framework preﬁxed environment variables is not a best practice and is highly discouraged. Setting environment variables Use the following instructions to set environment variables for an application in the Amplify console. Note Environment variables is visible in the Amplify console’s App settings menu only when an app is set up for continuous deployment and connected to a git repository. For instructions on this type of deployment, see Getting started with existing code. To set environment variables 1. 2. Sign in to the AWS Management Console and open the Amplify console. In the Amplify console, choose Hosting, and then choose Environment variables. 3. On the Environment variables page, choose Manage variables. Frontend framework environment variables 175 AWS Amplify Hosting User Guide 4. For Variable, enter your key. For Value, enter your value. By default, Amplify applies the environment variables across all branches, so you don’t have to re-enter variables when you connect a new branch. 5. (Optional) To customize an environment variable speciﬁcally for a branch, add a branch override as follows: a. Choose Actions and then choose Add variable override. b. You now have a set of environment variables speciﬁc to your branch. 6. Choose Save. Create a new backend environment with authentication parameters for social sign-in To connect a branch to an app 1. 2. Sign in to the AWS Management Console and open the Amplify console. The procedure for connecting a branch to an app varies depending on whether you are connecting a branch to a new app or an existing app. • Connecting a branch to a new app a. On the Build settings page, locate the Select a backend environment to use with this branch section. For Environment, choose Create new environment, and enter the name of your backend environment. The following screenshot shows the Select a backend environment to use with this branch section of the Build settings page with backend entered for the backend environment name. Create a new backend environment with authentication parameters for social sign-in 176 AWS Amplify Hosting User Guide b. Expand the Advanced settings section on the Build settings page and add environment variables for social sign-in keys. For example, AMPLIFY_FACEBOOK_CLIENT_SECRET is a valid environment variable. For the list of Amplify system environment variables that are available by default, see the table in Amplify environment variable reference. • Connecting a branch to an existing app a. If you are connecting a new branch to an existing app, set the social sign-in environment variables before connecting the branch. In the navigation pane, choose App Settings, Environment variables. b. c. d. e. In the Environment variables section, choose Manage variables. In the Manage variables section, choose Add variable. For Variable (key), enter your client ID. For Value, enter your client secret. Choose, Save. Managing environment secrets With the release of Amplify Gen 2, the workﬂow for environment secrets is streamlined to centralize the management of secrets and environment variables in the Amplify console. For instructions on setting and accessing secrets for an Amplify Gen 2 app, see Secrets and environment vars in the Amplify Documentation. Managing environment secrets 177 AWS Amplify Hosting User Guide Environment secrets for a Gen 1 app are similar to environment variables, but they are AWS Systems Manager Parameter Store key value pairs that can be encrypted. Some values must be encrypted, such as the Sign in with Apple private key for Amplify. Using AWS Systems Manager to set environment secrets for an Amplify Gen 1 application Use the following instructions to set an environment secret for a Gen 1 Amplify app using the AWS Systems Manager console. To set an environment secret 1. 2. Sign in to the AWS Management Console and open the AWS Systems Manager console. In the navigation pane, choose Application Management, then choose Parameter Store. 3. On the AWS Systems Manager Parameter Store page, choose Create parameter. 4. On the Create parameter page, in the Parameter details section, do the following: a. b. c. d. For Name, enter a parameter in the format /amplify/{your_app_id}/ {your_backend_environment_name}/{your_parameter_name}. For Type, choose SecureString. For KMS key source, choose My current account to use the default key for your account. For Value, enter your
amplify-console-ug-056	amplify-console-ug.pdf	56	AWS Systems Manager console. To set an environment secret 1. 2. Sign in to the AWS Management Console and open the AWS Systems Manager console. In the navigation pane, choose Application Management, then choose Parameter Store. 3. On the AWS Systems Manager Parameter Store page, choose Create parameter. 4. On the Create parameter page, in the Parameter details section, do the following: a. b. c. d. For Name, enter a parameter in the format /amplify/{your_app_id}/ {your_backend_environment_name}/{your_parameter_name}. For Type, choose SecureString. For KMS key source, choose My current account to use the default key for your account. For Value, enter your secret value to encrypt. 5. Choose, Create parameter. Note Amplify only has access to the keys under the /amplify/{your_app_id}/ {your_backend_environment_name} for the speciﬁc environment build. You must specify the default AWS KMS key to allow Amplify to decrypt the value. Accessing environment secrets for a Gen 1 application Environment secrets for a Gen 1 application are stored in process.env.secrets as a JSON string. Using AWS Systems Manager to set environment secrets for an Amplify Gen 1 application 178 AWS Amplify Hosting User Guide Amplify environment secrets reference Specify an Systems Manager parameter in the format /amplify/{your_app_id}/ {your_backend_environment_name}/AMPLIFY_SIWA_CLIENT_ID. You can use the following environment secrets that are accessible by default within the Amplify console. Variable name Description Example value AMPLIFY_SIWA_CLIENT_ID The Sign in with Apple client ID com.yourapp.auth AMPLIFY_SIWA_TEAM_ID The Sign in with Apple team ID ABCD123 AMPLIFY_SIWA_KEY_ID The Sign in with Apple key ID ABCD123 AMPLIFY_SIWA_PRIVATE_KEY The Sign in with Apple private key -----BEGIN PRIVATE KEY----- ***...... -----END PRIVATE KEY----- Amplify environment secrets reference 179 AWS Amplify Hosting User Guide Setting custom headers for an Amplify app Custom HTTP headers enable you to specify headers for every HTTP response. Response headers can be used for debugging, security, and informational purposes. You can specify headers in the Amplify console, or by downloading and editing an app's customHttp.yml ﬁle and saving it in the project's root directory. For detailed procedures, see Setting custom headers. Previously, custom HTTP headers were speciﬁed for an app either by editing the build speciﬁcation (buildspec) in the Amplify console or by downloading and updating the amplify.yml ﬁle and saving it in the project's root directory. We highly recommend migrating custom headers speciﬁed in this way out of the buildspec and the amplify.yml ﬁle. For instructions, see Migrating custom headers out of the build speciﬁcation and amplify.yml. Topics • Custom header YAML reference • Setting custom headers • Migrating custom headers out of the build speciﬁcation and amplify.yml • Monorepo custom header requirements Custom header YAML reference Specify custom headers using the following YAML format: customHeaders: - pattern: '.json' headers: - key: 'custom-header-name-1' value: 'custom-header-value-1' - key: 'custom-header-name-2' value: 'custom-header-value-2' - pattern: '/path/' headers: - key: 'custom-header-name-1' value: 'custom-header-value-2' For a monorepo, use the following YAML format: applications: YAML reference 180 User Guide AWS Amplify Hosting - appRoot: app1 customHeaders: - pattern: '/' headers: - key: 'custom-header-name-1' value: 'custom-header-value-1' - appRoot: app2 customHeaders: - pattern: '/path/*.json' headers: - key: 'custom-header-name-2' value: 'custom-header-value-2' When you add custom headers to your app, you will specify your own values for the following: pattern Custom headers are applied to all URL ﬁle paths that match the pattern. headers Deﬁnes the headers that match the ﬁle pattern. key The name of the custom header. value The value of the custom header. To learn more about HTTP headers, see Mozilla's list of HTTP Headers. Setting custom headers There are two ways to specify custom HTTP headers for an Amplify app. You can specify headers in the Amplify console or you can specify headers by downloading and editing an app's customHttp.yml ﬁle and saving it in your project's root directory. To set custom headers for an app and save them in the console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to set custom headers for. Setting custom headers 181 AWS Amplify Hosting User Guide 3. In the navigation pane, choose Hosting, then chooseCustom headers. 4. On the Custom headers page, choose Edit. 5. In the Edit custom headers window, enter the information for your custom headers using the custom header YAML format. a. b. c. For pattern, enter the pattern to match. For key, enter the name of the custom header. For value, enter the value of the custom header. 6. Choose Save. 7. Redeploy the app to apply the new custom headers. • • For a CI/CD app, navigate to the branch to deploy and choose Redeploy this version. You can also perform a new build from your Git repository. For a manual deploy app, deploy the app again in the Amplify console. To set custom headers for an app and save them in the root of your repository 1. Sign in to the
amplify-console-ug-057	amplify-console-ug.pdf	57	For pattern, enter the pattern to match. For key, enter the name of the custom header. For value, enter the value of the custom header. 6. Choose Save. 7. Redeploy the app to apply the new custom headers. • • For a CI/CD app, navigate to the branch to deploy and choose Redeploy this version. You can also perform a new build from your Git repository. For a manual deploy app, deploy the app again in the Amplify console. To set custom headers for an app and save them in the root of your repository 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to set custom headers for. 3. In the navigation pane, choose Hosting, then choose Custom headers. 4. On the Custom headers page, choose Download YML. 5. Open the downloaded customHttp.yml ﬁle in the code editor of your choice and enter the information for your custom headers using the custom header YAML format. a. b. c. For pattern, enter the pattern to match. For key, enter the name of the custom header. For value, enter the value of the custom header. 6. Save the edited customHttp.yml ﬁle in your project's root directory. If you are working with a monorepo, save the customHttp.yml ﬁle in the root of your repo. 7. Redeploy the app to apply the new custom headers. • • For a CI/CD app, perform a new build from your Git repository that includes the new customHttp.yml ﬁle. For a manual deploy app, deploy the app again in the Amplify console and include the new customHttp.yml ﬁle with the artifacts that you upload. Setting custom headers 182 AWS Amplify Hosting Note User Guide Custom headers set in the customHttp.yml ﬁle and deployed in the app's root directory override custom headers deﬁned in the Custom headers section in the Amplify console. Security custom headers example Custom security headers enable enforcing HTTPS, preventing XSS attacks, and defending your browser against clickjacking. Use the following YAML syntax to apply custom security headers to your app. customHeaders: - pattern: '*' headers: - key: 'Strict-Transport-Security' value: 'max-age=31536000; includeSubDomains' - key: 'X-Frame-Options' value: 'SAMEORIGIN' - key: 'X-XSS-Protection' value: '1; mode=block' - key: 'X-Content-Type-Options' value: 'nosniff' - key: 'Content-Security-Policy' value: "default-src 'self'" Setting Cache-Control custom headers Apps hosted with Amplify honor the Cache-Control headers that are sent by the origin, unless you override them with custom headers that you deﬁne. Amplify only applies Cache-Control custom headers for successful responses with a 200 OK status code. This prevents error responses from being cached and served to other users that make the same request. You can manually adjust the s-maxage directive to have more control over the performance and deployment availability of your app. For example, to increase the length of time that your content stays cached at the edge, you can manually increase the time to live (TTL) by updating s-maxage to a value longer than the default 600 seconds (10 minutes). To specify a custom value for s-maxage, use the following YAML format. This example keeps the associated content cached at the edge for 3600 seconds (one hour). Security custom headers example 183 AWS Amplify Hosting User Guide customHeaders: - pattern: '/img/' headers: - key: 'Cache-Control' value: 's-maxage=3600' For more information about controlling application performance with headers, see Using the Cache-Control header to increase app performance. Migrating custom headers out of the build speciﬁcation and amplify.yml Previously, custom HTTP headers were speciﬁed for an app either by editing the build speciﬁcation in the Amplify console or by downloading and updating the amplify.yml ﬁle and saving it in the project 's root directory. It is strongly recommended that you migrate your custom headers out of the build speciﬁcation and the amplify.yml ﬁle. Specify your custom headers in the Custom headers section of the Amplify console or by downloading and editing the customHttp.yml ﬁle. To migrate custom headers stored in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to perform the custom header migration on. 3. In the navigation pane, choose Hosting, Build settings. In the App build speciﬁcation section, you can review your app's buildspec. 4. Choose Download to save a copy of your current buildspec. You can reference this copy later if you need to recover any settings. 5. When the download is complete, choose Edit. 6. Take note of the custom header information in the ﬁle, as you will use it later in step 9. In the Edit window, delete any custom headers from the ﬁle and choose Save. 7. In the navigation pane, choose Hosting, Custom headers. 8. On the Custom headers page, choose Edit. 9. In the Edit custom headers window, enter the information for your custom headers that you
amplify-console-ug-058	amplify-console-ug.pdf	58	buildspec. 4. Choose Download to save a copy of your current buildspec. You can reference this copy later if you need to recover any settings. 5. When the download is complete, choose Edit. 6. Take note of the custom header information in the ﬁle, as you will use it later in step 9. In the Edit window, delete any custom headers from the ﬁle and choose Save. 7. In the navigation pane, choose Hosting, Custom headers. 8. On the Custom headers page, choose Edit. 9. In the Edit custom headers window, enter the information for your custom headers that you deleted in step 6. Migrating custom headers 184 AWS Amplify Hosting 10. Choose Save. User Guide 11. Redeploy any branch that you want the new custom headers to be applied to. To migrate custom headers from amplify.yml to customHttp.yml 1. Navigate to the amplify.yml ﬁle currently deployed in your app's root directory. 2. Open amplify.yml in the code editor of your choice. 3. Take note of the custom header information in the ﬁle, as you will use it later in step 8. Delete the custom headers in the ﬁle. Save and close the ﬁle. 4. Sign in to the AWS Management Console and open the Amplify console. 5. Choose the app to set custom headers for. 6. In the navigation pane, choose Hosting, Custom headers. 7. On the Custom headers page, choose Download. 8. Open the downloaded customHttp.yml ﬁle in the code editor of your choice and enter the information for your custom headers that you deleted from amplify.yml in step 3. 9. Save the edited customHttp.yml ﬁle in your project's root directory. If you are working with a monorepo, save the ﬁle in the root of your repo. 10. Redeploy the app to apply the new custom headers. • • For a CI/CD app, perform a new build from your Git repository that includes the new customHttp.yml ﬁle. For a manual deploy app, deploy the app again in the Amplify console and include the new customHttp.yml ﬁle with artifacts that you upload. Note Custom headers set in the customHttp.yml ﬁle and deployed in the app's root directory override the custom headers deﬁned in the Custom headers section of the Amplify console. Monorepo custom header requirements When you specify custom headers for an app in a monorepo, be aware of the following setup requirements: Monorepo custom headers 185 AWS Amplify Hosting User Guide • There is a speciﬁc YAML format for a monorepo. For the correct syntax, see Custom header YAML reference. • You can specify custom headers for an application in a monorepo using the Custom headers section of the Amplify console. You must redeploy your application to apply the new custom headers. • As an alternative to using the console, you can specify custom headers for an app in a monorepo in a customHttp.yml ﬁle. You must save the customHttp.yml ﬁle in the root of your repo and then redeploy the application to apply the new custom headers. Custom headers speciﬁed in the customHttp.yml ﬁle override any custom headers speciﬁed using the Custom headers section of the Amplify console. Monorepo custom headers 186 AWS Amplify Hosting User Guide Using webhooks with Amplify applications Amplify Hosting uses webhooks to automatically initiate a build after a new commit to your Git repository. Amplify uses one uniﬁed webhook for all applications associated with a single repository. This ensures that the Amplify apps associated with the repository receive updates and triggers, without being limited by your Git provider's webhook restrictions. To learn more about the uniﬁed webhooks feature, see Uniﬁed webhooks for Git repositories. You can also intiate a build without a commit to your Git repository by creating an incoming webhook that you provide to a headless CMS tool, such as Contentful or GraphCMS, or a service such as Zapier. For instructions, see Creating an incoming webhook to start a build. Topics • Uniﬁed webhooks for Git repositories • Creating an incoming webhook to start a build Uniﬁed webhooks for Git repositories The uniﬁed webhooks feature improves Amplify's integrations with Git providers and enables you to connect more Amplify applications to a single repository. With uniﬁed webhooks, Amplify now uses a single webhook per Region for all associated applications in your repository. For example, if your repository is connected to applications in both the US East (N. Virginia) and US West (Oregon) Regions, you will have two uniﬁed webhooks. Before this release, Amplify created a new webhook for each app associated with a repository. If you had multiple apps in a single repository, you could reach the webhook limits enforced by individual Git providers and be prevented from adding more apps. This was especially challenging for teams working in monorepos, where multiple projects exist in a single repository. Uniﬁed webhooks provide
amplify-console-ug-059	amplify-console-ug.pdf	59	single webhook per Region for all associated applications in your repository. For example, if your repository is connected to applications in both the US East (N. Virginia) and US West (Oregon) Regions, you will have two uniﬁed webhooks. Before this release, Amplify created a new webhook for each app associated with a repository. If you had multiple apps in a single repository, you could reach the webhook limits enforced by individual Git providers and be prevented from adding more apps. This was especially challenging for teams working in monorepos, where multiple projects exist in a single repository. Uniﬁed webhooks provide the following beneﬁts: • Overcome Git provider webhook limits: You can connect as many Amplify apps as you need to a single repository. • Enhanced monorepo support: You have more ﬂexibility and eﬃciency when working with monorepos, where multiple projects share a single repository. • Simpliﬁed management: Managing multiple Amplify apps with a single repository webhook reduces complexity and potential points of failure. Uniﬁed webhooks for Git repositories 187 AWS Amplify Hosting User Guide • Improved workﬂow integration: You can use the webhooks allocated by your Git provider for other essential workﬂows in your development process. Getting started with uniﬁed webhooks Creating a new app When you deploy a new application to Amplify Hosting from a Git repository, the uniﬁed webhooks feature is automatically implemented for your repository. For instructions on creating a new application, see Getting started with deploying an app to Amplify Hosting. Updating an existing app For existing Amplify applications, you must reconnect your Git repository to your application to replace the existing webhooks with a uniﬁed webhook. If you've already reached the maximum number of webhooks allowed by your Git provider, migrating to the uniﬁed webhook might not succeed. In this case, manually remove at least one existing webhook before reconnecting. You can have multiple applications in a repository that are deployed to diﬀerent AWS Regions. Since Amplify operations are Region based, the migration to a uniﬁed webhook only occurs for the webhooks in the Region where you reconnected your Amplify app. As a result, you might see both application id-based webhooks and Region-based uniﬁed webhooks in your repository. Use the following instructions to migrate an existing Amplify app to a uniﬁed webhook. To migrate an existing Amplify app to a uniﬁed webhook 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to migrate to a uniﬁed webhook. 3. In the navigation pane, choose App settings, then choose Branch settings. 4. On the Branch settings page, choose Reconnect repository. 5. To verify successful migration to the uniﬁed webhook, navigate to the webhook settings in your Git repository. You should see a single webhook URL in the format https://amplify- webhooks.Region.amazonaws.com/git-provider. Getting started with uniﬁed webhooks 188 AWS Amplify Hosting User Guide Creating an incoming webhook to start a build Set up an incoming webhook in the Amplify console to start a build without committing code to your Git repository. You can use webhooks with headless CMS tools (such as Contentful or GraphCMS) to start a build whenever content changes, or to perform daily builds using services such as Zapier. To create an incoming webhook 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to create a webhook for. 3. In the navigation pane, choose Hosting, then Build settings. 4. On the Build settings page, scroll down to the Incoming webhooks section and choose Create webhook. 5. In the Create webhook dialog box, do the following: a. b. c. For Webhook name enter a name for the webhook. For Branch to build, select the branch to build on incoming webhook requests. Choose Create webhook. 6. In the Incoming webhooks section, do one of the following: • • Copy the webhook URL and provide it to a headless CMS tool or other service to initiate builds. Run the curl command in a terminal window to start a new build. Incoming webhooks 189 AWS Amplify Hosting User Guide Skew protection for Amplify deployments Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to an Amplify application, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. Version skew is a common challenge for web developers. It occurs when a web browser is running an outdated version of an application and the server is running a new one. This discrepancy can cause unpredictable behavior, errors, and a degraded experience for the user of the application. The Amplify deployment skew protection feature pins clients running on web browsers to a speciﬁc deployment. This
amplify-console-ug-060	amplify-console-ug.pdf	60	and servers in web applications. When you apply skew protection to an Amplify application, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. Version skew is a common challenge for web developers. It occurs when a web browser is running an outdated version of an application and the server is running a new one. This discrepancy can cause unpredictable behavior, errors, and a degraded experience for the user of the application. The Amplify deployment skew protection feature pins clients running on web browsers to a speciﬁc deployment. This ensures that Amplify always serves the assets for that particular deployment, keeping the client and server synchronized. Amplify's skew protection feature can reduce errors for your application's users as you release new deployments. It can also improve the developer experience by reducing the time spent managing backward and forward compatibility issues. Skew protection feature details: Supported application types You can add skew protection to static and SSR applications created with any framework that Amplify supports. Applications can be deployed from a Git repository or a manual deployment. You can't add skew protection to an application that is deployed to the WEB_DYNAMIC platform (Next.js version 11 or earlier). Duration For static applications, Amplify serves one week of deployments. For SSR applications, we guarantee skew protection for up to eight previous deployments. Cost There is no additional cost for adding skew protection to an application. Performance consideration When skew protection is enabled for an application, Amplify must update its CDN cache conﬁgurations. Therefore, you should expect your ﬁrst deployment after enabling skew protection to take up to ten minutes. 190 AWS Amplify Hosting Topics • Conﬁguring deployment skew protection for an Amplify application • How skew protection works User Guide Conﬁguring deployment skew protection for an Amplify application You can add or remove deployment skew protection for an application using the Amplify console, the AWS Command Line Interface, or the SDKs. The feature is applied at the branch level. Only new deployments, that are made after skew protection is enabled for a branch, will be skew protected. To add or remove deployment skew protection using the AWS CLI or SDKs, use the CreateBranch.enableSkewProtection and UpdateBranch.enableSkewProtection ﬁelds. For more information, see CreateBranch and UpdateBranch in the Amplify API reference documentation. If you want to remove a speciﬁc deployment so that it no longer gets served, use the DeleteJob API. For more information, see DeleteJob in the Amplify API reference documentation. At this time, you can only enable skew protection on an application that is already deployed to Amplify Hosting. Use the following instructions to add skew protection to a branch using the Amplify console. Enable skew protection for branch of an Amplify application 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the deployed app to enable skew protection on. 3. 4. In the navigation pane, choose App settings, then choose Branch settings. In the Branches section, choose the name of the branch to update. 5. On the Actions menu, choose Enable skew protection. 6. In the conﬁrmation window, choose Conﬁrm. Skew protection is now enabled for the branch. 7. Redeploy your application branch. Only deployments that are made after skew protection is enabled are skew protected. Conﬁguring skew protection 191 AWS Amplify Hosting User Guide Use the following instructions to remove skew protection from a branch of an application using the Amplify console. Remove skew protection from a branch of an Amplify application 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the deployed app to remove skew protection from. 3. 4. In the navigation pane, choose App settings, then choose Branch settings. In the Branches section, choose the name of the branch to update. 5. On the Actions menu, choose Disable skew protection. Skew protection is now disabled for the branch and only the latest content will be served. How skew protection works In most cases, the default behavior of the _dpl cookie will serve your skew protection needs. However, in the following advanced scenarios, skew protection is better enabled using the X- Amplify-Dpl header and dpl query parameter. • Loading your website in multiple browser tabs at the same time. • Using service workers. Amplify evaluates the incoming request in the following order when determining the content to serve to the client: 1. X-Amplify-Dpl header – Applications can use this header to direct requests to a speciﬁc Amplify deployment. This request header can be set by using the value of process.env.AWS_AMPLIFY_DEPLOYMENT_ID. 2. dpl query parameter – Next.js applications will automatically set the _dpl query parameter for
amplify-console-ug-061	amplify-console-ug.pdf	61	protection needs. However, in the following advanced scenarios, skew protection is better enabled using the X- Amplify-Dpl header and dpl query parameter. • Loading your website in multiple browser tabs at the same time. • Using service workers. Amplify evaluates the incoming request in the following order when determining the content to serve to the client: 1. X-Amplify-Dpl header – Applications can use this header to direct requests to a speciﬁc Amplify deployment. This request header can be set by using the value of process.env.AWS_AMPLIFY_DEPLOYMENT_ID. 2. dpl query parameter – Next.js applications will automatically set the _dpl query parameter for requests to ﬁngerprinted assets (.js and .css ﬁles). 3. _dpl cookie – This is the default for all skew protected applications. For a speciﬁc browser, the same cookie is sent for every browser tab or instance that interacts with a domain. Be aware that if diﬀerent browser tabs have diﬀerent versions of a website loaded, the _dpl cookie is shared by all of the tabs. In this scenario, it isn't possible to achieve total skew How skew protection works 192 AWS Amplify Hosting User Guide protection with the _dpl cookie and you should consider using the X-Amplify-Dpl header for skew protection. X-Amplify-Dpl header example The following example demonstrates the code for a Next.js SSR page that accesses skew protection through the X-Amplify-Dpl header. The page renders its content based on one of its api routes. The deployment to serve to the api route is speciﬁed by using the X-Amplify-Dpl header, that is set to the value of process.env.AWS_AMPLIFY_DEPLOYMENT_ID. import { useEffect, useState } from 'react'; export default function MyPage({deploymentId}) { const [data, setData] = useState(null); useEffect(() => { fetch('/api/hello', { headers: { 'X-Amplify-Dpl': process.env.AWS_AMPLIFY_DEPLOYMENT_ID }, }) .then(res => res.json()) .then(data => setData(data)) .catch(error => console.error("error", error)) }, []); return <div> {data ? JSON.stringify(data) : "Loading ... " } </div> } X-Amplify-Dpl header example 193 AWS Amplify Hosting User Guide Restricting access to an Amplify app's branches If you are working on unreleased features, you can password protect feature branches to restrict access to speciﬁc users. When access control is set on a branch, users are prompted for a user name and password when they attempt to access the URL for the branch. You can set a password that applies to an individual branch or globally to all connected branches. When access control is enabled at both the branch and global level, the branch level password takes precedence over a global (application) level password. Amplify throttles failed requests that are attempting to access password protected resources. This behavior protects applications against dictionary attacks or other attempts to read data behind access controls. Use the following procedure to set a password to restrict access to an Amplify app's branches. To set passwords on feature branches 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app you want to set feature branch passwords on. 3. 4. In the navigation pane, choose Hosting, and then choose Access control. In the Access control settings section, choose Manage access. 5. On the Manage access control page, do one of the following. • To set a username and password that applies to all connected branches • Turn on Manage access for all branches. For example, if you have main, dev, and feature branches connected, you can apply the same username and password for all branches. • To set a a username and password that applies to an individual branch a. b. c. d. Turn oﬀ Manage access for all branches. Locate the branch that you want to manage. For Access settings choose Restricted- password required. For Username, enter a username. For Password, enter a password. • Choose Save. 194 AWS Amplify Hosting User Guide 6. If you are managing access control for a server-side rendered (SSR) app, redeploy the app by performing a new build from your Git repository. This step is required to enable Amplify to apply your access control settings. 195 AWS Amplify Hosting User Guide Web previews for pull requests Web previews oﬀer development and quality assurance (QA) teams a way to preview changes from pull requests (PRs) before merging code to a production or integration branch. Pull requests let you tell others about changes you’ve pushed to a branch in a repository. After a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch. A web preview deploys every pull request made to your repository to a unique preview URL which is completely diﬀerent from the URL your main site uses. For apps with backend environments provisioned using the Amplify CLI or Amplify Studio, every pull request (private Git repositories only) creates a temporary backend that is deleted when
amplify-console-ug-062	amplify-console-ug.pdf	62	Pull requests let you tell others about changes you’ve pushed to a branch in a repository. After a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch. A web preview deploys every pull request made to your repository to a unique preview URL which is completely diﬀerent from the URL your main site uses. For apps with backend environments provisioned using the Amplify CLI or Amplify Studio, every pull request (private Git repositories only) creates a temporary backend that is deleted when the PR is closed. When web previews are turned on for your app, each PR counts toward the Amplify quota of 50 branches per app. To avoid exceeding this quota, make sure to close your PRs. For more information about quotas, see Amplify Hosting service quotas. Note Currently, the AWS_PULL_REQUEST_ID environment variable is not available when using AWS CodeCommit as your repository provider. Web preview security For security purposes, you can enable web previews on all apps with private repositories, but not on all apps with public repositories. If your Git repository is public, you can set up previews only for apps that don't require an IAM service role. For example, apps with backends and apps that are deployed to the WEB_COMPUTE hosting platform require an IAM service role. Therefore, you can't enable web previews for these types of apps if their repository is public. Amplify enforces this restriction to prevent third parties from submitting arbitrary code that would run using your app's IAM role permissions. When web previews are enabled for an application in a public repository, with an SSR Compute role, you need to carefully manage which branches can access the role. We recommend that you don't use an app-level role. Instead, you should attach a Compute role at the branch-level. This allows you to grant permissions only to the branches that require access to speciﬁc resources. For more information, see Adding an SSR Compute role to allow access to AWS resources . 196 AWS Amplify Hosting User Guide Enable web previews for pull requests For apps stored in a GitHub repo, web previews use the Amplify GitHub App for repo access. If you are enabling web previews on an existing Amplify app that you previously deployed from a GitHub repo using OAuth for access, you must ﬁrst migrate the app to use the Amplify GitHub App. For migration instructions, see Migrating an existing OAuth app to the Amplify GitHub App. To enable web previews for pull requests 1. Choose Hosting, then Previews. Note Previews is visible in the App settings menu only when an app is set up for continuous deployment and connected to a git repository. For instructions on this type of deployment, see Getting started with existing code. 2. For GitHub repositories only, do the following to install and authorize the Amplify GitHub App in your account: a. b. c. In the Install GitHub App to enable previews window, choose Install GitHub app. Select the GitHub account where you want to conﬁgure the Amplify GitHub App. A page opens on Github.com to conﬁgure repository permissions for your account. d. Do one of the following: • • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are enabling web previews for in the repositories that you select. e. Choose Save 3. After you enable previews for your repo, return to the Amplify console to enable previews for speciﬁc branches. On the Previews page, select a branch from the list and choose Edit settings. 4. On the Manage preview settings page, turn on Pull request previews. Then choose Conﬁrm. 5. For fullstack applications do one of the following: • Choose, Create new backend environment for every Pull Request. This option enables you to test changes without impacting production. Enable web previews for pull requests 197 AWS Amplify Hosting User Guide • Choose Point all Pull Requests for this branch to an existing environment. 6. Choose Conﬁrm. The next time you submit a pull request for the branch, Amplify builds and deploys your PR to a preview URL. After the pull request is closed, the preview URL is deleted, and any temporary backend environment linked to the pull request is deleted. For GitHub repositories only, you can access a preview of your URL directly from the pull request in your GitHub account. Web preview access with subdomains Web previews for pull requests are accessible with subdomains for an Amplify app that is connected to a custom domain managed by Amazon Route 53. When the pull request is closed, branches and subdomains
amplify-console-ug-063	amplify-console-ug.pdf	63	submit a pull request for the branch, Amplify builds and deploys your PR to a preview URL. After the pull request is closed, the preview URL is deleted, and any temporary backend environment linked to the pull request is deleted. For GitHub repositories only, you can access a preview of your URL directly from the pull request in your GitHub account. Web preview access with subdomains Web previews for pull requests are accessible with subdomains for an Amplify app that is connected to a custom domain managed by Amazon Route 53. When the pull request is closed, branches and subdomains associated with the pull request are automatically deleted. This is the default behavior for web previews after you set up pattern-based feature branch deployments for your app. For instructions on setting up automatic subdomains, see Setting up automatic subdomains for an Amazon Route 53 custom domain. Web preview access with subdomains 198 AWS Amplify Hosting User Guide Setting up end-to-end Cypress tests for your Amplify application You can run end-to-end (E2E) tests in the test phase of your Amplify app to catch regressions before pushing code to production. The test phase can be conﬁgured in the build speciﬁcation YAML. Currently, you can run only the Cypress testing framework during a build. Cypress is a JavaScript-based testing framework that allows you to run E2E tests on a browser. For a tutorial that demonstrates how to set up E2E tests, see the blog post Running end-to-end Cypress tests for your fullstack CI/CD deployment with Amplify. Adding Cypress tests to an existing Amplify application You can add Cypress tests to an existing app by updating the app's build settings in the Amplify console. The build speciﬁcation YAML contains a collection of build commands and related settings that Amplify uses to run your build. Use the test step to run any test commands at build time. For E2E tests, Amplify Hosting oﬀers a deeper integration with Cypress that allows you to generate a UI report for your tests. The following list describes the test settings and how they are used. preTest Install the dependencies required to run Cypress tests. Amplify Hosting uses mochawesome to generate a report to view your test results and wait-on to set up the localhost server during the build. test Run cypress commands to perform tests using mochawesome. postTest The mochawesome report is generated from the output JSON. Note that if you are using Yarn, you must run this command in silent mode to generate the mochawesome report. For Yarn, you can use the following command. yarn run --silent mochawesome-merge cypress/report/mochawesome-report/ mochawesome.json > cypress/report/mochawesome.json Adding Cypress tests to an existing Amplify application 199 AWS Amplify Hosting User Guide artifacts>baseDirectory The directory from which tests are run. artifacts>conﬁgFilePath The generated test report data. artifacts>ﬁles The generated artifacts (screenshots and videos) available for download. The following example excerpt from a build speciﬁcation amplify.yml ﬁle shows how to add Cypress tests to your app. test: phases: preTest: commands: - npm ci - npm install -g pm2 - npm install -g wait-on - npm install mocha mochawesome mochawesome-merge mochawesome-report-generator - pm2 start npm -- start - wait-on http://localhost:3000 test: commands: - 'npx cypress run --reporter mochawesome --reporter-options "reportDir=cypress/report/mochawesome- report,overwrite=false,html=false,json=true,timestamp=mmddyyyy_HHMMss"' postTest: commands: - npx mochawesome-merge cypress/report/mochawesome-report/mochawesome.json > cypress/report/mochawesome.json - pm2 kill artifacts: baseDirectory: cypress configFilePath: '/mochawesome.json' files: - '/.png' - '/.mp4' Adding Cypress tests to an existing Amplify application 200 AWS Amplify Hosting User Guide Turning oﬀ tests for an Amplify application or branch After the test conﬁguration has been added to your amplify.yml build settings, the test step runs for every build, on every branch. If you want to globally disable tests from running, or only run tests for speciﬁc branches, you can use the USER_DISABLE_TESTS environment variable without modifying your build settings. To globally disable tests for all branches, add the USER_DISABLE_TESTS environment variable with a value of true for all branches. The following screenshot, shows the Environment variables section in the Amplify console with tests disabled for all branches. To disable tests for a speciﬁc branch, add the USER_DISABLE_TESTS environment variable with a value of false for all branches, and then add an override for each branch you want to disable with a value of true. In the following screenshot, tests are disabled on the main branch, and enabled for every other branch. Turning oﬀ tests for an Amplify application or branch 201 AWS Amplify Hosting User Guide Disabling tests with this variable will cause the test step to be skipped altogether during a build. To re-enable tests, set this value to false, or delete the environment variable. Turning oﬀ tests for an Amplify application or branch 202 AWS Amplify Hosting User Guide Monitoring an Amplify application AWS Amplify provides two features for monitoring your hosted applications from within the Amplify console.
amplify-console-ug-064	amplify-console-ug.pdf	64	a value of true. In the following screenshot, tests are disabled on the main branch, and enabled for every other branch. Turning oﬀ tests for an Amplify application or branch 201 AWS Amplify Hosting User Guide Disabling tests with this variable will cause the test step to be skipped altogether during a build. To re-enable tests, set this value to false, or delete the environment variable. Turning oﬀ tests for an Amplify application or branch 202 AWS Amplify Hosting User Guide Monitoring an Amplify application AWS Amplify provides two features for monitoring your hosted applications from within the Amplify console. • Amplify emits metrics through Amazon CloudWatch that you can use to monitor traﬃc, errors, data transfer, and latency for your applications. • Amplify provides access logs with detailed information about requests made to your application. Use the topics in this section to learn how to use CloudWatch metrics and Amplify access logs to monitor your applications. Topics • Monitoring an application with Amazon CloudWatch • Monitoring application access logs • Logging Amplify API calls using AWS CloudTrail Monitoring an application with Amazon CloudWatch AWS Amplify is integrated with Amazon CloudWatch, enabling you to monitor metrics for your Amplify applications in near real-time. You can create alarms that send notiﬁcations when a metric exceeds a threshold you set. For more information about how the CloudWatch service works, see the Amazon CloudWatch User Guide. Supported CloudWatch metrics Amplify supports six CloudWatch metrics in the AWS/AmplifyHosting namespace for monitoring traﬃc, errors, data transfer, and latency for your apps. These metrics are aggregated at one minute intervals. CloudWatch monitoring metrics are free of charge and don't count against the CloudWatch service quotas. Not all available statistics are applicable for every metric. The following table lists the most relevant statistics with a description for each supported metric. Monitoring with CloudWatch 203 AWS Amplify Hosting Metrics Requests BytesDownloaded BytesUploaded 4xxErrors 5xxErrors Latency User Guide Description The total number of viewer requests received by your app. The most relevant statistic is Sum. Use the Sum statistic to get the total number of requests. The total amount of data transferred out of your app (downloaded) in bytes by viewers for GET, HEAD, and OPTIONS requests. The most relevant statistic is Sum. The total amount of data transferred into your app (uploaded) in bytes for any request, including headers. Amplify doesn't charge you for data uploaded in your applications. The most relevant statistic is Sum. The number of requests that returned an error in the HTTP status code 400-499 range. The most relevant statistic is Sum. Use the Sum statistic to get the total occurrences of these errors. The number of requests that returned an error in the HTTP status code 500-599 range. The most relevant statistic is Sum. Use the Sum statistic to get the total occurrences of these errors. The time to ﬁrst byte in seconds. This is the total time between when Amplify Hosting receives a request and when it returns a Supported CloudWatch metrics 204 AWS Amplify Hosting Metrics User Guide Description response to the network. This doesn't include the network latency encountered for a response to reach the viewer's device. The most relevant statistics are Average, Maximum, Minimum, p10, p50, p90, p95, and p100. Use the Average statistic to evaluate expected latencies. Amplify provides the following CloudWatch metric dimensions. Dimension App AWS account Description Metric data is provided by app. Metric data is provided across all apps in the AWS account. Accessing CloudWatch metrics You can access CloudWatch metrics directly from the Amplify console using the following procedure. Note You can also access CloudWatch metrics in the AWS Management Console at https:// console.aws.amazon.com/cloudwatch/. To access metrics in the Amplify console 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to view metrics for. Accessing CloudWatch metrics 205 AWS Amplify Hosting User Guide 3. In the navigation pane, choose App Settings, Monitoring. 4. On the Monitoring page, choose Metrics. Creating CloudWatch alarms You can create CloudWatch alarms in the Amplify console that send notiﬁcations when speciﬁc criteria are met. An alarm watches a single CloudWatch metric and sends an Amazon Simple Notiﬁcation Service notiﬁcation when the metric breaches the threshold for a speciﬁed number of evaluation periods. You can create more advanced alarms that use metric math expressions in the CloudWatch console or using the CloudWatch APIs. For example, you can create an alarm that notiﬁes you when the percentage of 4xxErrors exceeds 15% for three consecutive periods. For more information, see Creating a CloudWatch Alarm Based on a Metric Math Expression in the Amazon CloudWatch User Guide. Standard CloudWatch pricing applies to alarms. For more information, see Amazon CloudWatch pricing. Use the following procedure to create an alarm in the Amplify console.
amplify-console-ug-065	amplify-console-ug.pdf	65	notiﬁcation when the metric breaches the threshold for a speciﬁed number of evaluation periods. You can create more advanced alarms that use metric math expressions in the CloudWatch console or using the CloudWatch APIs. For example, you can create an alarm that notiﬁes you when the percentage of 4xxErrors exceeds 15% for three consecutive periods. For more information, see Creating a CloudWatch Alarm Based on a Metric Math Expression in the Amazon CloudWatch User Guide. Standard CloudWatch pricing applies to alarms. For more information, see Amazon CloudWatch pricing. Use the following procedure to create an alarm in the Amplify console. To create a CloudWatch alarm for an Amplify metric 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to set an alarm on. 3. In the navigation pane, choose App Settings, Monitoring. 4. On the Monitoring page, choose Alarms. 5. Choose Create alarm. 6. In the Create alarm window, conﬁgure your alarm as follows: a. b. For Metric, choose the name of the metric to monitor from the list. For Name of alarm, enter a meaningful name for the alarm. For example, if you are monitoring Requests, you could name the alarm HighTraffic. The name must contain only ASCII characters. c. For Set up notiﬁcations, do one of the following: • i. Choose New to set up a new Amazon SNS topic. Creating CloudWatch alarms 206 AWS Amplify Hosting User Guide ii. For Email address, enter the email address for the recipient of the notiﬁcations. iii. Choose Add new email address to add additional recipients. • i. ii. Choose Existing to reuse an Amazon SNS topic. For SNS topic, select the name of an existing Amazon SNS topic from the list. d. For Whenever the Statistic of Metric, set the conditions for your alarm as follows: i. Specify whether the metric must be greater than, less than, or equal to the threshold value. ii. Specify the threshold value. iii. Specify the number of consecutive evaluation periods that must be in the alarm state to invoke the alarm. iv. Specify the length of time of the evaluation period. e. Choose Create alarm. Note Each Amazon SNS recipient that you specify receives a conﬁrmation email from AWS Notiﬁcations. The email contains a link that the recipient must follow to conﬁrm their subscription and receive notiﬁcations. Accessing CloudWatch Logs for SSR apps Amplify sends information about your Next.js runtime to Amazon CloudWatch Logs in your AWS account. When you deploy an SSR app, the app requires an IAM service role that Amplify assumes when calling other services on your behalf. You can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created. If you choose to allow Amplify to create an IAM role for you, the role will already have the permissions to create CloudWatch Logs. If you create your own IAM role, you will need to add the following permissions to your policy to allow Amplify to access Amazon CloudWatch Logs. logs:CreateLogStream logs:CreateLogGroup logs:DescribeLogGroups logs:PutLogEvents Accessing CloudWatch Logs for SSR apps 207 AWS Amplify Hosting User Guide For more information about adding a service role, see Adding a service role with permissions to deploy backend resources. For more information about deploying server-side rendered apps, see Deploying server-side rendered applications with Amplify Hosting. Monitoring application access logs Amplify stores access logs for all of the apps you host in Amplify. Access logs contain information about requests that are made to your hosted apps. Amplify retains all access logs for an app until you delete the app. All access logs for an app are available in the Amplify console. However, each individual request for access logs is limited to a two week time period that you specify. Amplify never reuses CloudFront distributions between customers. Amplify creates CloudFront distributions in advance so that you don't have to wait for a CloudFront distribution to be created when you deploy a new app. Before these distributions are assigned to an Amplify app, they might receive traﬃc from bots. However, they're conﬁgured to always respond as Not found before they're assigned. If your app's access logs contain entries for a time period before you created your app, these entries are related to this activity. Important We recommend that you use the logs to understand the nature of the requests for your content, not as a complete accounting of all requests. Amplify delivers access logs on a best-eﬀort basis. The log entry for a particular request might be delivered long after the request was actually processed and, in rare cases, a log entry might not be delivered at all. When a log entry is omitted from access logs, the number of entries in the access
amplify-console-ug-066	amplify-console-ug.pdf	66	access logs contain entries for a time period before you created your app, these entries are related to this activity. Important We recommend that you use the logs to understand the nature of the requests for your content, not as a complete accounting of all requests. Amplify delivers access logs on a best-eﬀort basis. The log entry for a particular request might be delivered long after the request was actually processed and, in rare cases, a log entry might not be delivered at all. When a log entry is omitted from access logs, the number of entries in the access logs won't match the usage that appears in the AWS billing and usage reports. Retrieving an app's access logs Use the following procedure to retrieve access logs for an Amplify app. To view access logs 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to view access logs for. 3. In the navigation pane, choose Hosting, then choose Monitoring. Monitoring access logs 208 AWS Amplify Hosting User Guide 4. On the Monitoring page, choose Access logs. 5. Choose Edit time range. 6. In the Edit time range window do the following. a. b. c. For Start date, specify the ﬁrst day of the two week interval to retrieve logs for. For Start time, choose the time on the ﬁrst day to start the log retrieval. Choose Conﬁrm. 7. The Amplify console displays the logs for your speciﬁed time range in the Access logs section. Choose Download to save the logs in a CSV format. Analyzing access logs To analyze access logs you can store the CSV ﬁles in an Amazon S3 bucket. One way to analyze your access logs is to use Athena. Athena is an interactive query service that can help you analyze data for AWS services. You can follow the step-by-step instructions here to create a table. Once your table has been created, you can query data as follows. SELECT SUM(bytes) AS total_bytes FROM logs WHERE "date" BETWEEN DATE '2018-06-09' AND DATE '2018-06-11' LIMIT 100; Logging Amplify API calls using AWS CloudTrail AWS Amplify is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amplify. CloudTrail captures all API calls for Amplify as events. The calls captured include calls from the Amplify console and code calls to the Amplify API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amplify. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information that CloudTrail collects, you can determine the request that was made to Amplify, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Analyzing access logs 209 AWS Amplify Hosting User Guide Amplify information in CloudTrail CloudTrail is enabled on your AWS account by default. When activity occurs in Amplify, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail Event history in the AWS CloudTrail User Guide. For an ongoing record of events in your AWS account, including events for Amplify, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following in the AWS CloudTrail User Guide: • Creating a trail for your AWS account • CloudTrail supported services and integrations • Conﬁguring Amazon SNS notiﬁcations for CloudTrail • Receiving CloudTrail log ﬁles from multiple regions and Receiving CloudTrail log ﬁles from multiple accounts All Amplify operations are logged by CloudTrail and are documented in the AWS Amplify Console API Reference, the AWS Amplify Admin UI API Reference, and the Amplify UI Builder API Reference. For example, calls to the CreateApp, DeleteApp and DeleteBackendEnvironment operations generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Was the request made with root or AWS Identity and Access Management (IAM) user credentials. • Was the request made with temporary
amplify-console-ug-067	amplify-console-ug.pdf	67	regions and Receiving CloudTrail log ﬁles from multiple accounts All Amplify operations are logged by CloudTrail and are documented in the AWS Amplify Console API Reference, the AWS Amplify Admin UI API Reference, and the Amplify UI Builder API Reference. For example, calls to the CreateApp, DeleteApp and DeleteBackendEnvironment operations generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Was the request made with root or AWS Identity and Access Management (IAM) user credentials. • Was the request made with temporary security credentials for a role or federated user. • Was the request made by another AWS service. For more information, see the CloudTrail userIdentity element in the AWS CloudTrail User Guide. Amplify information in CloudTrail 210 AWS Amplify Hosting User Guide Understanding Amplify log ﬁle entries A trail is a conﬁguration that enables delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the AWS Amplify Console API Reference ListApps operation. { "eventVersion": "1.08", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::444455556666:user/Mary_Major", "accountId": "444455556666", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "Mary_Major", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2021-01-12T05:48:10Z" } } }, "eventTime": "2021-01-12T06:47:29Z", "eventSource": "amplify.amazonaws.com", "eventName": "ListApps", "awsRegion": "us-west-2", "sourceIPAddress": "192.0.2.255", "userAgent": "aws-internal/3 aws-sdk-java/1.11.898 Linux/4.9.230-0.1.ac.223.84.332.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.275-b01 java/1.8.0_275 vendor/Oracle_Corporation", "requestParameters": { "maxResults": "100" }, "responseElements": null, "requestID": "1c026d0b-3397-405a-95aa-aa43aexample", Understanding Amplify log ﬁle entries 211 AWS Amplify Hosting User Guide "eventID": "c5fca3fb-d148-4fa1-ba22-5fa63example", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "444455556666" } The following example shows a CloudTrail log entry that demonstrates the AWS Amplify Admin UI API Reference ListBackendJobs operation. { "eventVersion": "1.08", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::444455556666:user/Mary_Major", "accountId": "444455556666", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "Mary_Major", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2021-01-13T00:47:25Z" } } }, "eventTime": "2021-01-13T01:15:43Z", "eventSource": "amplifybackend.amazonaws.com", "eventName": "ListBackendJobs", "awsRegion": "us-west-2", "sourceIPAddress": "192.0.2.255", "userAgent": "aws-internal/3 aws-sdk-java/1.11.898 Linux/4.9.230-0.1.ac.223.84.332.metal1.x86_64 OpenJDK_64-Bit_Server_VM/25.275-b01 java/1.8.0_275 vendor/Oracle_Corporation", "requestParameters": { "appId": "d23mv2oexample", "backendEnvironmentName": "staging" }, "responseElements": { "jobs": [ Understanding Amplify log ﬁle entries 212 AWS Amplify Hosting { User Guide "appId": "d23mv2oexample", "backendEnvironmentName": "staging", "jobId": "ed63e9b2-dd1b-4bf2-895b-3d5dcexample", "operation": "CreateBackendAuth", "status": "COMPLETED", "createTime": "1610499932490", "updateTime": "1610500140053" }, { "appId": "d23mv2oexample", "backendEnvironmentName": "staging", "jobId": "06904b10-a795-49c1-92b7-185dfexample", "operation": "CreateBackend", "status": "COMPLETED", "createTime": "1610499657938", "updateTime": "1610499704458" } ], "appId": "d23mv2oexample", "backendEnvironmentName": "staging" }, "requestID": "7adfabd6-98d5-4b11-bd39-c7deaexample", "eventID": "68769310-c96c-4789-a6bb-68b52example", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "444455556666" } Understanding Amplify log ﬁle entries 213 AWS Amplify Hosting User Guide Email notiﬁcations for builds You can set up email notiﬁcations for an AWS Amplify app to alert stakeholders or team members when a build succeeds or fails. Amplify Hosting creates an Amazon Simple Notiﬁcation Service (SNS) topic in your account and uses it to conﬁgure email notiﬁcations. Notiﬁcations can be conﬁgured to apply to all branches or speciﬁc branches of an Amplify app. Setting up email notiﬁcations Use the following procedures to set up email notiﬁcations for all branches or speciﬁc branches of an Amplify app. To set up email notiﬁcations for an Amplify app 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to set up email notiﬁcations for. 3. In the navigation pane, choose Hosting, Build notiﬁcations. On the Build notiﬁcations page, choose Manage notiﬁcations. 4. On the Manage notiﬁcations page, choose Add new. 5. Do one of the following: • • To send notiﬁcations for a single branch, for Email, enter the email address to send notiﬁcations to. For Branch, select the name of the branch to send notiﬁcations for. To send notiﬁcations for all connected branches, for Email, enter the email address to send notiﬁcations to. For Branch, choose All Branches. 6. Choose Save. Setting up email notiﬁcations 214 AWS Amplify Hosting User Guide Using the Deploy to Amplify button to share a GitHub project Important One-click deployment using the Deploy to Amplify Hosting button is no longer available. To deploy from a repository, create a new application in Amplify Hosting. For instructions, see Getting started with deploying an app to Amplify Hosting. The Deploy to Amplify Hosting button enables you to share GitHub projects publicly or within your team. The following is an image of the button: Adding the Deploy to Amplify Hosting button to a repository or blog Add the button to your GitHub README.md ﬁle, blog post, or any other markup page that
amplify-console-ug-068	amplify-console-ug.pdf	68	Deploy to Amplify button to share a GitHub project Important One-click deployment using the Deploy to Amplify Hosting button is no longer available. To deploy from a repository, create a new application in Amplify Hosting. For instructions, see Getting started with deploying an app to Amplify Hosting. The Deploy to Amplify Hosting button enables you to share GitHub projects publicly or within your team. The following is an image of the button: Adding the Deploy to Amplify Hosting button to a repository or blog Add the button to your GitHub README.md ﬁle, blog post, or any other markup page that renders HTML. The button has the following two components: 1. An SVG image located at the URL https://oneclick.amplifyapp.com/button.svg 2. The Amplify console URL with a link to your GitHub repository. Your can either copy your repository's URL, such as https://github.com/username/repository, or you can provide a deep link into a speciﬁc folder, such as https://github.com/username/repository/ tree/branchname/folder. Amplify Hosting will deploy the default branch in your repository. Additional branches can be connected after the app is connected. Use the following example to add the button to a markdown ﬁle, such as your GitHub README.md. Replace https://github.com/username/repository with the URL to your repository. [![amplifybutton](https://oneclick.amplifyapp.com/button.svg)](https:// console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/username/ repository) Adding the Deploy to Amplify Hosting button to a repository or blog 215 AWS Amplify Hosting User Guide Use the following example to add the button to any HTML document. Replace https:// github.com/username/repository with the URL to your repository. <a href="https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/ username/repository"> <img src="https://oneclick.amplifyapp.com/button.svg" alt="Deploy to Amplify Hosting"> </a> Adding the Deploy to Amplify Hosting button to a repository or blog 216 AWS Amplify Hosting User Guide Setting up Amplify access to GitHub repositories Amplify now uses the GitHub Apps feature to authorize Amplify read-only access to GitHub repositories. With the Amplify GitHub App, permissions are more ﬁne-tuned, enabling you to grant Amplify access to only the repositories that you specify. To learn more about GitHub Apps, see About GitHub Apps on the GitHub website. When you connect a new app stored in a GitHub repo, by default Amplify uses the GitHub App to access the repo. However, existing Amplify apps that you previously connected from GitHub repos use OAuth for access. CI/CD will continue to work for these apps, but we highly recommend that you migrate them to use the new Amplify GitHub App. When you deploy a new app or migrate an existing app using the Amplify console, you are automatically directed to the installation location for the Amplify GitHub App. To manually access the installation landing page for the app, open a web browser and navigate to the app by region. Use the format https://github.com/apps/aws-amplify-REGION, replacing REGION with the region where you will deploy your Amplify app. For example, to install the Amplify GitHub App in the US West (Oregon) region, navigate to https://github.com/apps/aws-amplify-us-west-2. Topics • Installing and authorizing the Amplify GitHub App for a new deployment • Migrating an existing OAuth app to the Amplify GitHub App • Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments • Setting up web previews with the Amplify GitHub App Installing and authorizing the Amplify GitHub App for a new deployment When you deploy a new app to Amplify from existing code in a GitHub repo, use the following instructions to install and authorize the GitHub App. To install and authorize the Amplify GitHub App 1. 2. Sign in to the AWS Management Console and open the Amplify console. From the All apps page, choose New app, then Host web app. Installing and authorizing the Amplify GitHub App for a new deployment 217 AWS Amplify Hosting User Guide 3. On the Get started with Amplify Hosting page, choose GitHub, then choose Continue. 4. If this is the ﬁrst time connecting a GitHub repository, A new page opens in your browser on GitHub.com, requesting permission to authorize AWS Amplify in your GitHub account. Choose Authorize. 5. Next, you must install the Amplify GitHub App in your GitHub account. A page opens on Github.com requesting permission to install and authorize AWS Amplify in your GitHub account. 6. Select the GitHub account where you want to install the Amplify GitHub App. 7. Do one of the following: • • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are migrating in the repos that you select. 8. Choose Install & Authorize. 9. You are redirected to the Add repository branch page for your app in the Amplify console. 10. In the Recently updated repositories list, select the name of the repository to connect. 11. In the Branch list, select the name of the repository branch to connect. 12.
amplify-console-ug-069	amplify-console-ug.pdf	69	the following: • • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are migrating in the repos that you select. 8. Choose Install & Authorize. 9. You are redirected to the Add repository branch page for your app in the Amplify console. 10. In the Recently updated repositories list, select the name of the repository to connect. 11. In the Branch list, select the name of the repository branch to connect. 12. Choose Next. 13. On the Conﬁgure build settings page, choose Next. 14. On the Review page, choose Save and deploy. Migrating an existing OAuth app to the Amplify GitHub App Existing Amplify apps that you previously connected from GitHub repositories use OAuth for repo access. We strongly recommend that you migrate these apps to use the Amplify GitHub App. Use the following instructions to migrate an app and delete its corresponding OAuth webhook in your GitHub account. Note that the procedure for migrating varies depending on whether the Amplify GitHub app is already installed. After you migrate your ﬁrst app and install and authorize the GitHub App, you only need to update the repository permissions for subsequent app migrations. To migrate an app from OAuth to the GitHub App 1. Sign in to the AWS Management Console and open the Amplify console. Migrating an existing OAuth app to the Amplify GitHub App 218 AWS Amplify Hosting User Guide 2. Choose the app that you want to migrate. 3. On the app's information page, locate the blue Migrate to our GitHub App message and choose Start migration. 4. On the Install and authorize GitHub App page, choose Conﬁgure GitHub App. 5. A new page opens in your browser on GitHub.com, requesting permission to authorize AWS Amplify in your GitHub account. Choose Authorize. 6. Select the GitHub account where you want to install the Amplify GitHub App. 7. Do one of the following: • • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are migrating in the repositories that you select. 8. Choose Install & Authorize. 9. You are redirected to the Install and authorize GitHub App page for your app in the Amplify console. If GitHub authorization was successful, you will see a success message. Choose, Next. 10. On the Complete installation page, choose Complete installation. This step deletes your existing webhook, creates a new one, and completes the migration. Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments Existing Amplify apps that you previously connected from GitHub repositories use OAuth for repo access. This can include apps that you deployed using the Amplify Command Line Interface (CLI), AWS CloudFormation, or the SDKs. We strongly recommend that you migrate these apps to use the new Amplify GitHub App. Migration must be performed in the Amplify console in the AWS Management Console. For instructions, see Migrating an existing OAuth app to the Amplify GitHub App. You can use AWS CloudFormation, the Amplify CLI, and the SDKs to deploy a new Amplify app that uses the GitHub App for repo access. This process requires that you ﬁrst install the Amplify GitHub App in your GitHub account. Next, you will need to generate a personal access token in your GitHub account. Lastly, deploy the app and specify the personal access token. Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments 219 AWS Amplify Hosting User Guide Install the Amplify GitHub App in your account 1. Open a web browser and navigate to the installation location for the Amplify GitHub App in the AWS Region where you will deploy your app. Use the format https://github.com/apps/aws-amplify-REGION/installations/ new, replacing REGION with your own input. For example, if you are installing your app in the US West (Oregon) region, specify https://github.com/apps/aws-amplify-us-west-2/ installations/new. 2. Select the GitHub account where you want to install the Amplify GitHub app. 3. Do one of the following: • • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are migrating in the repos that you select. 4. Choose Install. Generate a personal access token in your GitHub account 1. 2. 3. Sign in to your GitHub account. In the upper right corner, locate your proﬁle photo and choose Settings from the menu. In the left navigation menu, choose Developer settings. 4. On the GitHub Apps page, in the left navigation
amplify-console-ug-070	amplify-console-ug.pdf	70	• • To apply the installation to all repositories, choose All repositories. To limit the installation to the speciﬁc repositories that you select, choose Only select repositories. Make sure to include the repo for the app that you are migrating in the repos that you select. 4. Choose Install. Generate a personal access token in your GitHub account 1. 2. 3. Sign in to your GitHub account. In the upper right corner, locate your proﬁle photo and choose Settings from the menu. In the left navigation menu, choose Developer settings. 4. On the GitHub Apps page, in the left navigation menu, choose Personal access tokens. 5. On the Personal access tokens page, choose Generate new token. 6. On the New personal access token page, for Note enter a descriptive name for the token. 7. In the Select scopes section, select admin:repo_hook. 8. Choose Generate token. 9. Copy and save the personal access token. You will need to provide it when you deploy an Amplify app with the CLI, AWS CloudFormation, or the SDKs. After the Amplify GitHub app is installed in your GitHub account and you have generated a personal access token, you can deploy a new app with the Amplify CLI, AWS CloudFormation, or the SDKs. Use the accessToken ﬁeld to specify the personal access token that you created in Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments 220 AWS Amplify Hosting User Guide the previous procedure. For more information, see CreateApp in the Amplify API reference and AWS::Amplify::App in the AWS CloudFormation User Guide. The following CLI command deploys a new Amplify app that uses the GitHub App for repository access. Replace myapp-using-githubapp, https://github.com/Myaccount/react-app, and MY_TOKEN with your own information. aws amplify create-app --name myapp-using-githubapp --repository https://github.com/ Myaccount/react-app --access-token MY_TOKEN Setting up web previews with the Amplify GitHub App A web preview deploys every pull request (PR) made to your GitHub repository to a unique preview URL. Previews now use the Amplify GitHub App for access to your GitHub repo. For instructions on installing and authorizing the GitHub App for web previews, see Enable web previews for pull requests . Setting up web previews with the Amplify GitHub App 221 AWS Amplify Hosting User Guide Customizing the build image You can use a custom build image to provide a customized build environment for an Amplify app. If you have speciﬁc dependencies that take a long time to install during a build using Amplify's default container, you can create your own Docker image and reference it during a build. Images can be hosted on Amazon Elastic Container Registry Public. For a custom build image to work as an Amplify build image, it must meet the following requirements. Custom build image requirements 1. A Linux distribution that supports the GNU C Library (glibc), such as Amazon Linux, compiled for the x86-64 architecture. 2. cURL: When we launch your custom image, we download our build runner into your container, and therefore we require cURL to be present. If this dependency is missing, the build instantly fails without any output as our build-runner is unable to produce any output. 3. Git: In order to clone your Git repository we require Git to be installed in the image. If this dependency is missing, the Cloning repository step will fail. 4. OpenSSH: In order to securely clone your repository we require OpenSSH to set up the SSH key temporarily during the build. The OpenSSH package provides the commands that the build runner requires to do this. 5. Bash and The Bourne Shell: These two utilities are used to run commands at build time. If they aren't installed, your builds might fail prior to starting. 6. Node.JS+NPM: Our build runner doesn't install Node. Instead, it relies on Node and NPM being installed in the image. This is only required for builds that require NPM packages or Node speciﬁc commands. However, we strongly recommend installing them because when they are present, the Amplify build runner can use these tools to improve the build execution. Amplify's package override feature uses NPM to install the Hugo-extended package when you set an override for Hugo. The following packages aren't required, but we strongly recommend that you install them. 1. NVM (Node Version Manager): We recommend that you install this version manager if you need to handle diﬀerent versions of Node. When you set an override, Amplify’s package override feature uses NVM to change Node.js versions before each build. 222 AWS Amplify Hosting User Guide 2. Wget: Amplify can use the Wget utility to download ﬁles during the build process. We recommend that you install it in your custom image. 3. Tar: Amplify can use the Tar utility to uncompress downloaded ﬁles during the build process. We recommend that you install it in your custom
amplify-console-ug-071	amplify-console-ug.pdf	71	that you install them. 1. NVM (Node Version Manager): We recommend that you install this version manager if you need to handle diﬀerent versions of Node. When you set an override, Amplify’s package override feature uses NVM to change Node.js versions before each build. 222 AWS Amplify Hosting User Guide 2. Wget: Amplify can use the Wget utility to download ﬁles during the build process. We recommend that you install it in your custom image. 3. Tar: Amplify can use the Tar utility to uncompress downloaded ﬁles during the build process. We recommend that you install it in your custom image. Conﬁguring a custom build image for an app Use the following procedure to conﬁgure a custom build image for an application in the Amplify console. To conﬁgure a custom build image hosted in Amazon ECR 1. See Getting started in the Amazon ECR Public User guide to set up an Amazon ECR Public repository with a Docker image. 2. Sign in to the AWS Management Console and open the Amplify console. 3. Choose the app that you want to conﬁgure a custom build image for. 4. In the navigation pane, choose Hosting, Build settings. 5. On the Build settings page, in the Build image settings section, choose Edit. 6. On the Edit build image settings page, expand the Build image menu, and choose Custom Build Image. 7. Enter the name of the Amazon ECR Public repo that you created in step one. This is where your build image is hosted. For example, if the name of your repo is ecr-examplerepo, you would enter public.ecr.aws/xxxxxxxx/ecr-examplerepo. 8. Choose Save. Using speciﬁc package and dependency versions in the build image Live package updates enable you to specify the versions of packages and dependencies to use in the Amplify default build image. The default build image comes with several packages and dependencies pre-installed (e.g. Hugo, Amplify CLI, Yarn, etc). With live package updates you can override the version of these dependencies and specify either a speciﬁc version, or ensure that the latest version is always installed. Conﬁguring a custom build image for an app 223 AWS Amplify Hosting User Guide If live package updates is enabled, before your build runs, the build runner ﬁrst updates (or downgrades) the speciﬁed dependencies. This increases the build time proportional to the time it takes to update the dependencies, but the beneﬁt is that you can ensure the same version of a dependency is used to build your app. Warning Setting the Node.js version to latest causes builds to fail. Instead, you must specify an exact Node.js version, such as 18, 21.5, or v0.1.2. To conﬁgure live package updates 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app that you want to conﬁgure live package updates for. 3. In the navigation pane, choose Hosting, Build settings. 4. On the Build settings page, in the Build image settings section, choose Edit. 5. On the Edit build image settings page, Live package updates list, choose Add new. 6. 7. For Package, select the dependency to override. For Version, either keep the default latest or enter a speciﬁc version of the dependency. If you use latest, the dependency will always be upgraded to the latest version available. 8. Choose Save. Using speciﬁc package and dependency versions in the build image 224 AWS Amplify Hosting User Guide Managing the cache conﬁguration for an app Amplify uses Amazon CloudFront to manage the caching conﬁguration for your hosted applications. A cache conﬁguration is applied to each app to optimize for the best performance. On August 13, 2024, Amplify released improvements to caching eﬃciency for applications. For more information, see CDN Caching Improvements for Better App Performance with AWS Amplify Hosting. The following table summarizes Amplify support for speciﬁc caching behaviors before and after the caching improvements release. Caching behavior Previous support With caching improvements You can add custom headers for an app in the Amplify Yes Yes console or in a customHea ders.yaml ﬁle. One of the headers that you can override is Cache-Control . For more information, see Setting custom headers for an Amplify app. Amplify respects the Cache- Control headers that you deﬁne in a customHea ders.yaml ﬁle and they take precedence over Amplify's default cache settings. Amplify respects the Cache- Control headers set within an application’s framework for dynamic routes (for example, Next.js SSR routes). Yes Yes Yes Yes 225 AWS Amplify Hosting User Guide Caching behavior Previous support With caching improvements If a Cache-Control header is set in the app's customHea ders.yaml ﬁle, this takes precedence over settings in the next.config.js ﬁle. Each new CI/CD app deployment clears the cache. You can turn on performance mode for an app. Yes Yes Yes No The performance mode setting is no longer available
amplify-console-ug-072	amplify-console-ug.pdf	72	in a customHea ders.yaml ﬁle and they take precedence over Amplify's default cache settings. Amplify respects the Cache- Control headers set within an application’s framework for dynamic routes (for example, Next.js SSR routes). Yes Yes Yes Yes 225 AWS Amplify Hosting User Guide Caching behavior Previous support With caching improvements If a Cache-Control header is set in the app's customHea ders.yaml ﬁle, this takes precedence over settings in the next.config.js ﬁle. Each new CI/CD app deployment clears the cache. You can turn on performance mode for an app. Yes Yes Yes No The performance mode setting is no longer available in the Amplify console. However, you can create a Cache-Control header that sets the s-maxage directive. For instructions, see Using the Cache-Con trol header to increase app performance. The following table lists the changes to the default values for speciﬁc cache settings. Cache setting Previous default value Default value with caching improvements Cache duration for static assets Two seconds One year Cache duration for reverse proxy responses Two seconds Zero seconds (no caching) Max Time to Live (TTL) Ten minutes One year 226 AWS Amplify Hosting User Guide For more information about how Amplify determines the caching conﬁguration to apply to an application and instructions on managing cache key conﬁguration, see the following topics. Topics • How Amplify applies cache conﬁguration to an app • Managing cache key cookies How Amplify applies cache conﬁguration to an app To manage caching for your app, Amplify determines the type of content that is being served by examining the app's platform type and rewrite rules. For Compute apps, Amplify also examines the routing rules in the deployment manifest. Note The app's platform type is set by Amplify Hosting during deployment. An SSG (static) app is set to the platform type WEB. An SSR app (Next.js 12 or later) is set to the platform type WEB_COMPUTE. Amplify identiﬁes the following four types of content and applies the speciﬁed managed cache policy. Static The content served from apps with the WEB platform, or the static routes in a WEB_COMPUTE app. This content uses the Amplify-StaticContent cache policy. Image Optimization The images served by the ImageOptimization routes in a WEB_COMPUTE app. This content uses the Amplify-ImageOptimization cache policy. Compute The content served by the Compute routes in a WEB_COMPUTE app. This includes all server-side rendered (SSR) content. How Amplify applies cache conﬁguration 227 AWS Amplify Hosting User Guide This content uses either the Amplify-Default or Amplify-DefaultNoCookies cache policy depending on the value of cacheConfig.type that is set on your Amplify App. Reverse Proxy The content served by paths that match a reverse proxy rewrite custom rule. For more information about creating this custom rule, see Reverse proxy rewrite in the Using redirects chapter. This content uses either the Amplify-Default or Amplify-DefaultNoCookies cache policy depending on the value of cacheConfig.type that is set on your Amplify App. Understanding Amplify's managed cache policies Amplify uses the following predeﬁned managed cache policies to optimize the default cache conﬁguration for your hosted applications. • Amplify-Default • Amplify-DefaultNoCookies • Amplify-ImageOptimization • Amplify-StaticContent Amplify-Default managed cache policy settings View this policy in the CloudFront console This policy is designed for use with an origin that is an AWS Amplify web app. This policy has the following settings: • Minimum TTL: 0 seconds • Maximum TTL: 31536000 seconds (one year) • Default TTL: 0 seconds • Headers included in cache key: • Authorization • Accept • CloudFront-Viewer-Country Understanding Amplify's managed cache policies 228 AWS Amplify Hosting • Host • Cookies included in cache key: All cookies are included. • Query strings included in cache key: All query strings are included. • Cache compressed objects setting: Gzip and Brotli enabled. User Guide Amplify-DefaultNoCookies managed cache policy settings View this policy in the CloudFront console This policy is designed for use with an origin that is an AWS Amplify web app. This policy has the following settings: • Minimum TTL: 0 seconds • Maximum TTL: 31536000 seconds (one year) • Default TTL: 0 seconds • Headers included in cache key: • Authorization • Accept • CloudFront-Viewer-Country • Host • Cookies included in cache key: No cookies are included. • Query strings included in cache key: All query strings are included. • Cache compressed objects setting: Gzip and Brotli enabled. Amplify-ImageOptimization managed cache policy settings View this policy in the CloudFront console This policy is designed for use with an origin that is an AWS Amplify web app. This policy has the following settings: • Minimum TTL: 0 seconds • Maximum TTL: 31536000 seconds (one year) Understanding Amplify's managed cache policies 229 User Guide AWS Amplify Hosting • Default TTL: 0 seconds • Headers included in cache key: • Authorization • Accept • Host • Cookies included in cache key: No cookies are included. • Query
amplify-console-ug-073	amplify-console-ug.pdf	73	All query strings are included. • Cache compressed objects setting: Gzip and Brotli enabled. Amplify-ImageOptimization managed cache policy settings View this policy in the CloudFront console This policy is designed for use with an origin that is an AWS Amplify web app. This policy has the following settings: • Minimum TTL: 0 seconds • Maximum TTL: 31536000 seconds (one year) Understanding Amplify's managed cache policies 229 User Guide AWS Amplify Hosting • Default TTL: 0 seconds • Headers included in cache key: • Authorization • Accept • Host • Cookies included in cache key: No cookies are included. • Query strings included in cache key: All query strings are included. • Cache compressed objects setting: Gzip and Brotli enabled. Amplify-StaticContent managed cache policy settings View this policy in the CloudFront console This policy is designed for use with an origin that is an AWS Amplify web app. This policy has the following settings: • Minimum TTL: 0 seconds • Maximum TTL: 31536000 seconds (one year) • Default TTL: 0 seconds • Headers included in cache key: • Authorization • Host • Cookies included in cache key: No cookies are included. • Query strings included in cache key: No query strings are included. • Cache compressed objects setting: Gzip and Brotli enabled. Managing cache key cookies When you deploy your app to Amplify, you can choose whether you want to include or exclude cookies in the cache key. In the Amplify console, this setting is speciﬁed on the Custom headers and cache page using the Cache key settings toggle. For instructions, see Including or excluding cookies from the cache key. Managing cache key cookies 230 AWS Amplify Hosting Include cookies in the cache key User Guide This is the default cache conﬁguration. With this setting, Amplify automatically chooses an optimal cache conﬁguration for your app based on the type of content that is being served. If you are using the SDKs or the AWS CLI, this setting corresponds to setting cacheConfig.type to AMPLIFY_MANAGED with the CreateApp or UpdateApp APIs. Exclude cookies from the cache key This cache conﬁguration is similar to the default conﬁguration, except that it excludes all cookies from the cache key. You must explicitly choose this cache conﬁguration type. Choosing to exclude cookies from the cache key can result in better cache performance. However, before you choose this cache conﬁguration, it is important to consider whether your app uses cookies to serve dynamic content. If you are using the SDKs or the AWS CLI, this setting corresponds to setting the cacheConfig.type to AMPLIFY_MANAGED_NO_COOKIES with the CreateApp or UpdateApp APIs. For more information about the cache key, see Understand the cache key in the Amazon CloudFront Developer Guide;. Including or excluding cookies from the cache key You can set the cache key cookie conﬁguration for an app in the Amplify console, SDKs, or the AWS CLI. Use the following procedure to specify whether to include or exclude cookies from the cache key when you are deploying a new app using the Amplify console. To set the cache key cookie conﬁguration when deploying an app to Amplify 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, choose Create new app. 3. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 4. On the Add repository branch page, do the following: a. Select the name of the repository to connect. Including or excluding cookies from the cache key 231 AWS Amplify Hosting User Guide b. c. Select the name of the repository branch to connect. Choose Next. 5. If the app requires an IAM service role, you can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created. • • To allow Amplify to automatically create a role and attach it to your app: • Choose Create and use a new service role. To attach a service role that you previously created: a. b. Choose Use an existing service role. Select the role to use from the list. 6. Choose Advanced settings, then locate the Cache key settings section. 7. Choose either Keep cookies in cache key or Remove cookies from cache key. The following screenshot shows the Cache key settings toggle in the console. 8. Choose Next. 9. On the Review page, choose Save and deploy. Changing the cache key cookie conﬁguration for an app You can change the cache key cookie conﬁguration for an app that is already deployed to Amplify. Use the following procedure to change whether to include or exclude cookies from the cache key for an app using the Amplify console. To change the cache key cookie conﬁguration for a deployed app 1. Sign in to the
amplify-console-ug-074	amplify-console-ug.pdf	74	Keep cookies in cache key or Remove cookies from cache key. The following screenshot shows the Cache key settings toggle in the console. 8. Choose Next. 9. On the Review page, choose Save and deploy. Changing the cache key cookie conﬁguration for an app You can change the cache key cookie conﬁguration for an app that is already deployed to Amplify. Use the following procedure to change whether to include or exclude cookies from the cache key for an app using the Amplify console. To change the cache key cookie conﬁguration for a deployed app 1. Sign in to the AWS Management Console and open the Amplify console. Changing the cache key cookie conﬁguration for an app 232 AWS Amplify Hosting User Guide 2. On the All apps page, choose the application you want to update. 3. In the navigation pane, choose Hosting, then choose Custom headers and cache. 4. On the Custom headers and cache page, locate the Cache key settings section and choose Edit. 5. Choose either Keep cookies in cache key or Remove cookies from cache key. The following screenshot shows the Cache key settings toggle in the console. 6. Choose Save. Changing the cache key cookie conﬁguration for an app 233 AWS Amplify Hosting User Guide Managing performance for an Amplify application Amplify's default hosting architecture optimizes the balance between hosting performance and deployment availability. For most customers, we recommend that you use the default architecture. If you require ﬁner control over an app's performance, you can manually set the HTTP Cache- Control header to optimize for hosting performance by keeping content cached at the content delivery network (CDN) edge for a longer interval. Using the Cache-Control header to increase app performance HTTP Cache-Control header's max-age and s-maxage directives aﬀect the content caching duration for your app. The max-age directive tells the browser how long (in seconds) that you want content to remain in the cache before it is refreshed from the origin server. The s-maxage directive overrides max-age and lets you specify how long (in seconds) that you want content to remain at the CDN edge before it is refreshed from the origin server. Apps hosted with Amplify honor the Cache-Control headers that are sent by the origin, unless you override them with custom headers that you deﬁne. Amplify only applies Cache-Control custom headers for successful responses with a 200 OK status code. This prevents error responses from being cached and served to other users that make the same request. You can manually adjust the s-maxage directive to have more control over the performance and deployment availability of your app. For example, to change the length of time that your content stays cached at the edge, you can manually set the time to live (TTL) by updating s-maxage to a value other than the default 31536000 seconds (one year). You can deﬁne custom headers for an app in the Custom headers section of the Amplify console. For an example of the YAML format, see Setting Cache-Control custom headers. Use the following procedure to set the s-maxage directive to keep content cached at the CDN edge for 24 hours. To set a custom Cache-Control header 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the app to set custom headers for. 3. In the navigation pane, choose Hosting, Custom headers. Using the Cache-Control header to increase app performance 234 AWS Amplify Hosting User Guide 4. On the Custom headers page, choose Edit. 5. In the Edit custom headers window, enter the information for your custom header as follows: a. b. c. For pattern, enter */ for all paths. For key, enter Cache-Control. For value, enter s-maxage=86400. 6. Choose Save. 7. Redeploy the app to apply the new custom header. Using the Cache-Control header to increase app performance 235 AWS Amplify Hosting User Guide Firewall support for Amplify hosted sites Firewall support for Amplify hosted sites enables you to protect your web applications with a direct integration with AWS WAF. AWS WAF allows you to conﬁgure a set of rules, called a web access control list (web ACL), that allow, block, or monitor (count) web requests based on customizable web security rules and conditions that you deﬁne. When you integrate your Amplify app with AWS WAF, you gain more control and visibility into the HTTP traﬃc accepted by your app. To learn more about AWS WAF, see How AWS WAF Works in the AWS WAF Developer Guide. Firewall support is available in all AWS Regions in which Amplify Hosting operates. This integration falls under an AWS WAF global resource, similar to CloudFront. Web ACLs can be attached to multiple Amplify Hosting apps, but they must reside in the same Region. You can use AWS WAF to protect your Amplify app from
amplify-console-ug-075	amplify-console-ug.pdf	75	rules and conditions that you deﬁne. When you integrate your Amplify app with AWS WAF, you gain more control and visibility into the HTTP traﬃc accepted by your app. To learn more about AWS WAF, see How AWS WAF Works in the AWS WAF Developer Guide. Firewall support is available in all AWS Regions in which Amplify Hosting operates. This integration falls under an AWS WAF global resource, similar to CloudFront. Web ACLs can be attached to multiple Amplify Hosting apps, but they must reside in the same Region. You can use AWS WAF to protect your Amplify app from common web exploits, such as SQL injection and cross-site scripting. These could aﬀect your app's availability and performance, compromise security, or consume excessive resources. For example, you can create rules to allow or block requests from speciﬁed IP address ranges, requests from CIDR blocks, requests that originate from a speciﬁc country or region, or requests that contain unexpected SQL code or scripting. You can also create rules that match a speciﬁed string or a regular expression pattern in HTTP headers, method, query string, URI, and the request body (limited to the ﬁrst 8 KB). Additionally, you can create rules to block events from speciﬁc user agents, bots, and content scrapers. For example, you can use rate-based rules to specify the number of web requests that are allowed by each client IP in a trailing, continuously updated, 5-minute period. To learn more about the types of rules that are supported and additional AWS WAF features, see the AWS WAF Developer Guide and the AWS WAF API Reference. Important Security is a shared responsibility between AWS and you. AWS WAF isn't the solution to all internet security issues and you must conﬁgure it to meet your security and compliance objectives. To help you understand how to apply the shared responsibility model when using AWS WAF, see Security in your use of the AWS WAF service. Topics 236 AWS Amplify Hosting User Guide • Enabling AWS WAF for an Amplify application in the AWS Management Console • Disassociate a web ACL from an Amplify application • Enabling AWS WAF for an Amplify application using the AWS CDK • How Amplify integrates with AWS WAF • Firewall pricing for Amplify applications Enabling AWS WAF for an Amplify application in the AWS Management Console You can enable AWS WAF protections for an Amplify app either in the Amplify console or in the AWS WAF console. • Amplify console — You can enable the Firewall capabilities for an existing Amplify app by associating an AWS WAF web ACL to your app in the Amplify console. Use one-click protection to create a web ACL with pre-conﬁgured rules that we consider as best practice for most apps. You have the option to customize access by IP address and country. The instructions in this section describe setting up one-click protections. • AWS WAF console— Use a preconﬁgured web ACL that you create in the AWS WAF console or by using the AWS WAF APIs. You must create web ACLs that you want to associate with an Amplify app in the Global (CloudFront) Region. Regional web ACLs might already exist in your AWS account, but they are not compatible with Amplify. For getting started instructions, see Setting up AWS WAF and its components in the AWS WAF Developer Guide. Use the following procedure to enable AWS WAF for an existing app in the Amplify console. Enable AWS WAF for an existing Amplify app 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the deployed app to enable the Firewall feature on. 3. In the navigation pane, choose Hosting, and then choose Firewall. The following screenshot shows how to navigate to the Add ﬁrewall page in the Amplify console. Enable AWS WAF using the console 237 AWS Amplify Hosting User Guide 4. On the Add ﬁrewall page, your actions will depend on whether you want to create a new AWS WAF conﬁguration or use an existing one. • Create a new AWS WAF conﬁguration. a. Choose Create new. b. Optionally, enable any of the following conﬁgurations: i. ii. Turn on Enable Amplify-recommended Firewall protection. Turn on Restrict access to amplifyapp.com to prevent access to your app on the default Amplify domain. iii. For IP addresses, turn on Enable IP address protections. Enable AWS WAF using the console 238 AWS Amplify Hosting User Guide A. B. C. For Action, choose Allow if you want to specify the IP addresses that will have access and all others will be blocked. Choose Block if you want to specify the IP addresses that will be blocked and all others will have access. For IP version, select either IPV4
amplify-console-ug-076	amplify-console-ug.pdf	76	following conﬁgurations: i. ii. Turn on Enable Amplify-recommended Firewall protection. Turn on Restrict access to amplifyapp.com to prevent access to your app on the default Amplify domain. iii. For IP addresses, turn on Enable IP address protections. Enable AWS WAF using the console 238 AWS Amplify Hosting User Guide A. B. C. For Action, choose Allow if you want to specify the IP addresses that will have access and all others will be blocked. Choose Block if you want to specify the IP addresses that will be blocked and all others will have access. For IP version, select either IPV4 or IPV6. In the IP addresses text box, enter either your allowed or blocked IP addresses, one per line, in CIDR format. iv. For Countries, turn on Enable country protection. A. For Action, choose Allow if you want to specify the countries that will have access and all others will be blocked. Choose Block if you want to specify the countries that will be blocked and all others will have access. B. For Countries, select either your allowed or blocked countries from the list. The following screenshot demonstrates how to enable a new AWS WAF conﬁguration for an app. Enable AWS WAF using the console 239 AWS Amplify Hosting User Guide • Use an existing AWS WAF conﬁguration. a. b. Choose Use existing AWS WAF conﬁguration. Select a saved conﬁguration from the list of web ACLs in AWS WAF in your AWS account. The web ACL that you associate with your Amplify app must be created in the Global (CloudFront) Region. Regional web ACLs might already exist in your AWS account, but they are not compatible with Amplify. 5. Choose Add ﬁrewall. 6. On the Firewall page, the Associating status is displayed to indicate that the AWS WAF settings are being propagated. When the process is complete, the status changes to Enabled. The following screenshots show the ﬁrewall progress status in the Amplify console, indicating when the AWS WAF conﬁguration is Associating and Enabled. Enable AWS WAF using the console 240 AWS Amplify Hosting User Guide Disassociate a web ACL from an Amplify application You can't delete a web ACL that is associated with an Amplify app. You must ﬁrst disassociate the web ACL from the app in the Amplify console. Then you can delete it in the AWS WAF console. To disassociate a web ACL from an Amplify app 1. Sign in to the AWS Management Console and open the Amplify console at https:// console.aws.amazon.com/amplify/. 2. On the All apps page, choose the name of the app to disassociate a web ACL from. 3. In the navigation pane, choose Hosting, and then choose Firewall. 4. On the Firewall page, choose Actions, then choose Disassociate ﬁrewall. 5. In the conﬁrmation modal, enter disassociate, then choose Disassociate ﬁrewall. 6. On the Firewall page, the Disassociating status is displayed to indicate that the AWS WAF settings are being propagated. When the process is complete, you can delete the web ACL in the AWS WAF console. Remove AWS WAF from an app 241 AWS Amplify Hosting User Guide Enabling AWS WAF for an Amplify application using the AWS CDK You can use the AWS Cloud Development Kit (AWS CDK) to enable AWS WAF for an Amplify application. To learn more about using the CDK, see What is the CDK? in the AWS Cloud Development Kit (AWS CDK) Developer Guide. The following TypeScript code example demonstrates how to create an AWS CDK app with two CDK stacks: one for Amplify and one for AWS WAF. Notice that the AWS WAF stack must be deployed to the US East (N. Virginia) (us-east-1) Region. The Amplify application stack can be deployed to a diﬀerent Region. You must create the web ACL that you want to associate with the Amplify app in the Global (CloudFront) Region. Regional web ACLs might already exist in your AWS account, but they are not compatible with Amplify. import * as cdk from "aws-cdk-lib"; import { Construct } from "constructs"; import * as wafv2 from "aws-cdk-lib/aws-wafv2"; import * as amplify from "aws-cdk-lib/aws-amplify"; interface WafStackProps extends cdk.StackProps { appArn: string; } export class AmplifyStack extends cdk.Stack { public readonly appArn: string; constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); const amplifyApp = new amplify.CfnApp(this, "AmplifyApp", { name: "MyApp", }); this.appArn = amplifyApp.attrArn; } } export class WAFStack extends cdk.Stack { constructor(scope: Construct, id: string, props: WafStackProps) { super(scope, id, props); const webAcl = new wafv2.CfnWebACL(this, "WebACL", { defaultAction: { allow: {} }, scope: "CLOUDFRONT", rules: [ Enable AWS WAF using the CDK 242 AWS Amplify Hosting User Guide // Add your own rules here. ], visibilityConfig: { cloudWatchMetricsEnabled: true, metricName: "my-metric-name", sampledRequestsEnabled: true, }, }); new wafv2.CfnWebACLAssociation(this, "WebACLAssociation", { resourceArn: props.appArn, webAclArn: webAcl.attrArn, }); } } const app = new cdk.App();
amplify-console-ug-077	amplify-console-ug.pdf	77	id: string, props?: cdk.StackProps) { super(scope, id, props); const amplifyApp = new amplify.CfnApp(this, "AmplifyApp", { name: "MyApp", }); this.appArn = amplifyApp.attrArn; } } export class WAFStack extends cdk.Stack { constructor(scope: Construct, id: string, props: WafStackProps) { super(scope, id, props); const webAcl = new wafv2.CfnWebACL(this, "WebACL", { defaultAction: { allow: {} }, scope: "CLOUDFRONT", rules: [ Enable AWS WAF using the CDK 242 AWS Amplify Hosting User Guide // Add your own rules here. ], visibilityConfig: { cloudWatchMetricsEnabled: true, metricName: "my-metric-name", sampledRequestsEnabled: true, }, }); new wafv2.CfnWebACLAssociation(this, "WebACLAssociation", { resourceArn: props.appArn, webAclArn: webAcl.attrArn, }); } } const app = new cdk.App(); // Create AmplifyStack in your desired Region. const amplifyStack = new AmplifyStack(app, 'AmplifyStack', { env: { region: 'us-west-2' }, }); // Create WAFStack in IAD region, passing appArn from AmplifyStack. new WAFStack(app, 'WAFStack', { env: { region: 'us-east-1' }, crossRegionReferences: true, appArn: amplifyStack.appArn, // Pass appArn from AmplifyStack. }); How Amplify integrates with AWS WAF The following list provides speciﬁc details about how Firewall support is integrated with AWS WAF and the constraints to consider when creating web ACLs and associating them with Amplify apps. • You can enable AWS WAF for any type of Amplify app. This includes any supported framework, server-side rendered (SSR) apps, and fully static sites. AWS WAF is supported for Amplify Gen 1 and Gen 2 apps. How Amplify integrates with AWS WAF 243 AWS Amplify Hosting User Guide • You must create web ACLs that you want to associate with an Amplify app in the Global (CloudFront) Region. Regional web ACLs might already exist in your AWS account, but they are not compatible with Amplify. • The web ACL and the Amplify app must be created in the same AWS account. You can use AWS Firewall Manager to replicate AWS WAF rules across AWS accounts, to simplify keeping organization rules centralized and distributed across multiple AWS accounts. For more information, see AWS Firewall Manager in the AWS WAF Developer Guide. • You can share the same web ACL across multiple Amplify apps in the same AWS account. All of the apps must be in the same Region. • When you associate a web ACL with an Amplify app, the web ACL attaches to every branch in the app by default. When you create new branches, they will have the web ACL. • When you associate a web ACL to an Amplify app, it is automatically associated with all of the app’s domains. However, you can conﬁgure rules that apply to a single domain name using Host- header matching rules. • You can't delete a web ACL that is associated with an Amplify app. Before you delete a web ACL in the AWS WAF console, you need to disassociate it from the app. Amplify web ACL resource policy To allow Amplify to access your web ACL, a resource policy is attached to the web ACL during association. Amplify constructs this resource policy automatically, but you can view it using the AWS WAFV2 GetPermissionPolicy API. The following IAM permissions are required for associating a web ACL to an Amplify app. • amplify:AssociateWebACL • wafv2:AssociateWebACL • wafv2:PutPermissionPolicy • wafv2:GetPermissionPolicy Firewall pricing for Amplify applications The cost of implementing AWS WAF on an Amplify application is calculated based on the following two components: Amplify web ACL resource policy 244 AWS Amplify Hosting User Guide • AWS WAF usage – You will be charged for your AWS WAF usage acoording to the AWS WAF pricing model. AWS WAF charges are based on the web access control lists (web ACLs) that you create, the number of rules that you add per web ACL, and the number of web requests that you receive. For pricing details, see AWS WAF Pricing. • Amplify Hosting integration cost – There is a $15.00 per month, per app charge when you attach a web ACL to an Amplify application. This is prorated hourly. Firewall pricing 245 AWS Amplify Hosting User Guide Security in Amplify Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Amplify, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service
amplify-console-ug-078	amplify-console-ug.pdf	78	The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Amplify, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Amplify. The following topics show you how to conﬁgure Amplify to meet your security and compliance objectives. You also learn how to use other AWS services that help you monitor and secure your Amplify resources. Topics • Identity and Access Management for Amplify • Data Protection in Amplify • Compliance Validation for AWS Amplify • Infrastructure Security in AWS Amplify • Security event logging and monitoring in Amplify • Cross-service confused deputy prevention • Security best practices for Amplify Identity and Access Management for Amplify Identity and Access Management 246 AWS Amplify Hosting User Guide AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Amplify resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Amplify works with IAM • Identity-based policy examples for Amplify • AWS managed policies for AWS Amplify • Troubleshooting Amplify identity and access Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in Amplify. Service user – If you use the Amplify service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Amplify features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Amplify, see Troubleshooting Amplify identity and access. Service administrator – If you're in charge of Amplify resources at your company, you probably have full access to Amplify. It's your job to determine which Amplify features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Amplify, see How Amplify works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amplify. To view example Amplify identity-based policies that you can use in IAM, see Identity-based policy examples for Amplify. Audience 247 AWS Amplify Hosting User Guide Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more,
amplify-console-ug-079	amplify-console-ug.pdf	79	If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Authenticating with identities 248 AWS Amplify Hosting Federated identity User Guide As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has speciﬁc permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have speciﬁc use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that speciﬁes a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are diﬀerent from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a Authenticating with identities 249 AWS Amplify Hosting User Guide role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can
amplify-console-ug-080	amplify-console-ug.pdf	80	role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Authenticating with identities 250 AWS Amplify Hosting User Guide • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies.
amplify-console-ug-081	amplify-console-ug.pdf	81	a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can Managing access using policies 251 AWS Amplify Hosting User Guide perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user Managing access using policies 252 AWS Amplify Hosting User Guide or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS
amplify-console-ug-082	amplify-console-ug.pdf	82	service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amplify works with IAM Before you use IAM to manage access to Amplify, learn what IAM features are available to use with Amplify. How Amplify works with IAM 253 AWS Amplify Hosting User Guide IAM features that you can use with Amplify IAM feature Amplify support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs Yes No Yes Yes Yes No ABAC (tags in policies) Partial Temporary credentials Forward access sessions (FAS) Service roles Service-linked roles Yes Yes Yes No To get a high-level view of how Amplify and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for Amplify Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all How Amplify works with IAM 254 AWS Amplify Hosting User Guide of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for Amplify To view examples of Amplify identity-based policies, see Identity-based policy examples for Amplify. Resource-based policies within Amplify Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in diﬀerent AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Amplify Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a
amplify-console-ug-083	amplify-console-ug.pdf	83	must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for Amplify Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API How Amplify works with IAM 255 AWS Amplify Hosting User Guide operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. For a list of Amplify actions, see Actions deﬁned by AWS Amplify in the Service Authorization Reference. Policy actions in Amplify use the following preﬁx before the action: amplify To specify multiple actions in a single statement, separate them with commas. "Action": [ "amplify:action1", "amplify:action2" ] To view examples of Amplify identity-based policies, see Identity-based policy examples for Amplify. Policy resources for Amplify Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" How Amplify works with IAM 256 AWS Amplify Hosting User Guide For a list of Amplify resource types and their ARNs, see Resource types deﬁned by AWS Amplify in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions deﬁned by AWS Amplify. To view examples of Amplify identity-based policies, see Identity-based policy examples for Amplify. Policy condition keys for Amplify Supports service-speciﬁc policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. For a list of Amplify condition keys, see Condition keys for AWS Amplify in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions deﬁned by AWS Amplify. To view examples of Amplify identity-based policies, see Identity-based policy examples for Amplify. Access control lists (ACLs) in Amplify Supports ACLs: No How Amplify works with IAM 257 AWS Amplify Hosting User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Attribute-based access control (ABAC) with Amplify Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities
amplify-console-ug-084	amplify-console-ug.pdf	84	in Amplify Supports ACLs: No How Amplify works with IAM 257 AWS Amplify Hosting User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Attribute-based access control (ABAC) with Amplify Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the ﬁrst step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Deﬁne permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with Amplify Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your How Amplify works with IAM 258 AWS Amplify Hosting User Guide company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Forward access sessions for Amplify Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for Amplify Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break Amplify functionality. Edit service roles only when Amplify provides guidance to do so. Service-linked roles for Amplify Supports service-linked roles: No How Amplify works with IAM 259 AWS Amplify Hosting User Guide A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM in the IAM User Guide. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked roles documentation for that service. Identity-based policy examples for Amplify By default, users and roles don't have permission to create or modify Amplify resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the
amplify-console-ug-085	amplify-console-ug.pdf	85	permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM in the IAM User Guide. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked roles documentation for that service. Identity-based policy examples for Amplify By default, users and roles don't have permission to create or modify Amplify resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types deﬁned by Amplify, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for AWS Amplify in the Service Authorization Reference. Topics • Policy best practices • Using the Amplify console • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete Amplify resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We Identity-based policy examples 260 AWS Amplify Hosting User Guide recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Amplify console To access the AWS Amplify console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the Amplify resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. Identity-based policy examples 261 AWS Amplify Hosting User Guide With the release of Amplify Studio, deleting an app or a backend requires both amplify and amplifybackend permissions. If an IAM policy provides only amplify permissions, a user gets a permissions error when trying to delete an app. If you are an administrator writing policies, determine the correct permissions to give users who
amplify-console-ug-086	amplify-console-ug.pdf	86	need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. Identity-based policy examples 261 AWS Amplify Hosting User Guide With the release of Amplify Studio, deleting an app or a backend requires both amplify and amplifybackend permissions. If an IAM policy provides only amplify permissions, a user gets a permissions error when trying to delete an app. If you are an administrator writing policies, determine the correct permissions to give users who need to perform delete actions. To ensure that users and roles can still use the Amplify console, also attach the Amplify ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" Identity-based policy examples 262 AWS Amplify Hosting ], "Resource": "" } ] } User Guide AWS managed policies for AWS Amplify An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your speciﬁc use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by deﬁning customer managed policies that are speciﬁc to your use cases. You cannot change the permissions deﬁned in AWS managed policies. If AWS updates the permissions deﬁned in an AWS managed policy, the update aﬀects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AWS managed policy: AdministratorAccess-Amplify You can attach the AdministratorAccess-Amplify policy to your IAM identities. Amplify also attaches this policy to a service role that allows Amplify to perform actions on your behalf. When you deploy a backend in the Amplify console, you must create an Amplify-Backend Deployment service role that Amplify uses to create and manage AWS resources. IAM attaches the AdministratorAccess-Amplify managed policy to the Amplify-Backend Deployment service role. This policy grants account administrative permissions while explicitly allowing direct access to resources that Amplify applications require to create and manage backends. AWS managed policies 263 AWS Amplify Hosting Permissions details User Guide This policy provides access to multiple AWS services, including IAM actions. These actions allow identities with this policy to use AWS Identity and Access Management to create other identities with any permissions. This allows permissions escalation and this policy should be considered as powerful as the AdministratorAccess policy. This policy grants the iam:PassRole action permission for all resources. This is required to support Amazon Cognito user pools conﬁguration. To view the permissions for this policy, see AdministratorAccess-Amplify in the AWS Managed Policy Reference. AWS managed policy: AmplifyBackendDeployFullAccess You can attach the AmplifyBackendDeployFullAccess policy to your IAM identities. This policy grants Amplify full access permissions to deploy Amplify backend resources using the AWS Cloud Development Kit (AWS CDK). Permissions are deferred to the AWS CDK roles that have the necessary AdministratorAccess policy permissions. Permissions details This policy includes permissions to do the following . • Amplify– Retrieve metadata about deployed applications. • AWS CloudFormation– Create, update, and delete Amplify managed stacks. • SSM– Create, update, and delete Amplify managed SSM Parameter Store String and SecureString parameters. • AWS AppSync– Update and retrieve AWS AppSync schema, resolver and function resources. The purpose is to support the Gen 2 sandbox hotswapping functionality. • Lambda– Update and retrieve the conﬁguration for Amplify managed functions. The purpose is to support the Gen 2 sandbox hotswapping functionality. Retrieve a Lambda function's tags. The purpose is to support Lambda functions deﬁned by customers. • Amazon S3– Retrieve Amplify deployment assets. • AWS Security Token Service– Enables the AWS Cloud Development Kit (AWS CDK) CLI to assume the deployment role. AWS managed policies 264 AWS Amplify Hosting User Guide • Amazon RDS– Read metadata of DB instances, clusters, and proxies.
amplify-console-ug-087	amplify-console-ug.pdf	87	AppSync schema, resolver and function resources. The purpose is to support the Gen 2 sandbox hotswapping functionality. • Lambda– Update and retrieve the conﬁguration for Amplify managed functions. The purpose is to support the Gen 2 sandbox hotswapping functionality. Retrieve a Lambda function's tags. The purpose is to support Lambda functions deﬁned by customers. • Amazon S3– Retrieve Amplify deployment assets. • AWS Security Token Service– Enables the AWS Cloud Development Kit (AWS CDK) CLI to assume the deployment role. AWS managed policies 264 AWS Amplify Hosting User Guide • Amazon RDS– Read metadata of DB instances, clusters, and proxies. • Amazon EC2– Read the availability zone information for a subnet. • CloudWatch Logs– Retrieve the logs for a customer's Lambda function. The purpose is to allow an Amplify cloud development sandbox environment to stream a Lambda function's logs to a customer's terminal. To view the permissions for this policy, see AmplifyBackendDeployFullAccess in the AWS Managed Policy Reference. Amplify updates to AWS managed policies View details about updates to AWS managed policies for Amplify since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the Document history for AWS Amplify page. Change Description Date AmplifyBackendDepl oyFullAccess – Update to an existing policy AmplifyBackendDepl oyFullAccess – Update to an existing policy Add read access to the November 14, 2024 logs:FilterLogEvents resource to allow Amplify to stream logs from functions where a custom log group was created. This is an extension of the existing ability to stream a Lambda function's logs. Add read access to the July 18, 2024 lambda:ListTags and logs:FilterLogEven ts resources to support Lambda functions deﬁned by customers. These permissio ns allow an Amplify cloud development sandbox environment to stream a AWS managed policies 265 AWS Amplify Hosting User Guide Change Description Date AmplifyBackendDepl oyFullAccess – Update to an existing policy Lambda function's logs to a customer's terminal. Add read access to the May 31, 2024 arn:aws:ssm:::pa rameter/cdk-bootst rap/* resource to allow Amplify to detect the CDK bootstrap version in a customer's account. AWS managed policies 266 AWS Amplify Hosting User Guide Change Description Date AmplifyBackendDepl oyFullAccess – Update to an existing policy Add a new AmplifyDi April 17, 2024 scoverRDSVpcConfig policy statement with Amazon RDS and Amazon EC2 read-only permissions scoped by both resource and account conditions. These permissions support the Amplify Gen 2 npx amplify generate schema-from- database command that allows customers to generate Typescript data schema from an existing SQL database. Add the rds:Descr ibeDBProxies , rds:DescribeDBInst ances , rds:Descr ibeDBClusters , rds:DescribeDBSubn etGroups , and ec2:Descr ibeSubnets ns. The npx amplify permissio generate schema-fr om-database command requires these permissions to check whether a speciﬁed DB host is hosted in Amazon RDS and auto-generate the Amazon VPC conﬁguration required to provision the other resources required to AWS managed policies 267 AWS Amplify Hosting User Guide Change Description Date AmplifyBackendDepl oyFullAccess – Update to an existing policy set up an AWS AppSync API backed by a SQL database. Add the cloudform April 5, 2024 ation:DeleteStack policy action to support stack deletion when the DeleteBranch API is called. Add the lambda:Ge tFunction policy action to support hotswapping functions. Add the lambda:Up dateFunctionConfig uration policy action to support updates to the Lambda function. AdministratorAccess-Amplify – Update to an existing policy Add the cloudform April 4, 2024 ation:TagResource and cloudformation:UnT agResource ns to support calls to AWS permissio CloudFormation APIs. AWS managed policies 268 AWS Amplify Hosting User Guide Change Description Date AmplifyBackendDepl oyFullAccess – Update to an existing policy Add the lambda:In January 02, 2024 policy vokeFunction action to support AWS Cloud Development Kit (AWS CDK) hotswapping. The AWS CDK makes direct calls to a Lambda function to perform Amazon S3 asset hotswappi ng. Add the lambda:Up dateFunctionCode policy action to support hotswapping functions. AmplifyBackendDepl oyFullAccess – Update to an existing policy Add policy actions to support November 17, 2023 the UpdateApiKey operation. This is required to enable a successful app deployment after exiting and restarting the sandbox without deleting resources. AmplifyBackendDepl oyFullAccess – Update to an existing policy AmplifyBackendDepl oyFullAccess – New policy Add the amplify:G November 6, 2023 etBackendEnvironme nt permission to support Amplify app deployment. Amplify added a new policy with the minimum permissio ns required to deploy Amplify backend resources. October 8, 2023 AWS managed policies 269 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add the ecr:Descr June 1, 2023 ibeRepositories permission that is required by the Amplify Command Line Interface (CLI). AWS managed policies 270 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add a policy action to support removing tags from an AWS February 24, 2023 AppSync resource. Add a policy action to support the Amazon Polly
amplify-console-ug-088	amplify-console-ug.pdf	88	Amplify added a new policy with the minimum permissio ns required to deploy Amplify backend resources. October 8, 2023 AWS managed policies 269 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add the ecr:Descr June 1, 2023 ibeRepositories permission that is required by the Amplify Command Line Interface (CLI). AWS managed policies 270 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add a policy action to support removing tags from an AWS February 24, 2023 AppSync resource. Add a policy action to support the Amazon Polly resource. Add a policy action to support updating the OpenSearch domain conﬁguration. Add a policy action to support removing tags from an AWS Identity and Access Management role. Add a policy action to support removing tags from an Amazon DynamoDB resource. Add the cloudfron t:GetCloudFrontOri ginAccessIdentity and cloudfront:GetClou dFrontOriginAccess IdentityConfig permissions to the CLISDKCalls statement block to support the Amplify publish and hosting workﬂows. Add the s3:PutBuc ketPublicAccessBlo ck permission to the CLIManageviaCFNPol AWS managed policies 271 AWS Amplify Hosting User Guide Change Description Date icy statement block to allow the AWS CLI to support the Amazon S3 security best practice of enabling the Amazon S3 Block Public Access feature on internal buckets. Add the cloudform ation:DescribeStac ks permission to the CLISDKCalls statement block to support retrieving customers’ AWS CloudForm ation stacks on retries in the Amplify backend processor to avoid duplicating executions if a stack is updating. Add the cloudform ation:ListStacks permission to the CLICloudf ormationPolicy statement block. This permission is required to fully support the CloudFormation DescribeStacks action. Add policy actions to allow the Amplify server-side rendering feature to push application metrics to CloudWatch in a customer's AWS account. August 30, 2022 AdministratorAccess-Amplify – Update to an existing policy AWS managed policies 272 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add policy actions to block public access to the Amplify April 27, 2022 deployment Amazon S3 bucket. AdministratorAccess-Amplify – Update to an existing policy Add an action to allow customers to delete their April 17, 2022 server-side rendered (SSR) apps. This also allows the corresponding CloudFront distribution to be deleted successfully. Add an action to allow customers to specify a diﬀerent Lambda function to handle events from an existing event source using the Amplify CLI. With these changes, AWS Lambda will be able to perform the UpdateEventSourceMapping action. AdministratorAccess-Amplify – Update to an existing policy Add a policy action to enable Amplify UI Builder actions on all resources. December 2, 2021 AWS managed policies 273 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add policy actions to support the Amazon Cognito November 8, 2021 authentication feature that uses social identity providers. Add a policy action to support Lambda layers. Add a policy action to support the Amplify Storage category. AWS managed policies 274 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Add Amazon Lex actions to support the Amplify Interacti September 27, 2021 ons category. Add Amazon Rekogniti on actions to support the Amplify Predictions category. Add an Amazon Cognito action to support MFA conﬁguration on Amazon Cognito user pools. Add CloudFormation actions to support AWS CloudForm ation StackSets. Add Amazon Location Service actions to support the Amplify Geo category. Add a Lambda action to support Lambda layers in Amplify. Add CloudWatch Logs actions to support CloudWatch Events. Add Amazon S3 actions to support the Amplify Storage category. Add policy actions to support server-side rendered (SSR) apps. AWS managed policies 275 AWS Amplify Hosting User Guide Change Description Date AdministratorAccess-Amplify – Update to an existing policy Consolidate all Amplify actions into a single July 28, 2021 amplify:* action. Add an Amazon S3 action to support encrypting customer Amazon S3 buckets. Add IAM permission boundary actions to support Amplify apps that have permission boundaries enabled. Add Amazon SNS actions to support viewing originati on phone numbers, and viewing, creating, verifying , and deleting destination phone numbers. Amplify Studio: Add Amazon Cognito, AWS Lambda, IAM, and AWS CloudFormation policy actions to enable managing backends in the Amplify console and Amplify Studio. Add an AWS Systems Manager (SSM) policy statement to manage Amplify environment secrets. Add an AWS CloudFormation ListResources action to AWS managed policies 276 AWS Amplify Hosting User Guide Change Description Date support Lambda layers for Amplify apps. Amplify started tracking changes Amplify started tracking changes for its AWS managed July 28, 2021 policies. Troubleshooting Amplify identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with Amplify and IAM. Topics • I am not authorized to perform an action in Amplify • I am not
amplify-console-ug-089	amplify-console-ug.pdf	89	and Amplify Studio. Add an AWS Systems Manager (SSM) policy statement to manage Amplify environment secrets. Add an AWS CloudFormation ListResources action to AWS managed policies 276 AWS Amplify Hosting User Guide Change Description Date support Lambda layers for Amplify apps. Amplify started tracking changes Amplify started tracking changes for its AWS managed July 28, 2021 policies. Troubleshooting Amplify identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with Amplify and IAM. Topics • I am not authorized to perform an action in Amplify • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my Amplify resources I am not authorized to perform an action in Amplify If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a ﬁctional my-example-widget resource but doesn't have the ﬁctional amplify:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: amplify:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the amplify:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting 277 AWS Amplify Hosting User Guide With the release of Amplify Studio, deleting an app or a backend requires both amplify and amplifybackend permissions. If an administrator has written an IAM policy that provides only amplify permissions, you will get a permissions error when trying to delete an app. The following example error occurs when the mateojackson IAM user tries to use the console to delete a ﬁctional example-amplify-app resource but does not have the amplifybackend:RemoveAllBackends permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: amplifybackend;:RemoveAllBackends on resource: example-amplify-app In this case, Mateo asks his administrator to update his policies to allow him to access the example-amplify-app resource using the amplifybackend:RemoveAllBackends action. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Amplify. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Amplify. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my Amplify resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support Troubleshooting 278 AWS Amplify Hosting User Guide resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether Amplify supports these features, see How Amplify works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Data Protection in Amplify AWS Amplify conforms to the AWS shared responsibility model, which includes regulations and guidelines for data protection. AWS is responsible for protecting the global infrastructure that runs all the AWS services. AWS maintains control over data hosted on this infrastructure, including the security conﬁguration controls for handling customer content and personal data. AWS customers and APN partners, acting either as data controllers or data processors, are
amplify-console-ug-090	amplify-console-ug.pdf	90	the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Data Protection in Amplify AWS Amplify conforms to the AWS shared responsibility model, which includes regulations and guidelines for data protection. AWS is responsible for protecting the global infrastructure that runs all the AWS services. AWS maintains control over data hosted on this infrastructure, including the security conﬁguration controls for handling customer content and personal data. AWS customers and APN partners, acting either as data controllers or data processors, are responsible for any personal data that they put in the AWS Cloud. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. • Set up API and user activity logging with AWS CloudTrail. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon S3. Data Protection 279 AWS Amplify Hosting User Guide We strongly recommend that you never put sensitive identifying information, such as your customers' account numbers, into free-form ﬁelds such as a Name ﬁeld. This includes when you work with Amplify or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into Amplify or other services might get picked up for inclusion in diagnostic logs. When you provide a URL to an external server, don't include credentials information in the URL to validate your request to that server. For more information about data protection, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. Encryption at rest Encryption at rest refers to protecting your data from unauthorized access by encrypting data while stored. Amplify encrypts an app's build artifacts by default using AWS KMS keys for Amazon S3 that are managed by the AWS Key Management Service. Amplify uses Amazon CloudFront to serve your app to your customers. CloudFront uses SSDs which are encrypted for edge location points of presence (POPs), and encrypted EBS volumes for Regional Edge Caches (RECs). Function code and conﬁguration in CloudFront Functions is always stored in an encrypted format on the encrypted SSDs on the edge location POPs, and in other storage locations used by CloudFront. Encryption in transit Encryption in transit refers to protecting your data from being intercepted while it moves between communication endpoints. Amplify Hosting provides encryption for data in-transit by default. All communication between customers and Amplify and between Amplify and its downstream dependencies is protected using TLS connections that are signed using the Signature Version 4 signing process. All Amplify Hosting endpoints use SHA-256 certiﬁcates that are managed by AWS Certiﬁcate Manager Private Certiﬁcate Authority. For more information, see Signature Version 4 signing process and What is ACM PCA. Encryption key management AWS Key Management Service (KMS) is a managed service for creating and controlling AWS KMS keys, the encryption keys used to encrypt customer data. AWS Amplify generates and manages cryptographic keys for encrypting data on behalf of customers. There are no encryption keys for you to manage. Encryption at rest 280 AWS Amplify Hosting User Guide Compliance Validation for AWS Amplify Third-party auditors assess the security and compliance of AWS Amplify as part of multiple AWS compliance programs. These include SOC, PCI, ISO, HIPAA, MTCS, C5, K-ISMS, ENS High, OSPAR, HITRUST CSF, and FINMA. To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the
amplify-console-ug-091	amplify-console-ug.pdf	91	when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious Compliance Validation 281 AWS Amplify Hosting User Guide activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Infrastructure Security in AWS Amplify As a managed service, AWS Amplify is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access Amplify through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Security event logging and monitoring in Amplify Monitoring is an important part of maintaining the reliability, availability, and performance of Amplify and your other AWS solutions. AWS provides the following monitoring tools to watch Amplify, report when something is wrong, and take automatic actions when appropriate: • Amazon CloudWatch monitors in real time your AWS resources and the applications that you run on AWS. You can collect and track metrics, create customized dashboards, and set alarms that notify you or take actions when a certain metric reaches a threshold that you specify. For example, you can have CloudWatch track CPU usage or other metrics of your Amazon Elastic Compute Cloud (Amazon EC2) instances and automatically launch new instances when needed. For more information about using CloudWatch metrics and alarms with Amplify, see Monitoring an Amplify application. Infrastructure Security 282 AWS Amplify Hosting User Guide • Amazon CloudWatch Logs enables you to monitor, store, and access your log ﬁles from Amazon EC2 instances, AWS CloudTrail, and other sources. CloudWatch Logs can monitor information in the log ﬁles and notify you when certain thresholds are met. You can also archive your log data in highly durable storage. For more information, see the Amazon CloudWatch Logs User Guide. • AWS CloudTrail captures API calls and related events made by or on behalf of your AWS account and delivers the log ﬁles to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see Logging Amplify API calls using AWS CloudTrail. • Amazon EventBridge is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources. EventBridge delivers a stream of real-time data from your own applications, Software-as-a-Service (SaaS) applications, and AWS services, and routes that data to targets such as AWS Lambda. This enables you to monitor events
amplify-console-ug-092	amplify-console-ug.pdf	92	Storage Service (Amazon S3) bucket that you specify. You can identify which users and accounts called AWS, the source IP address from which the calls were made, and when the calls occurred. For more information, see Logging Amplify API calls using AWS CloudTrail. • Amazon EventBridge is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources. EventBridge delivers a stream of real-time data from your own applications, Software-as-a-Service (SaaS) applications, and AWS services, and routes that data to targets such as AWS Lambda. This enables you to monitor events that happen in services and build event-driven architectures. For more information, see the Amazon EventBridge User Guide. Cross-service confused deputy prevention The confused deputy problem is a security issue where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action. In AWS, cross-service impersonation can result in the confused deputy problem. Cross-service impersonation can occur when one service (the calling service) calls another service (the called service). The calling service can be manipulated to use its permissions to act on another customer's resources in a way it should not otherwise have permission to access. To prevent this, AWS provides tools that help you protect your data for all services with service principals that have been given access to resources in your account. We recommend using the aws:SourceArn and aws:SourceAccount global condition context keys in resource policies to limit the permissions that AWS Amplify gives another service to the resource. If you use both global condition context keys, the aws:SourceAccount value and the account in the aws:SourceArn value must use the same account ID when used in the same policy statement. The value of aws:SourceArn must be the branch ARN of the Amplify app. Specify this value in the format arn:Partition:amplify:Region:Account:apps/AppId/ branches/BranchName. Cross-service confused deputy prevention 283 AWS Amplify Hosting User Guide The most eﬀective way to protect against the confused deputy problem is to use the aws:SourceArn global condition context key with the full ARN of the resource. If you don't know the full ARN of the resource or if you are specifying multiple resources, use the aws:SourceArn global context condition key with wildcards () for the unknown portions of the ARN. For example, arn:aws:servicename::123456789012:. The following example shows a role trust policy you can apply to limit access to any Amplify app in your account and prevent the confused deputy problem. To use this policy, replace the red italicized text in the example policy with your own information. { "Version": "2012-10-17", "Statement": { "Sid": "ConfusedDeputyPreventionExamplePolicy", "Effect": "Allow", "Principal": { "Service": [ "amplify.me-south-1.amazonaws.com", "amplify.eu-south-1.amazonaws.com", "amplify.ap-east-1.amazonaws.com", "amplifybackend.amazonaws.com", "amplify.amazonaws.com" ] }, "Action": "sts:AssumeRole", "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:amplify:us-east-1:123456789012:apps/" }, "StringEquals": { "aws:SourceAccount": "123456789012" } } } } The following example shows a role trust policy you can apply to limit access to a speciﬁed Amplify app in your account and prevent the confused deputy problem. To use this policy, replace the red italicized text in the example policy with your own information. { "Version": "2012-10-17", Cross-service confused deputy prevention 284 User Guide AWS Amplify Hosting "Statement": { "Sid": "ConfusedDeputyPreventionExamplePolicy", "Effect": "Allow", "Principal": { "Service": [ "amplify.me-south-1.amazonaws.com", "amplify.eu-south-1.amazonaws.com", "amplify.ap-east-1.amazonaws.com", "amplifybackend.amazonaws.com", "amplify.amazonaws.com" ] }, "Action": "sts:AssumeRole", "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:amplify:us-east-1:123456789012:apps/d123456789/ branches/" }, "StringEquals": { "aws:SourceAccount": "123456789012" } } } } Security best practices for Amplify Amplify provides a number of security features to consider as you develop and implement your own security policies. The following best practices are general guidelines and don't represent a complete security solution. Because these best practices might not be appropriate or suﬃcient for your environment, treat them as helpful recommendations rather than prescriptions. Using cookies with the Amplify default domain When you use Amplify to deploy a web app, Amplify hosts it for you on the default amplifyapp.com domain. You can view your app on a URL formatted as https://branch- name.d1m7bkiki6tdw1.amplifyapp.com. To augment the security of your Amplify applications, the amplifyapp.com domain is registered in the Public Suﬃx List (PSL). For further security, we recommend that you use cookies with a __Host- preﬁx if you ever need to set sensitive cookies in the default domain name for your Security best practices 285 AWS Amplify Hosting User Guide Amplify applications. This practice will help to defend your domain against cross-site request forgery attempts (CSRF). For more information see the Set-Cookie page in the Mozilla Developer Network. Using cookies with the Amplify default domain 286 AWS Amplify Hosting User Guide Amplify Hosting service quotas The following are the service quotas for AWS Amplify Hosting. Service quotas (previously referred to as limits) are the maximum number of service resources or operations for your AWS account. New AWS accounts have reduced apps and concurrent jobs quotas. AWS raises these quotas automatically
amplify-console-ug-093	amplify-console-ug.pdf	93	your Security best practices 285 AWS Amplify Hosting User Guide Amplify applications. This practice will help to defend your domain against cross-site request forgery attempts (CSRF). For more information see the Set-Cookie page in the Mozilla Developer Network. Using cookies with the Amplify default domain 286 AWS Amplify Hosting User Guide Amplify Hosting service quotas The following are the service quotas for AWS Amplify Hosting. Service quotas (previously referred to as limits) are the maximum number of service resources or operations for your AWS account. New AWS accounts have reduced apps and concurrent jobs quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. The Service Quotas console provides information about the quotas for your account. You can use the Service Quotas console to view default quotas and request quota increases for adjustable quotas. For more information, see Requesting a quota increase in the Service Quotas User Guide. Name Apps Default Description Adjustabl e Each supported Region: 25 Yes The maximum number of apps that you can create in AWS Amplify Console in this account in the current Region. Branches per app Each supported Region: 50 No The maximum number of branches per app that Build artifact size Each supported Region: 5 Gigabytes No you can create in this account in the current Region. The maximum size (in GB) of an app build artifact. A build artifact is deployed by AWS Amplify Console after a build. Cache artifact size Each supported Region: 5 Gigabytes No The maximum size (in GB) of a cache artifact. 287 AWS Amplify Hosting Name Concurrent jobs User Guide Default Description Adjustabl e Each supported Region: 5 Yes The maximum number of concurrent jobs that you can create in this account in the current Region. Domains per app Each supported Region: 5 Yes The maximum number of domains per app that Environment cache artifact size Manual deploy ZIP ﬁle size Maximum app creations per hour Each supported Region: 5 Gigabytes Each supported Region: 5 Gigabytes Each supported Region: 25 No No No Request tokens per second Each supported Region: 20,000 Yes you can create in this account in the current Region. The maximum size (in GB) of the environment cache artifact. The maximum size (in GB) of a manual deploy ZIP ﬁle. The maximum number of apps that you can create in AWS Amplify Console per hour in this account in the current Region. The maximum number of request tokens per second for an app. Amplify Hosting allocates tokens to requests based on the amount of resources (processing time and data transfer) that they consume. 288 AWS Amplify Hosting Name Default Description Adjustabl e User Guide Subdomains per domain Each supported Region: 50 No The maximum number of subdomains per domain that you can create in this account in the current Region. Webhooks per app Each supported Region: 50 Yes The maximum number of webhooks per app that you can create in this account in the current Region. For more information about Amplify service quotas, see AWS Amplify endpoints and quotas in the AWS General Reference. 289 AWS Amplify Hosting User Guide Troubleshooting Amplify Hosting If you encounter errors or deployment issues when working with Amplify Hosting, consult the topics in this section. Topics • Troubleshooting general Amplify issues • Troubleshooting Amazon Linux 2023 build image issues • Troubleshooting build issues • Troubleshooting custom domains • Troubleshooting server-side rendered applications • Troubleshooting redirects and rewrites • Troubleshooting caching Troubleshooting general Amplify issues The following information can help you troubleshoot general issues with Amplify Hosting. Topics • HTTP 429 status code (Too many requests) • The Amplify console doesn't display the build status and last update time for my app • Web previews are not being created for new pull requests • My manual deployment is stuck with a pending status in the Amplify console • I need to update my application's Node.js version HTTP 429 status code (Too many requests) Amplify controls the number of requests per second (RPS) to your website based on the processing time and data transfer that incoming requests consume. If your application returns an HTTP 429 status code, incoming requests are exceeding the amount of processing time and data transfer allotted to your application. This application limit is managed by Amplify's REQUEST_TOKENS_PER_SECOND service quota. For more information about quotas, see Amplify Hosting service quotas. General issues 290 AWS Amplify Hosting User Guide To ﬁx this issue, we recommend optimizing your application to reduce request duration and data transfer to increase the app's RPS. For example, with the same 20,000 tokens, a highly optimized SSR page that responds within 100 milliseconds can support higher RPS as compared to a page with latency higher than 200 milliseconds. Similarly, an application that returns a 1 MB response
amplify-console-ug-094	amplify-console-ug.pdf	94	of processing time and data transfer allotted to your application. This application limit is managed by Amplify's REQUEST_TOKENS_PER_SECOND service quota. For more information about quotas, see Amplify Hosting service quotas. General issues 290 AWS Amplify Hosting User Guide To ﬁx this issue, we recommend optimizing your application to reduce request duration and data transfer to increase the app's RPS. For example, with the same 20,000 tokens, a highly optimized SSR page that responds within 100 milliseconds can support higher RPS as compared to a page with latency higher than 200 milliseconds. Similarly, an application that returns a 1 MB response size will consume more tokens than an application that returns a 250 KB response size. We also recommend that you leverage the Amazon CloudFront cache by conﬁguring Cache-Control headers that maximize the time that a given response is kept in the cache. Requests that are served from the CloudFront cache don't count towards the rate limit. Each CloudFront distribution can handle up to 250,000 requests per second, enabling you to scale your app very high using the cache. For more information about the CloudFront cache, see Optimizing caching and availability in the Amazon CloudFront Developer Guide. The Amplify console doesn't display the build status and last update time for my app When you navigate to the All apps page in the Amplify console, a tile is displayed for each of your apps in the current Region. If you don't see the build status, such as Deployed, and the Last update time displayed for an app, the app doesn't have a Production stage branch associated with it. To list the apps in the console, Amplify uses the ListApps API. Amplify uses the ProductionBranch.status attribute to display the build status and the ProductionBranch.lastDeployTime attribute to display the last update time. For more information about this API, see ProductionBranch in the Amplify Hosting API documentation. Use the following instructions to associate a Production stage to your app's branch. 1. Sign in to the Amplify console. 2. On the All apps page, choose the app that you want to update. 3. 4. 5. In the navigation pane choose App settings, then Branch settings. In the Branch settings section, choose Edit. For Production branch, choose the branch name that you want to use. 6. Choose Save. 7. Return to the All apps page. The build status and last update time should now be displayed for your app. The Amplify console doesn't display the build status and last update time for my app 291 AWS Amplify Hosting User Guide Web previews are not being created for new pull requests The web previews feature enables you to preview changes from pull requests before merging them into an integration branch. A web preview deploys every pull request made to your repository to a unique preview URL which is diﬀerent from the URL that your main site uses. If you have turned on web previews for your app, but they aren't being created for new PRs, investigate whether one of the following is the cause of your issue. 1. Check to see whether your app has reached the maximum Branches per app service quota. For more information about quotas, see Amplify Hosting service quotas. To stay within the default quota of 50 branches per app, consider enabling auto branch deletion in your app. This will prevent you from accumulating branches in your account that no longer exist in your repository. 2. If you are using a public GitHub repository and your Amplify app has an IAM service role attached to it, Amplify doesn't create previews for security reasons. For example, apps with backends and apps that are deployed to the WEB_COMPUTE hosting platform require an IAM service role. Therefore, you can't enable web previews for these types of apps if their repository is public. To enable web previews to work for your app, you can either disassociate the service role (if the app doesn't have a backend or isn't a WEB_COMPUTE app), or you can make the GitHub repository private. My manual deployment is stuck with a pending status in the Amplify console Manual deployments enable you to publish your web app with Amplify Hosting without connecting a Git provider. You can use one of the following four deployment options. 1. Drag and drop your application folder in the Amplify console. 2. Drag and drop a .zip ﬁle (that contains the build artifacts of your site) in the Amplify console. 3. Upload a .zip ﬁle (that contains the build artifacts of your site) to an Amazon S3 bucket and connect the bucket to an app in the Amplify console. 4. Use a public URL that points to a .zip ﬁle (that contains the build artifacts of your site) in the Amplify console. Web previews are not being created for
amplify-console-ug-095	amplify-console-ug.pdf	95	provider. You can use one of the following four deployment options. 1. Drag and drop your application folder in the Amplify console. 2. Drag and drop a .zip ﬁle (that contains the build artifacts of your site) in the Amplify console. 3. Upload a .zip ﬁle (that contains the build artifacts of your site) to an Amazon S3 bucket and connect the bucket to an app in the Amplify console. 4. Use a public URL that points to a .zip ﬁle (that contains the build artifacts of your site) in the Amplify console. Web previews are not being created for new pull requests 292 AWS Amplify Hosting User Guide We are aware of issues with the drag a drop functionality when using an application folder for a manual deployment in the Amplify console. These deployments can fail for the following reasons. • Transient network issues occur. • There is a local change to the ﬁles during upload. • The browser session attempts to upload a large amount of static assets simultaneously. While we work on improving the reliability of our drag and drop uploads, we recommend that you use a .zip ﬁle instead of dragging and dropping the application folders. We highly recommend uploading a .zip ﬁle to an Amazon S3 bucket, as this avoids ﬁle uploads from the Amplify console and provides a higher reliability for manual deployments. Amplify's integration with Amazon S3 simpliﬁes this process. For more information, see Deploying a static website to Amplify from an Amazon S3 bucket. I need to update my application's Node.js version Amplify support for apps using Node.js versions 16 and 18 ends on September 15, 2025. Applications that are already deployed will continue running. However, after this date, you won't be able to deploy updates to your application until you upgrade to Node.js version 20 or later. If you are using the Amazon Linux 2023 build image, Node.js version 20 is supported by default. Starting on September 15, 2025, the AL2023 image will automatically support Node.js 22 and change its default Node.js version from 18 to 22. Amazon Linux 2 (AL2) doesn't automatically support Node.js version 20 or later. If you are currently using AL2, we recommend that you switch to AL2023. You can change the build image in the Amplify console. You can also use a custom build image that supports the Node.js version that you specify. Prior to upgrading, we recommend that you test your application on a new branch to verify that it functions correctly. Upgrade options Amplify console You can use the live package updates feature in the Amplify console to specify the version of Node.js to use. For instructions, see Using speciﬁc package and dependency versions in the build image. I need to update my application's Node.js version 293 AWS Amplify Hosting Custom build image User Guide If you are using a custom build image and NVM is installed on your image, you can add nvm install 20 to your Dockerﬁle. To learn more about the requirements and conﬁguration instructions for a custom build image, see Customizing the build image. Build settings You can specify the Node.js version to use in your application's amplify.yml build settings, by adding the nvm use command to the preBuild commands section. For instructions on updating an application's build settings, see Conﬁguring the build settings for an app. The following example demonstrates how to customize the build settings to set the default Node.js version to Node.js 18 and upgrade to Node.js version 20 on a test branch named node-20. frontend: phases: preBuild: commands: - nvm use 18 - if [ "${AWS_BRANCH}" = "node-20" ]; then nvm use 20; fi Warning Be aware that preBuild commands run after live package updates. The Node.js version speciﬁed by the nvm use command will override the Node.js version set by live package updates. Troubleshooting Amazon Linux 2023 build image issues The following information can help you troubleshoot issues with the Amazon Linux 2023 (AL2023) build image. Topics • I want to run Amplify functions with the Python runtime • I want to run commands that require superuser or root privileges AL2023 build image 294 AWS Amplify Hosting User Guide I want to run Amplify functions with the Python runtime Amplify Hosting now uses the Amazon Linux 2023 build image by default when you deploy a new application. AL2023 comes pre-installed with Python versions 3.8, 3.9, 3.10, and 3.11. For backwards compatibility with the Amazon Linux 2 image, the AL2023 build image has symlinks for older versions of Python pre-installed. By default, Python version 3.10 is used globally. To build your functions using a speciﬁc Python version, run the following commands in your application's build speciﬁcation ﬁle. version: 1 backend: phases: build: commands: # use a python version globally - pyenv global 3.11 # verify python
amplify-console-ug-096	amplify-console-ug.pdf	96	with the Python runtime Amplify Hosting now uses the Amazon Linux 2023 build image by default when you deploy a new application. AL2023 comes pre-installed with Python versions 3.8, 3.9, 3.10, and 3.11. For backwards compatibility with the Amazon Linux 2 image, the AL2023 build image has symlinks for older versions of Python pre-installed. By default, Python version 3.10 is used globally. To build your functions using a speciﬁc Python version, run the following commands in your application's build speciﬁcation ﬁle. version: 1 backend: phases: build: commands: # use a python version globally - pyenv global 3.11 # verify python version - python --version # install pipenv - pip install --user pipenv # add to path - export PATH=$PATH:/root/.local/bin # verify pipenv version - pipenv --version - amplifyPush --simple I want to run commands that require superuser or root privileges If you are using the Amazon Linux 2023 build image and get an error when running system commands that require superuser or root privileges, you must run these commands using the Linux sudo command. For example, if you get an error running yum install -y gcc, use sudo yum install -y gcc. The Amazon Linux 2 build image used the root user, but Amplify's AL2023 image runs your code with a custom amplify user. Amplify grants this user privileges to run commands using the Linux sudo command. It is a best practice to use sudo for commands that require superuser privileges. I want to run Amplify functions with the Python runtime 295 AWS Amplify Hosting User Guide Troubleshooting build issues If you encounter issues when creating or building an Amplify application, consult the topics in this section for help. Topics • New commits to my repository aren't triggering Amplify builds • My repository name isn't listed in the Amplify console when creating a new application • My build fails with the Cannot ﬁnd module aws-exports error (Gen 1 apps only) • I want to override a build timeout New commits to my repository aren't triggering Amplify builds If new commits to your Git repository aren't triggering Amplify builds, verify that your webhook is still present on your repository. If it's present, check the history of webhook requests to see if there are any failures. Amplify has a payload size limit of 256 KB for incoming webhooks. If you push a commit to your repository that has a large number of changed ﬁles, you might exceed this limit and cause builds to not be triggered. My repository name isn't listed in the Amplify console when creating a new application When you create a new application in the Amplify console, you can choose from your organization's available repositories on the Add repository and branch page. Your target repository might not be displayed in the list if it hasn't been recently updated. This might occur if your organization has a large number of repositories. To resolve this issue, push a commit to the repository, then refresh the repository list in the console. This should cause the repository to be displayed. My build fails with the Cannot find module aws-exports error (Gen 1 apps only) If your app can't ﬁnd the aws-exports.js ﬁle during a build, the following error is returned. TS2307: Cannot find module 'aws-exports' Build issues 296 AWS Amplify Hosting User Guide The Amplify command line interface (CLI) generates the aws-exports.js ﬁle during your backend build. To resolve this error, you must create an aws-exports.js ﬁle for use in the build. Add the following code to your build speciﬁcation to create the ﬁle: backend: phases: build: commands: - "# Execute Amplify CLI with the helper script" - amplifyPush --simple For a full example of the build speciﬁcation settings for an Amplify app, see Build speciﬁcation YAML syntax reference. I want to override a build timeout The default build timeout is 30 minutes. You can override the default build timeout using the _BUILD_TIMEOUT environment variable. The minimum build timeout is 5 minutes. The maximum build timeout is 120 minutes. For instructions on setting an environment variable for an app in the Amplify console, see Setting environment variables. Troubleshooting custom domains If you encounter issues when connecting a custom domain to your Amplify application, consult the topics in this section for help. If you don't see a solution to your issue here, contact Support. For more information, see Creating a support case in the AWS Support User Guide. Topics • I need to verify that my CNAME resolves • My domain hosted with a third-party is stuck in the Pending Veriﬁcation state • My domain hosted with Amazon Route 53 is stuck in the Pending Veriﬁcation state • My app with multi-level subdomains is stuck in the Pending Veriﬁcation state • My DNS provider doesn't support A records with fully qualiﬁed domain names I
amplify-console-ug-097	amplify-console-ug.pdf	97	consult the topics in this section for help. If you don't see a solution to your issue here, contact Support. For more information, see Creating a support case in the AWS Support User Guide. Topics • I need to verify that my CNAME resolves • My domain hosted with a third-party is stuck in the Pending Veriﬁcation state • My domain hosted with Amazon Route 53 is stuck in the Pending Veriﬁcation state • My app with multi-level subdomains is stuck in the Pending Veriﬁcation state • My DNS provider doesn't support A records with fully qualiﬁed domain names I want to override a build timeout 297 AWS Amplify Hosting User Guide • I get a CNAMEAlreadyExistsException error • I get an Additional Veriﬁcation Required error • I get a 404 error on the CloudFront URL • I get SSL certiﬁcate or HTTPS errors when visiting my domain I need to verify that my CNAME resolves 1. After you update your DNS records with your third-party domain provider, you can use a tool such as dig or a free website such as https://www.whatsmydns.net/ to verify that your CNAME record is resolving correctly. The following screenshot demonstrates how to use whatsmydns.net to check your CNAME record for the domain www.example.com. 2. Choose Search, and whatsmydns.net displays the results for your CNAME. The following screenshot is an example of a list of results that verify that the CNAME resolves correctly to a cloudfront.net URL. My domain hosted with a third-party is stuck in the Pending Veriﬁcation state 1. If your custom domain is stuck in the Pending Veriﬁcation state, verify that your CNAME records are resolving. See the previous troubleshooting topic, How do I verify that my CNAME resolves, for instructions on performing this task. 2. If your CNAME records are not resolving, conﬁrm that the CNAME entry exists in your DNS settings with your domain provider. I need to verify that my CNAME resolves 298 AWS Amplify Hosting User Guide Important It is important to update your CNAME records as soon as you create your custom domain. After your app is created in the Amplify console, your CNAME record is checked every few minutes to determine if it resolves. If it doesn’t resolve after an hour, the check is made every few hours, which can lead to a delay in your domain being ready to use. If you added or updated your CNAME records a few hours after you created your app, this is the most likely cause for your app to get stuck in the Pending Veriﬁcation state. 3. If you have veriﬁed that the CNAME record exists, then there may be an issue with your DNS provider. You can either contact the DNS provider to diagnose why the DNS veriﬁcation CNAME is not resolving or you can migrate your DNS to Route 53. For more information, see Making Amazon Route 53 the DNS service for an existing domain. My domain hosted with Amazon Route 53 is stuck in the Pending Veriﬁcation state If you transferred your domain to Amazon Route 53, it is possible that your domain has diﬀerent name servers than those issued by Amplify when your app was created. Perform the following steps to diagnose the cause of the error. 1. 2. Sign in to the Amazon Route 53 console In the navigation pane, choose Hosted Zones and then choose the name of the domain you are connecting. 3. Record the name server values from the Hosted Zone Details section. You need these values to complete the next step. The following screenshot of the Route 53 console displays the location of the name server values in the lower-right corner. My domain hosted with Amazon Route 53 is stuck in the Pending Veriﬁcation state 299 AWS Amplify Hosting User Guide 4. In the navigation pane, choose Registered domains. Verify that the name servers displayed on the Registered domains section match the name server values that you recorded in the previous step from the Hosted Zone Details section. If they do not match, edit the name server values to match the values in your Hosted Zone. The following screenshot of the Route 53 console displays the location of the name server values on the right side. 5. If this doesn't resolve the issue, contact Support. For more information, see Creating a support case in the AWS Support User Guide. My app with multi-level subdomains is stuck in the Pending Veriﬁcation state If an app with multi-level subdomains is stuck in the Pending Veriﬁcation state when connecting to a third-party DNS provider, there might be an issue with the format of your DNS records. Some DNS providers automatically add the second-level domain (SLD) and top-level domain (TLD) domain suﬃxes to your records. If you are also specifying the domain in
amplify-console-ug-098	amplify-console-ug.pdf	98	name server values on the right side. 5. If this doesn't resolve the issue, contact Support. For more information, see Creating a support case in the AWS Support User Guide. My app with multi-level subdomains is stuck in the Pending Veriﬁcation state If an app with multi-level subdomains is stuck in the Pending Veriﬁcation state when connecting to a third-party DNS provider, there might be an issue with the format of your DNS records. Some DNS providers automatically add the second-level domain (SLD) and top-level domain (TLD) domain suﬃxes to your records. If you are also specifying the domain in the format that includes the SLD and TLD, this can cause a domain veriﬁcation issue. My app with multi-level subdomains is stuck in the Pending Veriﬁcation state 300 AWS Amplify Hosting User Guide When you connect a domain, ﬁrst try specifying the domain name using the full format provided by Amplify, for example _hash.docs.backend.example.com. If the SSL conﬁguration gets stuck in the Pending Veriﬁcation state, try removing the TLD and SLD from the records. For example, if the full format is _hash.docs.backend.example.com, specify _hash.docs.backend. Wait 15 to 30 minutes to allow the records to propagate. Then use a tool such as MX Toolbox to check whether the veriﬁcation process is working. My DNS provider doesn't support A records with fully qualiﬁed domain names Some DNS providers don't support A records with a fully qualiﬁed domain name (FQDN), such as example.cloudfront.net. For example, Cloudﬂare A records can only write IPv4 addresses and don't support FQDNs. To work around this limitation, we recommend using CNAME records instead of A records in your DNS conﬁguration. As an example, the following DNS conﬁguration uses an A record. A \| @ \| *.cloudfront.net CNAME \| www \| .cloudfront.net Change it to the following DNS conﬁguration to use CNAME records only. CNAME \| @ \| .cloudfront.net CNAME \| www \| *.cloudfront.net This workaround enables you to properly point your apex domain (@ record) to services like CloudFront, while avoiding the IPv4-only limitation of A records in Cloudﬂare's system. I get a CNAMEAlreadyExistsException error If you get a CNAMEAlreadyExistsException error, this means that one of the host names that you tried to connect (a subdomain, or the apex domain) is already deployed to another Amazon CloudFront distribution. The source of your error depends on your current hosting and DNS providers. A CNAME alias, such as example.com or sub.example.com can only be associated with a single CloudFront distribution at a time. The CNAMEAlreadyExistsException indicates that your domain is already associated with another CloudFront distribution, either within the same AWS account, or potentially in a diﬀerent account. The domain must be disassociated from the previous CloudFront My DNS provider doesn't support A records with fully qualiﬁed domain names 301 AWS Amplify Hosting User Guide distribution before the new distribution created by Amplify Hosting will work. You might need to check more than one account if you or your organization owns multiple AWS accounts. Perform the following steps to diagnose the cause of the CNAMEAlreadyExistsException error. 1. Sign in to the Amazon CloudFront console and verify that you don't have this domain deployed to another distribution. A single CNAME record can be attached to one CloudFront distribution at a time. 2. If you previously deployed the domain to a CloudFront distribution you must remove it. a. b. c. Choose Distributions on the left navigation menu. Select the name of the distribution to edit. Choose the General tab. In the Settings section, choose Edit. d. Remove the domain name from Alternate domain name (CNAME). Then choose, Save changes. 3. Conﬁrm that no other CloudFront distribution exists that is using this domain in the current AWS account or other AWS accounts. If it won't disrupt any currently running services, try deleting and recreating the hosted zone. 4. Check to see whether this domain is connected to a diﬀerent Amplify app that you own. If so, make sure you are not trying to reuse one of the hostnames. If you are using www.example.com for another app, you cannot use www.example.com with the app that you are currently connecting. You can use other subdomains, such as blog.example.com. 5. If this domain was successfully connected to another app and then deleted within the last hour, try again after at least one hour has passed. If you still see this exception after 6 hours, contact Support. For more information, see Creating a support case in the AWS Support User Guide. 6. If you manage your domain through Route 53, make sure to clean up any hosted zone CNAME or ALIAS records that point to the old CloudFront distribution. 7. After completing the preceding steps, remove the custom domain from Amplify Hosting and start over with the workﬂow to connect a custom domain in the Amplify console.
amplify-console-ug-099	amplify-console-ug.pdf	99	to another app and then deleted within the last hour, try again after at least one hour has passed. If you still see this exception after 6 hours, contact Support. For more information, see Creating a support case in the AWS Support User Guide. 6. If you manage your domain through Route 53, make sure to clean up any hosted zone CNAME or ALIAS records that point to the old CloudFront distribution. 7. After completing the preceding steps, remove the custom domain from Amplify Hosting and start over with the workﬂow to connect a custom domain in the Amplify console. I get an Additional Veriﬁcation Required error If you get an Additional Veriﬁcation Required error, this means that AWS Certiﬁcate Manager (ACM) requires additional information to process this certiﬁcate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To I get an Additional Veriﬁcation Required error 302 AWS Amplify Hosting User Guide provide the required information, use the Support Center to contact Support. If you don't have a support plan, post a new thread in the ACM Discussion Forum. Note You cannot request a certiﬁcate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. I get a 404 error on the CloudFront URL To serve traﬃc, Amplify Hosting points to a CloudFront URL via a CNAME record. In the process of connecting an app to a custom domain, the Amplify console displays the CloudFront URL for the app. However, you cannot access your application directly using this CloudFront URL. It returns a 404 error. Your application resolves only using the Amplify app URL (for example, https://main.d5udybEXAMPLE.amplifyapp.com, or your custom domain (for example www.example.com). Amplify needs to route requests to the correct deployed branch and uses the hostname to do this. For example, you can conﬁgure the domain www.example.com that points to the mainline branch of an app, but also conﬁgure dev.example.com that points to the dev branch of the same app. Therefore, you must visit your application based on it's conﬁgured subdomains so that Amplify can route the requests accordingly. I get SSL certiﬁcate or HTTPS errors when visiting my domain If you have Certiﬁcate Authority Authorization (CAA) DNS records conﬁgured with your third-party DNS provider, AWS Certiﬁcate Manager (ACM) might not be able to update or reissue intermediate certiﬁcates for your custom domain SSL certiﬁcate. To resolve this, you need to add a CAA record to trust at least one of Amazon’s certiﬁcate authority domains. The following procedure describes the steps you need to perform. To add a CAA record to trust an Amazon certiﬁcate authority 1. Conﬁgure a CAA record with your domain provider to trust at least one of Amazon’s certiﬁcate authority domains. For more information about conﬁguring the CAA record, see Certiﬁcation Authority Authorization (CAA) problems in the AWS Certiﬁcate Manager User Guide. 2. Use one of the following methods to update your SSL certiﬁcate: I get a 404 error on the CloudFront URL 303 AWS Amplify Hosting User Guide • Manually update using the Amplify console. Note This method will cause down time for your custom domain. a. Sign in to the AWS Management Console and open the Amplify console. b. Choose your app that you want to add a CAA record to. c. In the navigation pane, choose App Settings, Domain management. d. On the Domain management page, delete the custom domain. e. Connect your app to the custom domain again. This process issues a new SSL certiﬁcate and its intermediate certiﬁcates can now be managed by ACM. To reconnect your app to your custom domain, use one of the following procedures that corresponds to the domain provider you are using. • Adding a custom domain managed by Amazon Route 53. • Adding a custom domain managed by a third-party DNS provider. • Updating DNS records for a domain managed by GoDaddy. • Contact Support to have your SSL certiﬁcate reissued. Troubleshooting server-side rendered applications If you experience unexpected issues when deploying an SSR app with Amplify Hosting compute, review the following troubleshooting topics. If you don't see a solution to your issue here, see the SSR web compute troubleshooting guide in the Amplify Hosting GitHub Issues repository. Topics • I need help using a framework adapter • Edge API routes cause my Next.js build to fail • On-Demand Incremental Static Regeneration isn't working for my app • My application's build output exceeds the maximum allowed size • My build fails with an out of memory error • My application's HTTP response size is too large Server-side rendering (SSR) 304 AWS Amplify Hosting User Guide • How do I measure my compute app's start up time locally? I need help using a framework adapter If you are having issues
amplify-console-ug-100	amplify-console-ug.pdf	100	troubleshooting guide in the Amplify Hosting GitHub Issues repository. Topics • I need help using a framework adapter • Edge API routes cause my Next.js build to fail • On-Demand Incremental Static Regeneration isn't working for my app • My application's build output exceeds the maximum allowed size • My build fails with an out of memory error • My application's HTTP response size is too large Server-side rendering (SSR) 304 AWS Amplify Hosting User Guide • How do I measure my compute app's start up time locally? I need help using a framework adapter If you are having issues deploying an SSR app that uses a framework adapter, see Using open source adapters for any SSR framework. Edge API routes cause my Next.js build to fail Currently, Amplify doesn't support Next.js Edge API Routes. You must use non-edge APIs and middleware when hosting your app with Amplify. On-Demand Incremental Static Regeneration isn't working for my app Starting with version 12.2.0, Next.js supports Incremental Static Regeneration (ISR) to manually purge the Next.js cache for a speciﬁc page. However, Amplify doesn't currently support On- Demand ISR. If your app is using Next.js on-demand revalidation, this feature won't work when you deploy your app to Amplify. My application's build output exceeds the maximum allowed size Currently, the maximum build output size that Amplify supports for SSR apps is 220 MB. If you get an error message stating that the size of your app's build output exceeds the maximum allowed size, you must take steps to reduce it. To reduce the size of an app's build output, you can inspect the app's build artifacts and identify any large dependencies to update or remove. First, download the build artifacts to your local computer. Then, check the size of the directories. For example, the node_modules directory might contain binaries such as @swc and @esbuild that are referenced by Next.js server runtime ﬁles. Since these binaries aren't required in the runtime, you can delete them after the build. Use the following instructions to download an app's build output and inspect the size of the directories using the AWS Command Line Interface (CLI). To download and inspect the build output for a Next.js app 1. Open a terminal window and run the following command. Change the app id, branch name, and job id to your own information. For the job id, use the build number for the failed build that you are investigating. I need help using a framework adapter 305 AWS Amplify Hosting User Guide aws amplify get-job --app-id abcd1234 --branch-name main --job-id 2 2. In the terminal output, locate the presigned artifacts URL in the job, steps, stepName: "BUILD" section. The URL is highlighted in red in the following example output. "job": { "summary": { "jobArn": "arn:aws:amplify:us-west-2:111122223333:apps/abcd1234/main/ jobs/0000000002", "jobId": "2", "commitId": "HEAD", "commitTime": "2024-02-08T21:54:42.398000+00:00", "startTime": "2024-02-08T21:54:42.674000+00:00", "status": "SUCCEED", "endTime": "2024-02-08T22:03:58.071000+00:00" }, "steps": [ { "stepName": "BUILD", "startTime": "2024-02-08T21:54:42.693000+00:00", "status": "SUCCEED", "endTime": "2024-02-08T22:03:30.897000+00:00", "logUrl": "https://aws-amplify-prod-us-west-2-artifacts.s3.us- west-2.amazonaws.com/abcd1234/main/0000000002/BUILD/log.txt?X-Amz-Security- Token=IQoJb3JpZ2luX2V...Example 3. Copy and paste the URL into a browser window. An artifacts.zip ﬁle is downloaded to your local computer. This is your build output. 4. Run the du disk usage command to inspect the size of the directories. The following example command returns the size of the compute and static directories. du -csh compute static The following is an example of the output with size information for the compute and static directories. 29M compute 3.8M static 33M total My application's build output exceeds the maximum allowed size 306 AWS Amplify Hosting User Guide 5. Open the compute directory, and locate the node_modules folder. Review your dependencies for ﬁles that you can update or remove to decrease the size of the folder. 6. If your app includes binaries that aren't required in the runtime, delete them after the build by adding the following commands to the build section of your app's amplify.yml ﬁle. - rm -f node_modules/@swc/core-linux-x64-gnu/swc.linux-x64-gnu.node - rm -f node_modules/@swc/core-linux-x64-musl/swc.linux-x64-musl.node The following is an example of the build commands section of an amplify.yml ﬁle with these commands added after running a production build. frontend: phases: build: commands: -npm run build // After running a production build, delete the files - rm -f node_modules/@swc/core-linux-x64-gnu/swc.linux-x64-gnu.node - rm -f node_modules/@swc/core-linux-x64-musl/swc.linux-x64-musl.node My build fails with an out of memory error Next.js enables you to cache build artifacts to improve performance on subsequent builds. In addition, Amplify's AWS CodeBuild container compresses and uploads this cache to Amazon S3, on your behalf, to improve subsequent build performance. This could cause your build to fail with an out of memory error. Perform the following actions to prevent your app from exceeding the memory limit during the build phase. First, remove .next/cache/*/ from the cache.paths section of your build settings. Next, remove the NODE_OPTIONS environment variable from your build settings ﬁle. Instead, set the NODE_OPTIONS environment variable
amplify-console-ug-101	amplify-console-ug.pdf	101	fails with an out of memory error Next.js enables you to cache build artifacts to improve performance on subsequent builds. In addition, Amplify's AWS CodeBuild container compresses and uploads this cache to Amazon S3, on your behalf, to improve subsequent build performance. This could cause your build to fail with an out of memory error. Perform the following actions to prevent your app from exceeding the memory limit during the build phase. First, remove .next/cache/*/ from the cache.paths section of your build settings. Next, remove the NODE_OPTIONS environment variable from your build settings ﬁle. Instead, set the NODE_OPTIONS environment variable in the Amplify console to deﬁne the Node maximum memory limit. For more information about setting environment variables using the Amplify console, see Setting environment variables. After making these changes, try your build again. If it succeeds, add .next/cache/*/ back to the cache.paths section of your build settings ﬁle. My build fails with an out of memory error 307 AWS Amplify Hosting User Guide For more information about Next.js cache conﬁguration to improve build performance, see AWS CodeBuild on the Next.js website. My application's HTTP response size is too large Currently, the maximum response size that Amplify supports for Next.js 12 and later apps using the Web Compute platform is 5.72 MB. Responses over that limit return 504 errors with no content to clients. How do I measure my compute app's start up time locally? Use the following instructions to determine the local initialization/start up time for your Next.js 12 or later Compute app. You can compare your app's performance locally vs. on Amplify Hosting and use the results to improve your app's performance. To measure a Next.js Compute app's initialization time locally 1. Open the app's next.config.js ﬁle and set the output option to standalone as follows. ** @type {import('next').NextConfig} / const nextConfig = { // Other options output: "standalone", }; module.exports = nextConfig; 2. Open a terminal window and run the following command to build the app. next build 3. Run the following command to copy the .next/static folder to .next/ standalone/.next/static. cp -r .next/static .next/standalone/.next/static 4. Run the following command to copy the public folder to .next/standalone/public. cp -r public .next/standalone/public 5. Run the following command to start the Next.js server. My application's HTTP response size is too large 308 AWS Amplify Hosting User Guide node .next/standalone/server.js 6. Note how long it takes between running the command in step 5 and the server starting. When the server is listening on a port, it should print the following message. Listening on port 3000 7. Note how long it takes for any other modules to load after the starting of the server in step 6. For example, libraries like bugsnag take 10-12 seconds to load. After it is loaded, it will display the conﬁrmation message [bugsnag] loaded. 8. Add the time durations from step 6 and step 7 together. This result is your Compute app's local initialization/start up time. Troubleshooting redirects and rewrites If you encounter issues when setting up redirects and rewrites for an Amplify application, consult the topics in this section for help. Topics • Access is denied for certain routes even with the SPA redirect rule. • I want to set up a reverse proxy to an API Access is denied for certain routes even with the SPA redirect rule. If you are getting an access denied error for certain routes with an SPA redirect rule, the baseDirectory might not be set correctly in the app's build settings. For example, if your app's frontend is built to the build directory, your build settings must also point to the build directory. The following build speciﬁcation example demonstrates this setting. frontend: artifacts: baseDirectory: build files: - "/" For a full example of the build speciﬁcation settings for an Amplify app, see Build speciﬁcation YAML syntax reference Redirects and rewrites 309 AWS Amplify Hosting User Guide I want to set up a reverse proxy to an API You can use the following JSON to set up a reverse proxy to a dynamic endpoint. [ { "source": "/documents/<>", "target": "https://otherdomain/resource/<>", "status": "200", "condition": null } ] For a basic example of creating a reverse proxy for your Amplify app to a third-party API, see Reverse proxy rewrite. Troubleshooting caching If you encounter caching issues for an Amplify application, consult the topics in this section for help. Topics • I want to reduce the size of the cache for an app • I want to disable reading from the cache for an app I want to reduce the size of the cache for an app If you are using the cache, you might be caching intermediate ﬁles that aren't cleaned up between builds. Caching these infrequently used ﬁles will increase the size of your cache. To prevent this, you can exclude
amplify-console-ug-102	amplify-console-ug.pdf	102	a third-party API, see Reverse proxy rewrite. Troubleshooting caching If you encounter caching issues for an Amplify application, consult the topics in this section for help. Topics • I want to reduce the size of the cache for an app • I want to disable reading from the cache for an app I want to reduce the size of the cache for an app If you are using the cache, you might be caching intermediate ﬁles that aren't cleaned up between builds. Caching these infrequently used ﬁles will increase the size of your cache. To prevent this, you can exclude speciﬁc folders from being cached by using the ! directive in the cache section of your app's build speciﬁcation. The following build settings example demonstrates how to use the ! directive to specify a folder that you don't want to cache. cache: paths: - node_modules/*/ I want to set up a reverse proxy to an API 310 AWS Amplify Hosting User Guide - "!node_modules/path/not/to/cache" When you cache the node_modules folder, node_modules/.cache is omitted by default. For a full example of the build speciﬁcation settings for an Amplify app, see Build speciﬁcation YAML syntax reference I want to disable reading from the cache for an app If you want to disable reading from the cache for an app, remove the cache section from your app's build speciﬁcation. I want to disable reading from the cache for an app 311 AWS Amplify Hosting User Guide AWS Amplify Hosting reference Use the topics in this section to ﬁnd detailed reference material for AWS Amplify. Topics • AWS CloudFormation support • AWS Command Line Interface support • Resource tagging support • Amplify Hosting API AWS CloudFormation support Use AWS CloudFormation templates to provision Amplify resources, enabling repeatable and reliable web app deployments. AWS CloudFormation provides a common language for you to describe and provision all the infrastructure resources in your cloud environment and simpliﬁes the roll out across multiple AWS accounts and/or regions with just a couple of clicks. For Amplify Hosting, see the Amplify CloudFormation documentation. For Amplify Studio, see the Amplify UI Builder CloudFormation documentation. AWS Command Line Interface support Use the AWS Command Line Interface to create Amplify apps programmatically from the command line. For information, see the AWS CLI documentation. Resource tagging support You can use the AWS Command Line Interface to tag Amplify resources. For more information, see the AWS CLI tag-resource documentation. Amplify Hosting API This reference provides descriptions of the actions and data types for the Amplify Hosting API. For more information, see the Amplify API reference documentation. AWS CloudFormation support 312 AWS Amplify Hosting User Guide Document history for AWS Amplify The following table describes the important changes to the documentation since the last release of AWS Amplify. • Latest documentation update: March 26, 2025 Change Description Date Updated Firewall chapter New Skew protection chapter Updated Webhooks chapter March 26, 2025 March 10, 2025 March 10, 2025 Updated the Firewall support for Amplify hosted sites chapter to describe the general availability (GA) of Amplify's integration with AWS WAF, including the GA functionality and pricing structure. Added the Skew protectio n for Amplify deploymen ts chapter to describe the skew protection feature that eliminates version skew issues between client and servers in Amplify web applications. Added the Uniﬁed webhooks for Git repositories topic to describe the uniﬁed webhooks feature that uses one comprehensive webhook for all Amplify applications associated with a single Git repository. 313 AWS Amplify Hosting User Guide Change Description Date New Adding an SSR Compute role to allow access to AWS Added the Adding an SSR Compute role to allow access February 17, 2025 resources topic New Using AWS WAF to protect your Amplify apps chapter to AWS resources topic to describe how to create and associate an Amplify SSR Compute role with an app to give the Amplify Compute service access to AWS resources. Added the Firewall support for Amplify hosted sites chapter to describe Amplify's integration with AWS WAF (in preview) that enables you to protect your web applications with a web access control list (web ACL). December 18, 2024 Updated managed policies topic Updated the AWS managed policies for AWS Amplify November 14, 2024 Updated Amplify support for Next.js topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the Amplify support for Next.js topic to describe Amplify's support for Next.js version 15. November 6, 2024 314 AWS Amplify Hosting User Guide Change Description Date New Deploying a static website to Amplify from Added the Deploying a static website to Amplify from an Amazon S3 chapter Amazon S3 bucket chapter October 16, 2024 New Managing cache conﬁguration chapter to describe Amplify's new integration with Amazon S3 that enables you to host static website content stored on S3
amplify-console-ug-103	amplify-console-ug.pdf	103	November 14, 2024 Updated Amplify support for Next.js topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the Amplify support for Next.js topic to describe Amplify's support for Next.js version 15. November 6, 2024 314 AWS Amplify Hosting User Guide Change Description Date New Deploying a static website to Amplify from Added the Deploying a static website to Amplify from an Amazon S3 chapter Amazon S3 bucket chapter October 16, 2024 New Managing cache conﬁguration chapter to describe Amplify's new integration with Amazon S3 that enables you to host static website content stored on S3 with just a few clicks. Added the Managing the cache conﬁguration for an app chapter to describe Amplify's default caching behavior and how it applies managed cache policies to content. August 13, 2024 Updated managed policies topic Updated the AWS managed policies for AWS Amplify July 18, 2024 topic to describe recent changes to the AWS managed policies for Amplify. Updated managed policies topic Updated the AWS managed policies for AWS Amplify May 31, 2024 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the AWS managed policies for AWS Amplify topic to describe recent changes to the AWS managed policies for Amplify. April 17, 2024 315 AWS Amplify Hosting User Guide Change Description Date Updated getting started chapter Updated the Getting started with deploying an app to April 12, 2024 Amplify Hosting chapter to use a Next.js example application in the tutorial. Updated managed policies topic Updated the AWS managed policies for AWS Amplify April 5, 2024 topic to describe recent changes to the AWS managed policies for Amplify. Updated managed policies topic Updated the AWS managed policies for AWS Amplify April 4, 2024 New Troubleshooting chapter New support for custom SSL/ TLS certiﬁcates topic to describe recent changes to the AWS managed policies for Amplify. Added the Troubleshooting Amplify Hosting chapter to describe how to ﬁx issues that you encounter with applicati ons deployed to Amplify Hosting. Added the Using SSL/TLS certiﬁcates topic to the Setting up custom domains chapter to describe Amplify support for custom SSL/TLS certiﬁcates when connecting an app to a custom domain. April 2, 2024 February 20, 2024 316 AWS Amplify Hosting User Guide Change Description Date Updated managed policies topic Updated the AWS managed policies for AWS Amplify January 2, 2024 New support for SSR frameworks topic to describe recent changes to the AWS managed policies for Amplify. Updated the Deploying server-side rendered applicati ons with Amplify Hosting topic to describe Amplify support for any Javascript- based SSR framework with an open-source adapter. November 19, 2023 New support for image optimization feature launch Added the Image optimizat ion for SSR apps topic to November 19, 2023 describe the built-in support for image optimization for server-side rendered apps. Updated managed policies topic Updated the AWS managed policies for AWS Amplify November 17, 2023 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the AWS managed policies for AWS Amplify topic to describe recent changes to the AWS managed policies for Amplify. November 6, 2023 317 AWS Amplify Hosting User Guide Change Description Date New wildcard subdomains topic New managed policy November 6, 2023 October 8, 2023 Added the Setting up wildcard subdomains topic to describe support for wildcard subdomains on custom domains. Updated the AWS managed policies for AWS Amplify topic to describe the new AmplifyBackendDepl oyFullAccess AWS managed policy for Amplify. New support for monorepo frameworks feature launch Updated the Conﬁguring monorepo build settings June 19, 2023 topic to describe support for deploying apps in monorepos created using npm workspace , pnpm workspace, Yarn workspace, Nx, and Turborepo . Updated managed policies topic Updated the AWS managed policies for AWS Amplify June 1, 2023 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the AWS managed policies for AWS Amplify topic to describe recent changes to the AWS managed policies for Amplify. February 24, 2023 318 AWS Amplify Hosting User Guide Change Description Date Updated server-side rendering chapter November 17, 2022 Updated the Deploying server-side rendered applicati ons with Amplify Hosting chapter to describe recent changes to Amplify's support for Next.js versions 12 and 13. Updated managed policies topic Updated the AWS managed policies for AWS Amplify August 30, 2022 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the Building a backend for an applicati on topic to describe how to deploy a backend using Amplify Studio. August 23, 2022 Updated managed policies topic Updated the AWS managed policies for AWS Amplify April 27, 2022 Updated managed policies topic topic to describe recent changes to the AWS managed policies for
amplify-console-ug-104	amplify-console-ug.pdf	104	Amplify Hosting chapter to describe recent changes to Amplify's support for Next.js versions 12 and 13. Updated managed policies topic Updated the AWS managed policies for AWS Amplify August 30, 2022 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the Building a backend for an applicati on topic to describe how to deploy a backend using Amplify Studio. August 23, 2022 Updated managed policies topic Updated the AWS managed policies for AWS Amplify April 27, 2022 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the AWS managed policies for AWS Amplify topic to describe recent changes to the AWS managed policies for Amplify. April 17, 2022 319 AWS Amplify Hosting User Guide Change Description Date New GitHub App feature launch April 5, 2022 Added the Setting up Amplify access to GitHub repositor ies topic to describe the new GitHub App for authorizing Amplify access to your GitHub repository. New Amplify Studio feature launch Updated the Welcome to AWS Amplify Hosting topic December 2, 2021 to describe the updates to Amplify Studio that provide a visual designer to create UI components that you can connect to your backend data. Updated managed policies topic Updated the AWS managed policies for AWS Amplify December 2, 2021 topic to describe recent changes to the AWS managed policies for Amplify to support Amplify Studio. Updated managed policies topic Updated the AWS managed policies for AWS Amplify November 8, 2021 Updated managed policies topic topic to describe recent changes to the AWS managed policies for Amplify. Updated the AWS managed policies for AWS Amplify topic to describe recent changes to the AWS managed policies for Amplify. September 27, 2021 320 AWS Amplify Hosting User Guide Change Description Date New managed policies topic Updated Server side rendering chapter July 28, 2021 July 22, 2021 Added the AWS managed policies for AWS Amplify topic to describe the AWS managed policies for Amplify and recent changes to those policies. Updated the Deploying server-side rendered applicati ons with Amplify Hosting chapter to describe new support for Next.js version 10.x.x and Next.js version 11. Updated Conﬁguring build settings chapter Added the Conﬁguring monorepo build settings topic July 20, 2021 to describe how to conﬁgure the build settings and the new AMPLIFY_MONOREPO_A PP_ROOT environment variable when deploying a monorepo app with Amplify. 321 AWS Amplify Hosting User Guide Change Description Date Updated Feature branch deployments chapter Added the Automatic build- time generation of Amplify June 30, 2021 conﬁg (Gen 1 apps only) topic to describe how to autogenerate the aws- exports.js ﬁle at build- time. Added the Condition al backend builds (Gen 1 apps only) topic to describe how to enable condition al backend builds. Added the Use Amplify backends across apps (Gen 1 apps only) topic to describe how to reuse existing backends when you create a new app, connect a new branch to an existing app, or update an existing frontend to point to a diﬀerent backend environme nt. Added the Data Protection in Amplify topic to describe how to apply the shared responsibility model and how Amplify uses encryption to protect your data at rest and in transit. June 3, 2021 Updated Security chapter 322 AWS Amplify Hosting User Guide Change Description Date New support for SSR feature launch Added the Deploying server-si de rendered applications with May 18, 2021 New security chapter Updated custom builds topic Updated monitoring topic Amplify Hosting chapter to describe Amplify support for web apps that use server-si de rendering (SSR) and are created with Next.js. Added the Security in Amplify chapter to describe how to apply the shared responsib ility model when using Amplify and how to conﬁgure Amplify to meet your security and compliance objectives. Updated the Custom build images and live package updates topic to describe how to conﬁgure a custom build image hosted in Amazon Elastic Container Registry Public. Updated the Monitoring topic to describe how to access Amazon CloudWatch metrics data and set alarms. March 26, 2021 March 12, 2021 February 2, 2021 323 AWS Amplify Hosting User Guide Change Description Date New CloudTrail logging topic New Admin UI feature launch February 2, 2021 December 1, 2020 Added the Logging Amplify API calls using AWS CloudTrai l topic to describe how AWS CloudTrail captures and logs all of the API actions for the AWS Amplify Console API Reference and the AWS Amplify Admin UI API Reference. Updated the Welcome to AWS Amplify Hosting topic to describe the new Admin UI that provides a visual interface for frontend web and mobile developers to create and manage app backends outside the AWS Management Console. New performance mode feature launch Updated the Managing app performance topic to describe November 4, 2020 Updated the custom
amplify-console-ug-105	amplify-console-ug.pdf	105	February 2, 2021 December 1, 2020 Added the Logging Amplify API calls using AWS CloudTrai l topic to describe how AWS CloudTrail captures and logs all of the API actions for the AWS Amplify Console API Reference and the AWS Amplify Admin UI API Reference. Updated the Welcome to AWS Amplify Hosting topic to describe the new Admin UI that provides a visual interface for frontend web and mobile developers to create and manage app backends outside the AWS Management Console. New performance mode feature launch Updated the Managing app performance topic to describe November 4, 2020 Updated the custom headers topic how to enable performance mode to optimize for faster hosting performance. Updated the Custom headers topic to describe how to deﬁne custom headers for an Amplify app using the console or by editing a YML ﬁle. October 28, 2020 324 AWS Amplify Hosting User Guide Change Description Date New auto subdomains feature launch Added the Set up automatic subdomains for a Route June 20, 2020 53 custom domain topic to describe how to use pattern-based feature branch deployments for an app connected to an Amazon Route 53 custom domain. Added the Web preview access with subdomains topic to describe how to set up web previews from pull requests to be accessible with subdomains. Added the Notiﬁcations topic to describe how to set up email notiﬁcations for an Amplify app to alert stakeholders or team members when a build succeeds or fails. June 20, 2020 New notiﬁcations topic Updated the custom domains topic Updated the Setting up custom domains topic to May 12, 2020 improve the procedures for adding custom domains in Amazon Route 53, GoDaddy, and Google Domains. This update also includes new troubleshooting informati on for setting up custom domains. 325 AWS Amplify Hosting User Guide Change Description Date AWS Amplify release This release introduces Amplify. November 26, 2018 326
amplifyuibuilder-api-001	amplifyuibuilder-api.pdf	1	Welcome AmplifyUIBuilder API Version 2021-08-11 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AmplifyUIBuilder Welcome AmplifyUIBuilder: Welcome Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AmplifyUIBuilder Table of Contents Welcome Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateComponent ......................................................................................................................................... 4 Request Syntax ........................................................................................................................................ 4 URI Request Parameters ...................................................................................................................... 22 Request Body ......................................................................................................................................... 23 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 44 Errors ....................................................................................................................................................... 46 See Also .................................................................................................................................................. 47 CreateForm .................................................................................................................................................. 48 Request Syntax ...................................................................................................................................... 48 URI Request Parameters ...................................................................................................................... 51 Request Body ......................................................................................................................................... 51 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 58 See Also .................................................................................................................................................. 59 CreateTheme ............................................................................................................................................... 60 Request Syntax ...................................................................................................................................... 60 URI Request Parameters ...................................................................................................................... 60 Request Body ......................................................................................................................................... 61 Response Syntax ................................................................................................................................... 62 Response Elements ............................................................................................................................... 63 Errors ....................................................................................................................................................... 64 See Also .................................................................................................................................................. 65 DeleteComponent ...................................................................................................................................... 66 Request Syntax ...................................................................................................................................... 66 URI Request Parameters ...................................................................................................................... 66 Request Body ......................................................................................................................................... 66 Response Syntax ................................................................................................................................... 66 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 67 See Also .................................................................................................................................................. 67 API Version 2021-08-11 iii AmplifyUIBuilder Welcome DeleteForm .................................................................................................................................................. 68 Request Syntax ...................................................................................................................................... 68 URI Request Parameters ...................................................................................................................... 68 Request Body ......................................................................................................................................... 68 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 68 Errors ....................................................................................................................................................... 69 See Also .................................................................................................................................................. 69 DeleteTheme ............................................................................................................................................... 70 Request Syntax ...................................................................................................................................... 70 URI Request Parameters ...................................................................................................................... 70 Request Body ......................................................................................................................................... 70 Response Syntax ................................................................................................................................... 70 Response Elements ............................................................................................................................... 70 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 71 ExchangeCodeForToken ............................................................................................................................ 72 Request Syntax ...................................................................................................................................... 72 URI Request Parameters ...................................................................................................................... 72 Request Body ......................................................................................................................................... 72 Response Syntax ................................................................................................................................... 73 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 74 ExportComponents .................................................................................................................................... 75 Request Syntax ...................................................................................................................................... 75 URI Request Parameters ...................................................................................................................... 75 Request Body ......................................................................................................................................... 75 Response Syntax ................................................................................................................................... 75 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 94 See Also .................................................................................................................................................. 95 ExportForms ................................................................................................................................................ 96 Request Syntax ...................................................................................................................................... 96 URI Request Parameters ...................................................................................................................... 96 Request Body ......................................................................................................................................... 96 API Version 2021-08-11 iv AmplifyUIBuilder Welcome Response Syntax ................................................................................................................................... 96 Response Elements ............................................................................................................................... 99 Errors ..................................................................................................................................................... 100 See Also ................................................................................................................................................ 100 ExportThemes ........................................................................................................................................... 102 Request Syntax .................................................................................................................................... 102 URI Request Parameters ................................................................................................................... 102 Request Body ....................................................................................................................................... 102 Response Syntax ................................................................................................................................. 102 Response Elements ............................................................................................................................ 103 Errors ..................................................................................................................................................... 104 See Also ................................................................................................................................................ 104 GetCodegenJob ........................................................................................................................................ 106 Request Syntax .................................................................................................................................... 106 URI Request Parameters ................................................................................................................... 106 Request Body ....................................................................................................................................... 106 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 109 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 111 GetComponent ......................................................................................................................................... 113 Request Syntax .................................................................................................................................... 113 URI Request Parameters ................................................................................................................... 113 Request Body ....................................................................................................................................... 113 Response Syntax ................................................................................................................................. 113 Response Elements ............................................................................................................................ 132 Errors ..................................................................................................................................................... 135 See Also ................................................................................................................................................ 135 GetForm ..................................................................................................................................................... 137 Request Syntax .................................................................................................................................... 137 URI Request Parameters ................................................................................................................... 137 Request Body ....................................................................................................................................... 137 Response Syntax ................................................................................................................................. 137 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 142 See Also ................................................................................................................................................ 143 API Version 2021-08-11 v AmplifyUIBuilder Welcome GetMetadata ............................................................................................................................................. 144 Request Syntax .................................................................................................................................... 144 URI Request Parameters ................................................................................................................... 144 Request Body ....................................................................................................................................... 144 Response Syntax ................................................................................................................................. 144 Response Elements ............................................................................................................................ 145 Errors ..................................................................................................................................................... 145 See Also ................................................................................................................................................ 145 GetTheme .................................................................................................................................................. 147 Request Syntax .................................................................................................................................... 147 URI Request Parameters ................................................................................................................... 147 Request Body ....................................................................................................................................... 147 Response Syntax ................................................................................................................................. 147 Response Elements ............................................................................................................................ 148 Errors ..................................................................................................................................................... 150 See Also ................................................................................................................................................ 150 ListCodegenJobs ....................................................................................................................................... 152 Request Syntax .................................................................................................................................... 152 URI Request Parameters ................................................................................................................... 152 Request Body ....................................................................................................................................... 152 Response Syntax ................................................................................................................................. 153 Response Elements ............................................................................................................................ 153 Errors ..................................................................................................................................................... 153 See Also ................................................................................................................................................ 154 ListComponents ........................................................................................................................................ 155 Request Syntax .................................................................................................................................... 155 URI Request Parameters ................................................................................................................... 155 Request Body ....................................................................................................................................... 155 Response Syntax ................................................................................................................................. 155 Response Elements ............................................................................................................................ 156 Errors ..................................................................................................................................................... 156 See Also ................................................................................................................................................ 157 ListForms .................................................................................................................................................... 158 Request Syntax .................................................................................................................................... 158 URI Request Parameters ................................................................................................................... 158 Request Body ....................................................................................................................................... 158 API Version 2021-08-11 vi AmplifyUIBuilder Welcome Response Syntax ................................................................................................................................. 158 Response Elements ............................................................................................................................ 159 Errors ..................................................................................................................................................... 159 See Also ................................................................................................................................................ 160 ListTagsForResource ................................................................................................................................ 161 Request Syntax .................................................................................................................................... 161 URI Request Parameters ................................................................................................................... 161 Request Body ....................................................................................................................................... 161 Response Syntax ................................................................................................................................. 161 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 162 See Also ................................................................................................................................................ 163 ListThemes ................................................................................................................................................. 164 Request Syntax .................................................................................................................................... 164 URI Request Parameters ................................................................................................................... 164 Request Body ....................................................................................................................................... 164 Response Syntax ................................................................................................................................. 164 Response Elements ............................................................................................................................ 165 Errors ..................................................................................................................................................... 165 See Also ................................................................................................................................................ 166 PutMetadataFlag ...................................................................................................................................... 167 Request Syntax .................................................................................................................................... 167 URI Request Parameters ................................................................................................................... 167 Request Body ....................................................................................................................................... 167 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 168 See Also ................................................................................................................................................ 168 RefreshToken ............................................................................................................................................. 170 Request Syntax .................................................................................................................................... 170 URI Request Parameters ...................................................................................................................
amplifyuibuilder-api-002	amplifyuibuilder-api.pdf	2	Syntax .................................................................................................................................... 161 URI Request Parameters ................................................................................................................... 161 Request Body ....................................................................................................................................... 161 Response Syntax ................................................................................................................................. 161 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 162 See Also ................................................................................................................................................ 163 ListThemes ................................................................................................................................................. 164 Request Syntax .................................................................................................................................... 164 URI Request Parameters ................................................................................................................... 164 Request Body ....................................................................................................................................... 164 Response Syntax ................................................................................................................................. 164 Response Elements ............................................................................................................................ 165 Errors ..................................................................................................................................................... 165 See Also ................................................................................................................................................ 166 PutMetadataFlag ...................................................................................................................................... 167 Request Syntax .................................................................................................................................... 167 URI Request Parameters ................................................................................................................... 167 Request Body ....................................................................................................................................... 167 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 168 See Also ................................................................................................................................................ 168 RefreshToken ............................................................................................................................................. 170 Request Syntax .................................................................................................................................... 170 URI Request Parameters ................................................................................................................... 170 Request Body ....................................................................................................................................... 170 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 171 Errors ..................................................................................................................................................... 171 See Also ................................................................................................................................................ 172 API Version 2021-08-11 vii AmplifyUIBuilder Welcome StartCodegenJob ...................................................................................................................................... 173 Request Syntax .................................................................................................................................... 173 URI Request Parameters ................................................................................................................... 174 Request Body ....................................................................................................................................... 175 Response Syntax ................................................................................................................................. 176 Response Elements ............................................................................................................................ 178 Errors ..................................................................................................................................................... 180 See Also ................................................................................................................................................ 181 TagResource .............................................................................................................................................. 182 Request Syntax .................................................................................................................................... 182 URI Request Parameters ................................................................................................................... 182 Request Body ....................................................................................................................................... 182 Response Syntax ................................................................................................................................. 183 Response Elements ............................................................................................................................ 183 Errors ..................................................................................................................................................... 183 See Also ................................................................................................................................................ 184 UntagResource .......................................................................................................................................... 185 Request Syntax .................................................................................................................................... 185 URI Request Parameters ................................................................................................................... 185 Request Body ....................................................................................................................................... 185 Response Syntax ................................................................................................................................. 185 Response Elements ............................................................................................................................ 185 Errors ..................................................................................................................................................... 186 See Also ................................................................................................................................................ 186 UpdateComponent .................................................................................................................................. 188 Request Syntax .................................................................................................................................... 188 URI Request Parameters ................................................................................................................... 206 Request Body ....................................................................................................................................... 207 Response Syntax ................................................................................................................................. 209 Response Elements ............................................................................................................................ 228 Errors ..................................................................................................................................................... 230 See Also ................................................................................................................................................ 231 UpdateForm .............................................................................................................................................. 232 Request Syntax .................................................................................................................................... 232 URI Request Parameters ................................................................................................................... 234 Request Body ....................................................................................................................................... 235 API Version 2021-08-11 viii AmplifyUIBuilder Welcome Response Syntax ................................................................................................................................. 237 Response Elements ............................................................................................................................ 240 Errors ..................................................................................................................................................... 242 See Also ................................................................................................................................................ 242 UpdateTheme ........................................................................................................................................... 244 Request Syntax .................................................................................................................................... 244 URI Request Parameters ................................................................................................................... 244 Request Body ....................................................................................................................................... 245 Response Syntax ................................................................................................................................. 246 Response Elements ............................................................................................................................ 247 Errors ..................................................................................................................................................... 248 See Also ................................................................................................................................................ 249 Data Types ................................................................................................................................... 250 ActionParameters ..................................................................................................................................... 253 Contents ............................................................................................................................................... 253 See Also ................................................................................................................................................ 254 ApiConﬁguration ...................................................................................................................................... 256 Contents ............................................................................................................................................... 256 See Also ................................................................................................................................................ 256 CodegenDependency ............................................................................................................................... 258 Contents ............................................................................................................................................... 258 See Also ................................................................................................................................................ 258 CodegenFeatureFlags .............................................................................................................................. 260 Contents ............................................................................................................................................... 260 See Also ................................................................................................................................................ 260 CodegenGenericDataEnum .................................................................................................................... 261 Contents ............................................................................................................................................... 261 See Also ................................................................................................................................................ 261 CodegenGenericDataField ...................................................................................................................... 262 Contents ............................................................................................................................................... 262 See Also ................................................................................................................................................ 263 CodegenGenericDataModel .................................................................................................................... 264 Contents ............................................................................................................................................... 264 See Also ................................................................................................................................................ 264 CodegenGenericDataNonModel ............................................................................................................ 265 Contents ............................................................................................................................................... 265 API Version 2021-08-11 ix AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 265 CodegenGenericDataRelationshipType ................................................................................................ 266 Contents ............................................................................................................................................... 266 See Also ................................................................................................................................................ 267 CodegenJob ............................................................................................................................................... 268 Contents ............................................................................................................................................... 268 See Also ................................................................................................................................................ 270 CodegenJobAsset ..................................................................................................................................... 272 Contents ............................................................................................................................................... 272 See Also ................................................................................................................................................ 272 CodegenJobGenericDataSchema .......................................................................................................... 273 Contents ............................................................................................................................................... 273 See Also ................................................................................................................................................ 273 CodegenJobRenderConﬁg ...................................................................................................................... 275 Contents ............................................................................................................................................... 275 See Also ................................................................................................................................................ 275 CodegenJobSummary ............................................................................................................................. 276 Contents ............................................................................................................................................... 276 See Also ................................................................................................................................................ 277 Component ................................................................................................................................................ 278 Contents ............................................................................................................................................... 278 See Also ................................................................................................................................................ 281 ComponentBindingPropertiesValue ..................................................................................................... 282 Contents ............................................................................................................................................... 282 See Also ................................................................................................................................................ 282 ComponentBindingPropertiesValueProperties .................................................................................. 283 Contents ............................................................................................................................................... 283 See Also ................................................................................................................................................ 284 ComponentChild ...................................................................................................................................... 285 Contents ............................................................................................................................................... 285 See Also ................................................................................................................................................ 286 ComponentConditionProperty .............................................................................................................. 287 Contents ............................................................................................................................................... 287 See Also ................................................................................................................................................ 288 ComponentDataConﬁguration .............................................................................................................. 289 Contents ............................................................................................................................................... 289 API Version 2021-08-11 x AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 289 ComponentEvent ...................................................................................................................................... 291 Contents ............................................................................................................................................... 291 See Also ................................................................................................................................................ 291 ComponentProperty ................................................................................................................................ 292 Contents ............................................................................................................................................... 292 See Also ................................................................................................................................................ 294 ComponentPropertyBindingProperties ............................................................................................... 296 Contents ............................................................................................................................................... 296 See Also ................................................................................................................................................ 296 ComponentSummary .............................................................................................................................. 297 Contents ............................................................................................................................................... 297 See Also ................................................................................................................................................ 298 ComponentVariant ................................................................................................................................... 299 Contents ............................................................................................................................................... 299 See Also ................................................................................................................................................ 299 CreateComponentData ............................................................................................................................ 300 Contents ............................................................................................................................................... 300 See Also ................................................................................................................................................ 302 CreateFormData ....................................................................................................................................... 303 Contents ............................................................................................................................................... 303 See Also ................................................................................................................................................ 305 CreateThemeData .................................................................................................................................... 306 Contents ............................................................................................................................................... 306 See Also ................................................................................................................................................ 307 DataStoreRenderConﬁg .......................................................................................................................... 308 Contents ............................................................................................................................................... 308 See Also ................................................................................................................................................ 308 ExchangeCodeForTokenRequestBody .................................................................................................. 309 Contents ............................................................................................................................................... 309 See Also ................................................................................................................................................ 309 FieldConﬁg ................................................................................................................................................ 310 Contents ............................................................................................................................................... 310 See Also ................................................................................................................................................ 311 FieldInputConﬁg ....................................................................................................................................... 312 Contents ............................................................................................................................................... 312 API Version 2021-08-11 xi AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 314 FieldPosition .............................................................................................................................................. 316 Contents ............................................................................................................................................... 316 See Also ................................................................................................................................................ 316 FieldValidationConﬁguration ................................................................................................................. 318 Contents ............................................................................................................................................... 318 See Also ................................................................................................................................................ 318 FileUploaderFieldConﬁg ......................................................................................................................... 320 Contents ............................................................................................................................................... 320 See Also ................................................................................................................................................ 321 Form ............................................................................................................................................................ 322 Contents ............................................................................................................................................... 322 See Also ................................................................................................................................................ 324 FormBindingElement ............................................................................................................................... 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 325 FormButton ............................................................................................................................................... 326 Contents ............................................................................................................................................... 326 See Also ................................................................................................................................................ 326 FormCTA ..................................................................................................................................................... 327 Contents ............................................................................................................................................... 327 See Also ................................................................................................................................................ 327 FormDataTypeConﬁg ............................................................................................................................... 329 Contents ............................................................................................................................................... 329 See Also ................................................................................................................................................ 329 FormInputBindingPropertiesValue ....................................................................................................... 330 Contents ............................................................................................................................................... 330 See Also ................................................................................................................................................ 330 FormInputBindingPropertiesValueProperties ..................................................................................... 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 331 FormInputValueProperty ........................................................................................................................ 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 332 FormInputValuePropertyBindingProperties ........................................................................................ 333 Contents ............................................................................................................................................... 333 API Version 2021-08-11 xii AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 333 FormStyle ................................................................................................................................................... 334 Contents ............................................................................................................................................... 334 See Also ................................................................................................................................................ 334 FormStyleConﬁg ....................................................................................................................................... 336 Contents
amplifyuibuilder-api-003	amplifyuibuilder-api.pdf	3	FormBindingElement ............................................................................................................................... 325 Contents ............................................................................................................................................... 325 See Also ................................................................................................................................................ 325 FormButton ............................................................................................................................................... 326 Contents ............................................................................................................................................... 326 See Also ................................................................................................................................................ 326 FormCTA ..................................................................................................................................................... 327 Contents ............................................................................................................................................... 327 See Also ................................................................................................................................................ 327 FormDataTypeConﬁg ............................................................................................................................... 329 Contents ............................................................................................................................................... 329 See Also ................................................................................................................................................ 329 FormInputBindingPropertiesValue ....................................................................................................... 330 Contents ............................................................................................................................................... 330 See Also ................................................................................................................................................ 330 FormInputBindingPropertiesValueProperties ..................................................................................... 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 331 FormInputValueProperty ........................................................................................................................ 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 332 FormInputValuePropertyBindingProperties ........................................................................................ 333 Contents ............................................................................................................................................... 333 API Version 2021-08-11 xii AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 333 FormStyle ................................................................................................................................................... 334 Contents ............................................................................................................................................... 334 See Also ................................................................................................................................................ 334 FormStyleConﬁg ....................................................................................................................................... 336 Contents ............................................................................................................................................... 336 See Also ................................................................................................................................................ 336 FormSummary .......................................................................................................................................... 337 Contents ............................................................................................................................................... 337 See Also ................................................................................................................................................ 338 GraphQLRenderConﬁg ............................................................................................................................ 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 340 MutationActionSetStateParameter ....................................................................................................... 341 Contents ............................................................................................................................................... 341 See Also ................................................................................................................................................ 341 NoApiRenderConﬁg ................................................................................................................................. 342 Contents ............................................................................................................................................... 342 See Also ................................................................................................................................................ 342 Predicate .................................................................................................................................................... 343 Contents ............................................................................................................................................... 343 See Also ................................................................................................................................................ 344 PutMetadataFlagBody ............................................................................................................................. 345 Contents ............................................................................................................................................... 345 See Also ................................................................................................................................................ 345 ReactStartCodegenJobData ................................................................................................................... 346 Contents ............................................................................................................................................... 346 See Also ................................................................................................................................................ 347 RefreshTokenRequestBody ..................................................................................................................... 348 Contents ............................................................................................................................................... 348 See Also ................................................................................................................................................ 348 SectionalElement ..................................................................................................................................... 349 Contents ............................................................................................................................................... 349 See Also ................................................................................................................................................ 350 SortProperty ............................................................................................................................................. 351 Contents ............................................................................................................................................... 351 API Version 2021-08-11 xiii AmplifyUIBuilder Welcome See Also ................................................................................................................................................ 351 StartCodegenJobData ............................................................................................................................. 352 Contents ............................................................................................................................................... 352 See Also ................................................................................................................................................ 353 Theme ......................................................................................................................................................... 354 Contents ............................................................................................................................................... 354 See Also ................................................................................................................................................ 355 ThemeSummary ....................................................................................................................................... 357 Contents ............................................................................................................................................... 357 See Also ................................................................................................................................................ 357 ThemeValue ............................................................................................................................................... 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 359 ThemeValues ............................................................................................................................................. 360 Contents ............................................................................................................................................... 360 See Also ................................................................................................................................................ 360 UpdateComponentData .......................................................................................................................... 361 Contents ............................................................................................................................................... 361 See Also ................................................................................................................................................ 363 UpdateFormData ...................................................................................................................................... 364 Contents ............................................................................................................................................... 364 See Also ................................................................................................................................................ 365 UpdateThemeData ................................................................................................................................... 367 Contents ............................................................................................................................................... 367 See Also ................................................................................................................................................ 367 ValueMapping ........................................................................................................................................... 369 Contents ............................................................................................................................................... 369 See Also ................................................................................................................................................ 369 ValueMappings ......................................................................................................................................... 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 370 Common Parameters ................................................................................................................... 371 Common Errors ............................................................................................................................ 374 API Version 2021-08-11 xiv AmplifyUIBuilder Welcome Welcome Welcome to the AWS Amplify UI Builder API documentation. This reference provides descriptions of the actions and data types for the Amplify UI Builder API. The Amplify UI Builder API provides a programmatic interface for creating and conﬁguring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend AWS resources. You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to AWS, see the Amplify User Guide. This document was last published on May 14, 2025. API Version 2021-08-11 1 AmplifyUIBuilder Actions The following actions are supported: Welcome • CreateComponent • CreateForm • CreateTheme • DeleteComponent • DeleteForm • DeleteTheme • ExchangeCodeForToken • ExportComponents • ExportForms • ExportThemes • GetCodegenJob • GetComponent • GetForm • GetMetadata • GetTheme • ListCodegenJobs • ListComponents • ListForms • ListTagsForResource • ListThemes • PutMetadataFlag • RefreshToken • StartCodegenJob • TagResource • UntagResource • UpdateComponent • UpdateForm API Version 2021-08-11 2 AmplifyUIBuilder • UpdateTheme Welcome API Version 2021-08-11 3 AmplifyUIBuilder CreateComponent Creates a new component for an Amplify app. Request Syntax Welcome POST /app/appId/environment/environmentName/components?clientToken=clientToken HTTP/1.1 Content-type: application/json { "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" CreateComponent API Version 2021-08-11 4 Welcome AmplifyUIBuilder ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" Request Syntax API Version 2021-08-11 5 AmplifyUIBuilder Welcome }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", Request Syntax API Version
amplifyuibuilder-api-004	amplifyuibuilder-api.pdf	4	"property": "string", "type": "string", "userAttribute": "string", "value": "string" Request Syntax API Version 2021-08-11 5 AmplifyUIBuilder Welcome }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", Request Syntax API Version 2021-08-11 6 AmplifyUIBuilder Welcome "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" Request Syntax API Version 2021-08-11 7 Welcome AmplifyUIBuilder } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, Request Syntax API Version 2021-08-11 8 AmplifyUIBuilder Welcome "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Request Syntax API Version 2021-08-11 9 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", Request Syntax API Version 2021-08-11 10 AmplifyUIBuilder Welcome "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Request Syntax API Version 2021-08-11 11 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, Request Syntax API Version 2021-08-11 12 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { Request Syntax API Version 2021-08-11 13 AmplifyUIBuilder Welcome "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { Request Syntax API Version
amplifyuibuilder-api-005	amplifyuibuilder-api.pdf	5	"string", "bindingEvent": "string", "parameters": { "anchor": { Request Syntax API Version 2021-08-11 13 AmplifyUIBuilder Welcome "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { Request Syntax API Version 2021-08-11 14 AmplifyUIBuilder Welcome "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, Request Syntax API Version 2021-08-11 15 AmplifyUIBuilder Welcome "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ Request Syntax API Version 2021-08-11 16 AmplifyUIBuilder Welcome "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], Request Syntax API Version 2021-08-11 17 AmplifyUIBuilder Welcome "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", Request Syntax API Version 2021-08-11 18 AmplifyUIBuilder Welcome "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", Request Syntax API Version 2021-08-11 19 AmplifyUIBuilder Welcome "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", Request Syntax API Version 2021-08-11 20 AmplifyUIBuilder Welcome "value": "string" } } } }, "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", Request Syntax API Version 2021-08-11 21 AmplifyUIBuilder Welcome "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to associate with the component. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that
amplifyuibuilder-api-006	amplifyuibuilder-api.pdf	6	"ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", Request Syntax API Version 2021-08-11 21 AmplifyUIBuilder Welcome "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to associate with the component. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes URI Request Parameters API Version 2021-08-11 22 AmplifyUIBuilder Request Body Welcome The request accepts the following data in JSON format. bindingProperties The data binding information for the component's properties. Type: String to ComponentBindingPropertiesValue object map Required: Yes children A list of child components that are instances of the main component. Type: Array of ComponentChild objects Required: No collectionProperties The data binding conﬁguration for customizing a component's properties. Use this for a collection component. Type: String to ComponentDataConﬁguration object map Required: No componentType The component type. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes events The event conﬁguration for the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map Request Body API Version 2021-08-11 23 AmplifyUIBuilder Required: No name The name of the component Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes overrides Describes the component properties that can be overriden to customize an instance of the component. Type: String to string to string map map Required: Yes properties Describes the component's properties. Type: String to ComponentProperty object map Required: Yes schemaVersion The schema version of the component when it was imported. Type: String Required: No sourceId The unique ID of the component in its original source system, such as Figma. Type: String Required: No tags One or more key-value pairs to use when tagging the component data. Type: String to string map Request Body API Version 2021-08-11 24 AmplifyUIBuilder Welcome Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No variants A list of the unique variants of this component. Type: Array of ComponentVariant objects Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } Response Syntax API Version 2021-08-11 25 AmplifyUIBuilder Welcome ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", Response Syntax API Version 2021-08-11 26 AmplifyUIBuilder Welcome "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", Response Syntax API Version 2021-08-11 27 AmplifyUIBuilder Welcome "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version 2021-08-11 28 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event":
amplifyuibuilder-api-007	amplifyuibuilder-api.pdf	7	], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version 2021-08-11 28 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", Response Syntax API Version 2021-08-11 29 AmplifyUIBuilder Welcome "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" Response Syntax API Version 2021-08-11 30 Welcome AmplifyUIBuilder }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } Response Syntax API Version 2021-08-11 31 Welcome AmplifyUIBuilder }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Response Syntax API Version 2021-08-11 32 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ Response Syntax API Version 2021-08-11 33 AmplifyUIBuilder Welcome "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", Response Syntax API Version 2021-08-11 34 AmplifyUIBuilder Welcome "field": "string" } ] } }, "componentType": "string", "createdAt": "string", "environmentName": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", Response Syntax API Version 2021-08-11 35 AmplifyUIBuilder Welcome "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", Response Syntax API Version 2021-08-11 36 AmplifyUIBuilder Welcome "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event":
amplifyuibuilder-api-008	amplifyuibuilder-api.pdf	8	"condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", Response Syntax API Version 2021-08-11 36 AmplifyUIBuilder Welcome "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", Response Syntax API Version 2021-08-11 37 AmplifyUIBuilder Welcome "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, Response Syntax API Version 2021-08-11 38 AmplifyUIBuilder Welcome "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } Response Syntax API Version 2021-08-11 39 Welcome AmplifyUIBuilder }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Response Syntax API Version 2021-08-11 40 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", Response Syntax API Version 2021-08-11 41 AmplifyUIBuilder Welcome "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Response Syntax API Version 2021-08-11 42 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } Response Syntax API Version 2021-08-11 43 AmplifyUIBuilder Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the component. Type: String bindingProperties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects collectionProperties The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. createdAt The time that the component was created. Response Elements
amplifyuibuilder-api-009	amplifyuibuilder-api.pdf	9	You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects collectionProperties The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. createdAt The time that the component was created. Response Elements API Version 2021-08-11 44 AmplifyUIBuilder Type: Timestamp environmentName Welcome The name of the backend environment that is a part of the Amplify app. Type: String events Describes the events that can be raised on the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map id The unique ID of the component. Type: String modiﬁedAt The time that the component was modiﬁed. Type: Timestamp name The name of the component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides. Type: String to string to string map map properties Describes the component's properties. You can't specify tags as a valid property for properties. Type: String to ComponentProperty object map Response Elements API Version 2021-08-11 45 AmplifyUIBuilder schemaVersion Welcome The schema version of the component when it was imported. Type: String sourceId The unique ID of the component in its original source system, such as Figma. Type: String tags One or more key-value pairs to use when tagging the component. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. variants A list of the component's variants. A variant is a unique style conﬁguration of a main component. Type: Array of ComponentVariant objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Errors API Version 2021-08-11 46 AmplifyUIBuilder HTTP Status Code: 400 ResourceConﬂictException Welcome The resource speciﬁed in the request conﬂicts with an existing resource. HTTP Status Code: 409 ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. HTTP Status Code: 402 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 47 AmplifyUIBuilder CreateForm Creates a new form for an Amplify app. Request Syntax Welcome POST /app/appId/environment/environmentName/forms?clientToken=clientToken HTTP/1.1 Content-type: application/json { "cta": { "cancel": { "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", CreateForm API Version 2021-08-11 48 AmplifyUIBuilder Welcome "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], Request Syntax API Version 2021-08-11 49 AmplifyUIBuilder Welcome "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, "tags": { "string" : "string" } } Request Syntax API
amplifyuibuilder-api-010	amplifyuibuilder-api.pdf	10	"string" }, "concat": [ "FormInputValueProperty" ], Request Syntax API Version 2021-08-11 49 AmplifyUIBuilder Welcome "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, "tags": { "string" : "string" } } Request Syntax API Version 2021-08-11 50 AmplifyUIBuilder Welcome URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to associate with the form. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes Request Body The request accepts the following data in JSON format. cta The FormCTA object that stores the call to action conﬁguration for the form. Type: FormCTA object Required: No dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: Yes ﬁelds The conﬁguration information for the form's ﬁelds. Type: String to FieldConﬁg object map URI Request Parameters API Version 2021-08-11 51 Welcome AmplifyUIBuilder Required: Yes formActionType Speciﬁes whether to perform a create or update action on the form. Type: String Valid Values: create \| update Required: Yes labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none Required: No name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes schemaVersion The schema version of the form. Type: String Required: Yes sectionalElements The conﬁguration information for the visual helper elements for the form. These elements are not associated with any data. Type: String to SectionalElement object map Required: Yes Request Body API Version 2021-08-11 52 Welcome AmplifyUIBuilder style The conﬁguration for the form's style. Type: FormStyle object Required: Yes tags One or more key-value pairs to use when tagging the form data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "cta": { "cancel": { "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, Response Syntax API Version 2021-08-11 53 Welcome AmplifyUIBuilder "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ Response Syntax API Version 2021-08-11 54 Welcome AmplifyUIBuilder { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "id": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { Response Syntax API Version 2021-08-11 55 AmplifyUIBuilder Welcome "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the form. Type: String cta Stores the call to action conﬁguration for the form. Type: FormCTA object dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object environmentName The name of the backend environment that is a part of the Amplify app. Response Elements API Version 2021-08-11 56 Welcome AmplifyUIBuilder Type: String ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map formActionType The operation to perform on the speciﬁed form. Type: String Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on
amplifyuibuilder-api-011	amplifyuibuilder-api.pdf	11	Stores the call to action conﬁguration for the form. Type: FormCTA object dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object environmentName The name of the backend environment that is a part of the Amplify app. Response Elements API Version 2021-08-11 56 Welcome AmplifyUIBuilder Type: String ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map formActionType The operation to perform on the speciﬁed form. Type: String Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. schemaVersion The schema version of the form when it was imported. Type: String sectionalElements Stores the visual helper elements for the form that are not associated with any data. Response Elements API Version 2021-08-11 57 AmplifyUIBuilder Welcome Type: String to SectionalElement object map style Stores the conﬁguration for the form's style. Type: FormStyle object tags One or more key-value pairs to use when tagging the form. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceConﬂictException The resource speciﬁed in the request conﬂicts with an existing resource. HTTP Status Code: 409 ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. Errors API Version 2021-08-11 58 AmplifyUIBuilder HTTP Status Code: 402 See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 59 AmplifyUIBuilder CreateTheme Creates a theme to apply to the components in an Amplify app. Request Syntax Welcome POST /app/appId/environment/environmentName/themes?clientToken=clientToken HTTP/1.1 Content-type: application/json { "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } URI Request Parameters The request uses the following URI parameters. CreateTheme API Version 2021-08-11 60 AmplifyUIBuilder appId Welcome The unique ID of the Amplify app associated with the theme. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes Request Body The request accepts the following data in JSON format. name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes overrides Describes the properties that can be overriden to customize an instance of the theme. Type: Array of ThemeValues objects Required: No tags One or more key-value pairs to use when tagging the theme data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Request Body API Version 2021-08-11 61 AmplifyUIBuilder Welcome Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No values A list of key-value pairs that deﬁnes the properties of the theme. Type: Array of ThemeValues objects Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "createdAt": "string", "environmentName": "string", "id": "string", "modifiedAt": "string", "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", Response Syntax API Version 2021-08-11 62 AmplifyUIBuilder Welcome "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID for the Amplify app associated with the theme. Type: String createdAt The time that the theme was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Type: String id The ID for the theme. Type: String modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp Response Elements API
amplifyuibuilder-api-012	amplifyuibuilder-api.pdf	12	"value": { "children": [ "ThemeValues" ], "value": "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID for the Amplify app associated with the theme. Type: String createdAt The time that the theme was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Type: String id The ID for the theme. Type: String modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp Response Elements API Version 2021-08-11 63 Welcome AmplifyUIBuilder name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the properties that can be overriden to customize a theme. Type: Array of ThemeValues objects tags One or more key-value pairs to use when tagging the theme. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. values A list of key-value pairs that deﬁnes the properties of the theme. Type: Array of ThemeValues objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Errors API Version 2021-08-11 64 AmplifyUIBuilder HTTP Status Code: 400 ResourceConﬂictException Welcome The resource speciﬁed in the request conﬂicts with an existing resource. HTTP Status Code: 409 ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. HTTP Status Code: 402 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 65 Welcome AmplifyUIBuilder DeleteComponent Deletes a component from an Amplify app. Request Syntax DELETE /app/appId/environment/environmentName/components/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app associated with the component to delete. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes id The unique ID of the component to delete. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteComponent API Version 2021-08-11 66 AmplifyUIBuilder Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 67 Welcome AmplifyUIBuilder DeleteForm Deletes a form from an Amplify app. Request Syntax DELETE /app/appId/environment/environmentName/forms/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app associated with the form to delete. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes id The unique ID of the form to delete. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteForm API Version 2021-08-11 68 AmplifyUIBuilder Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For
amplifyuibuilder-api-013	amplifyuibuilder-api.pdf	13	does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteForm API Version 2021-08-11 68 AmplifyUIBuilder Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 69 Welcome AmplifyUIBuilder DeleteTheme Deletes a theme from an Amplify app. Request Syntax DELETE /app/appId/environment/environmentName/themes/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app associated with the theme to delete. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes id The unique ID of the theme to delete. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. DeleteTheme API Version 2021-08-11 70 AmplifyUIBuilder Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 71 AmplifyUIBuilder Welcome ExchangeCodeForToken Note This is for internal use. Amplify uses this action to exchange an access code for a token. Request Syntax POST /tokens/provider HTTP/1.1 Content-type: application/json { "clientId": "string", "code": "string", "redirectUri": "string" } URI Request Parameters The request uses the following URI parameters. provider The third-party provider for the token. The only valid value is figma. Valid Values: figma Required: Yes Request Body The request accepts the following data in JSON format. clientId The ID of the client to request the token from. ExchangeCodeForToken API Version 2021-08-11 72 Welcome AmplifyUIBuilder Type: String Required: No code The access code to send in the request. Type: String Required: Yes redirectUri The location of the application that will receive the access code. Type: String Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "accessToken": "string", "expiresIn": number, "refreshToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessToken The access token. Type: String Response Syntax API Version 2021-08-11 73 AmplifyUIBuilder expiresIn The date and time when the new access token expires. Type: Integer refreshToken Welcome The token to use to refresh a previously issued access token that might have expired. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 74 AmplifyUIBuilder ExportComponents Welcome Exports component conﬁgurations to code that is ready to integrate into an Amplify app. Request Syntax GET /export/app/appId/environment/environmentName/components?nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to export components to. Required: Yes environmentName The name of the backend environment that
amplifyuibuilder-api-014	amplifyuibuilder-api.pdf	14	C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 74 AmplifyUIBuilder ExportComponents Welcome Exports component conﬁgurations to code that is ready to integrate into an Amplify app. Request Syntax GET /export/app/appId/environment/environmentName/components?nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to export components to. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "entities": [ { "appId": "string", "bindingProperties": { ExportComponents API Version 2021-08-11 75 AmplifyUIBuilder Welcome "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, Response Syntax API Version 2021-08-11 76 AmplifyUIBuilder Welcome "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } Response Syntax API Version 2021-08-11 77 AmplifyUIBuilder Welcome }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, Response Syntax API Version 2021-08-11 78 AmplifyUIBuilder Welcome "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", Response Syntax API Version 2021-08-11 79 AmplifyUIBuilder Welcome "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", Response Syntax API Version 2021-08-11 80 AmplifyUIBuilder Welcome "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Response Syntax API Version 2021-08-11 81 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 82 AmplifyUIBuilder Welcome "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [
amplifyuibuilder-api-015	amplifyuibuilder-api.pdf	15	}, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 82 AmplifyUIBuilder Welcome "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } Response Syntax API Version 2021-08-11 83 AmplifyUIBuilder Welcome }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } Response Syntax API Version 2021-08-11 84 Welcome AmplifyUIBuilder ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "createdAt": "string", "environmentName": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, Response Syntax API Version 2021-08-11 85 AmplifyUIBuilder Welcome "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Response Syntax API Version 2021-08-11 86 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", Response Syntax API Version 2021-08-11 87 AmplifyUIBuilder Welcome "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" Response Syntax API Version 2021-08-11 88 AmplifyUIBuilder Welcome }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, Response Syntax API Version 2021-08-11 89 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 90 AmplifyUIBuilder Welcome "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.