id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
8762a5f7c439-0 | Follow our recommended workflow to [set up feature branch deployments with multiple backend environments](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html#team-workflows-with-amplify-cli-backend-environments)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
20a6d59ffe84-0 | Use AWS CloudFormation templates to provision Amplify Console resources, enabling repeatable and reliable web app deployments\. CloudFormation provides a common language for you to describe and provision all the infrastructure resources in your cloud environment and simplifies the roll out across multiple AWS accounts and/or regions with just a couple of clicks\.
For more information, see the [Amplify Console CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Amplify.html) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/cloudformation-support-chapter.md |
3ed696019067-0 | The following table describes the important changes to the documentation since the last release of AWS Amplify\.
+ **Latest documentation update:** June 20, 2020
| Change | Description | Date |
| --- | --- | --- |
| New auto subdomains feature launch | Added the [Set up automatic subdomains for a Route 53 custom domain](to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md#to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.title) 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](pr-previews.md#web-preview-access-on-subdomains) topic to describe how to set up web previews from pull request to be accessible with subdomains\. | June 20, 2020 |
| New notifications topic | Added the [Notifications](notifications.md#notifications.title) topic to describe how to set up email notifications for an Amplify app to alert stakeholders or team members when a build succeeds or fails\. | June 20, 2020 |
| Updated the custom domains topic | Updated the [Set up custom domains](custom-domains.md) topic to improve the procedures for adding custom domains in Amazon Route 53, GoDaddy, and Google Domains\. This update also includes new troubleshooting information for setting up custom domains\. | May 12, 2020 |
| AWS Amplify release | This release introduces the Amplify Console\. | November 26, 2018 | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/document-history.md |
a23ba9e37435-0 | Redirects enable a web server to reroute navigation from one URL to another\. Common reasons for using redirects include: to customize the appearance of 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\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
a32e3a373c55-0 | There are several types of redirects that support specific scenarios\.
**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 user interface\.
**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: | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
a32e3a373c55-1 | + To redirect an entire site to a new hosting location without changing the address of the site\.
+ To redirect all traffic 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\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
278a72b075d4-0 | Redirects consist of the following:
+ 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 region
To create and edit redirects, choose **Rewrites and redirects settings** in the left navigation pane\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-console-redirects.png)
To bulk edit redirects in a JSON editor, choose **Open text editor**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-console-redirects-edit.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
8a3cdc60a772-0 | Redirects are executed from the top of the list down\. Make sure that your ordering has the effect 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/specific\-filename\.html* which redirects to */documents/different\-filename\.html*:
```
/docs/specific-filename.html /documents/different-filename.html 301
/docs/<*> /documents/<*>
```
The following order of redirects ignores the redirection of *specific\-filename\.html* to *different\-filename\.html*:
```
/docs/<*> /documents/<*>
/docs/specific-filename.html /documents/different-filename.html 301
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
33d8c430cc3b-0 | In this section we include example code for common redirect scenarios\.
You can use the following example code to permanently redirect a specific page to a new address\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/original.html` | `/destination.html` | `permanent redirect (301)` | |
JSON: \[\{“source”: “/original\.html”, “status”: “301”, “target”: “/destination\.html”, “condition”: null\}\]
You can use the following example code to redirect any path under a folder to the same path under a different folder\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `docs/<*>` | `/documents/<*>` | `permanent redirect (301)` | |
JSON \[\{“source”: “/docs/<\*>”, “status”: “301”, “target”: “/documents/<\*>”, “condition”: null\}\]
You can use the following example code to redirect all traffic to index\.html as a rewrite\. In this scenario, the rewrite makes it appear to the user that they have arrived at the original address\.
**** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
33d8c430cc3b-1 | ****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `<*>` | `/index.html` | `rewrite (200)` | |
JSON \[\{“source”: “/<\*>”, “status”: “200”, “target”: “/index\.html”, “condition”: null\}\]
You can use the following example code to use a rewrite to change the subdomain that appears to the user\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `https://mydomain.com` | `https://www.mydomain.com` | `rewrite (200)` | |
JSON \[\{“source”: “https://mydomain\.com”, “status”: “200”, “target”: “https://www\.mydomain\.com”, “condition”: null\}\]
You can use the following example code to redirect paths under a folder that can’t be found to a custom 404 page\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
33d8c430cc3b-2 | | Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/<*>` | `/404.html` | `not found (404)` | |
JSON \[\{“source”: “/<\*>”, “status”: “404”, “target”: “/404\.html”, “condition”: null\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
85cd33e70f5a-0 | Most SPA frameworks support HTML5 history\.pushState\(\) to change browser location without triggering 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\. Using regular expressions, the following example sets up a 200 rewrite for all files to index\.html except for the specific file extensions specified in the regular expression\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `</^[^.]+$\|\.(?!(css\|gif\|ico\|jpg\|js\|png\|txt\|svg\|woff\|ttf\|map\|json)$)([^.]+$)/>` | `/index.html` | `200` | |
JSON \[\{“source”: “</^\[^\.\]\+$\|\\\.\(?\!\(css\|gif\|ico\|jpg\|js\|png\|txt\|svg\|woff\|ttf\|map\|json\)$\)\(\[^\.\]\+$\)/>”, “status”: “200”, “target”: “index\.html”, “condition”: null\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
15e53fbd0183-0 | The following example uses a rewrite to proxy content from another location so that it appears to user that the domain hasn’t changed:
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/images` | `https://images.otherdomain.com` | `rewrite (200)` | |
JSON \[\{“source”: “/images”, “status”: “200”, “target”: “https://images\.otherdomain\.com”, “condition”: null\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
a39616dead3d-0 | 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*\)\. The Amplify Console automatically creates clean URLs by adding a trailing slash when required\. The table below highlights different scenarios:
****
| User inputs in browser | URL in the address bar | Document served |
| --- | --- | --- |
| `/about` | `/about` | `/about.html` |
| `/about (when about.html returns 404)` | `/about/` | `/about/index.html` |
| `/about/` | `/about/` | `/about/index.html` | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
8111d5870a99-0 | You can use the following example code to redirect paths in a folder structure to a matching structure in another folder\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/docs/<year>/<month>/<date>/<itemid>` | `/documents/<year>/<month>/<date>/<itemid>` | `permanent redirect (301)` | |
JSON \[\{“source”: “/docs/<year>/<month>/<date>/<itemid>”, “status”: “301”, “target”: “/documents/<year>/<month>/<date>/<itemid>”, “condition”: null\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
ccf325faa829-0 | You can use the following example code to redirect a path to a folder with a name that matches the value of a query string element in the original address:
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/docs?id=<my-blog-id-value` | `/documents/<my-blog-post-id-value>` | `permanent redirect (301)` | |
JSON \[\{“source”: “/docs?id=<my\-blog\-id\-value”, “status”: “301”, “target”: “/documents/<my\-blog\-post\-id\-value>”, “condition”: null\}\]
You can use the following example code to redirect all paths that can’t be found at a given level of a folder structure to index\.html in a specified folder\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/documents/<folder>/<child-folder>/<grand-child-folder>` | `/documents/index.html` | `404` | | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
ccf325faa829-1 | | `/documents/<folder>/<child-folder>/<grand-child-folder>` | `/documents/index.html` | `404` | |
JSON \[\{“source”: “/documents/<x>/<y>/<z>”, “status”: “404”, “target”: “/documents/index\.html”, “condition”: null\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
179c4807d123-0 | You can use the following example code to redirect requests based on region\.
****
| Original address | Destination Address | Redirect Type | Country Code |
| --- | --- | --- | --- |
| `/documents` | `/documents/us/` | `302` | `<US>` |
JSON \[\{“source”: “/documents”, “status”: “302”, “target”: “/documents/us/”, “condition”: “<US>”\}\] | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/redirects.md |
135e0c6f67f4-0 | Pattern\-based branch deployments allow you to automatically deploy branches that match a specific pattern to the Amplify Console\. Product teams using feature branch or GitFlow workflows for their releases, can now define patterns such as ‘release\*\*’ to automatically deploy Git branches that begin with ‘release’ to a shareable URL\. [This blog post](https://dev.to/kkemple/branch-based-deployment-strategies-with-aws-amplify-console-1n3c) describes using this feature with different team workflows\.
1. Choose **App settings > General > Edit**\.
1. Flip the branch autodetection switch to **Enabled**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/autobranch.png)
1. Define patterns for automatically deploying branches\.
+ **`*`** – Deploys all branches in your repository\.
+ **`release*`**’ – Deploys all branches that being with the word ‘release\.
+ **`release*/`** – Deploys all branches that match a ‘release /’ pattern\.
+ Specify multiple patterns in a comma\-separated list\. For example, `release*, feature*`\.
1. Set up automatic password protection for all branches that are automatically created by setting **Branch autodetection \- access control** to **Enabled**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pattern-based-feature-branch-deployments.md |
135e0c6f67f4-1 | 1. Set up automatic password protection for all branches that are automatically created by setting **Branch autodetection \- access control** to **Enabled**\.
1. For applications built with an Amplify backend, you can choose to create a new environment or point all branches to an existing backend\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/autobranch.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pattern-based-feature-branch-deployments.md |
e61e8d765ba8-0 | 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 [Set up automatic subdomains for a Amazon Route 53 custom domain](to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md)
+ For instructions on connecting an Amplify app to a custom domain managed in Route 53, see [Add a custom domain managed by Amazon Route 53](to-add-a-custom-domain-managed-by-amazon-route-53.md)
+ For more information about using Route 53, see [What is Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pattern-based-feature-branch-deployments.md |
a3d3d74e8a40-0 | The Amplify Console automatically detects the front end framework and associated build settings by inspecting the package\.json file in your repository\. You have the following options:
+ Save the build settings in the Amplify Console \- The Amplify Console autodetects build settings and saves it so that they can be accessed via the Amplify Console\. These settings are applied to all of your branches unless there is a YML file found in your repository\.
+ Save the build settings in your repository \- Download the amplify\.yml file and add it to the root of your repository\.
You can edit these settings in the Amplify Console by choosing **App settings>Build settings**\. These build settings are applied to all the branches in your app, except for the branches that have a YML file saved in the repository\.
**Note**
**Build settings** 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](getting-started.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
65e355fdbd1a-0 | The build specification YML contains a collection of build commands and related settings that the Amplify Console uses to run your build\. The YML is structured as follows:
```
version: 1
env:
variables:
key: value
backend:
phases:
preBuild:
commands:
- *enter command*
build:
commands:
- *enter command*
postBuild:
commands:
- *enter command*
frontend:
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
- path
customHeaders:
- pattern: 'file-pattern'
headers:
- key: 'custom-header-name'
value: 'custom-header-value'
- key: 'custom-header-name'
value: 'custom-header-value'
test:
phases:
preTest:
commands: | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
65e355fdbd1a-1 | value: 'custom-header-value'
test:
phases:
preTest:
commands:
- *enter command*
test:
commands:
- *enter command*
postTest:
commands:
- *enter command*
artifacts:
files:
- location
- location
configFilePath: *location*
baseDirectory: *location*
```
+ **version** \- Represents the Amplify Console YML version number\.
+ **appRoot** \- The path within the repository that this application resides in\. *Ignored unless multiple applications are defined\.*
+ **env** \- Add environment variables to this section\. You can also add environment variables using the console\.
+ **backend** \- Run Amplify CLI commands to provision a backend, update Lambda functions, or GraphQL schemas as part of continuous deployment\. Learn how to [deploy a backend with your frontend](deploy-backend.md)\.
+ **frontend** \- Run frontend build commands\.
+ **test** \- Run commands during a test phase\. Learn how to [add tests to your app](running-tests.md)\.
+ | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
65e355fdbd1a-2 | +
**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 we have installed dependencies\.
+ **build** \- Your build commands\.
+ **postBuild** \- The post\-build script runs after the build has finished and we have copied all the necessary artifacts to the output directory\.
+ **artifacts>base\-directory** \- The directory in which your build artifacts exist\.
+ **artifacts>files** \- Specify files from your artifact you want to deploy\. *\*\*/\** is to include all files\.
+ **cache** \- The buildspec’s cache field is used to cache build\-time depedencies such as the *node\_modules* folder, and is automatically suggested based on the package manager and framework that the customer’s app is built in\. During the first build, any paths here are cached, and on subsequent builds we re\-inflate the cache and use those cached dependencies where possible to speed up build time\.
+ **customHeaders** \- Custom header rules set on deployed files\. See [custom headers](custom-headers.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
ae2a2f5d43ae-0 | If you keep multiple projects in a single repository, called a monorepo, you can deploy those applications using Amplify without the need for multiple build configurations or branch configurations\.
Monorepos with multiple Amplify applications are declared as a list of applications:
```
version: 1
applications:
- appRoot: /react-app
env:
variables:
key: value
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
customHeaders:
- pattern: 'file-pattern'
headers:
- key: 'custom-header-name'
value: 'custom-header-value'
- key: 'custom-header-name' | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
ae2a2f5d43ae-1 | - key: 'custom-header-name'
value: 'custom-header-value'
- key: 'custom-header-name'
value: 'custom-header-value'
test:
phases:
preTest:
commands:
- *enter command*
test:
commands:
- *enter command*
postTest:
commands:
- *enter command*
artifacts:
files:
- location
- location
configFilePath: *location*
baseDirectory: *location*
- appRoot: /angular-app
env:
variables:
key: value
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 | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
ae2a2f5d43ae-2 | artifacts:
files:
- location
- location
discard-paths: yes
baseDirectory: location
cache:
paths:
- path
- path
customHeaders:
- pattern: 'file-pattern'
headers:
- key: 'custom-header-name'
value: 'custom-header-value'
- key: 'custom-header-name'
value: 'custom-header-value'
test:
phases:
preTest:
commands:
- *enter command*
test:
commands:
- *enter command*
postTest:
commands:
- *enter command*
artifacts:
files:
- location
- location
configFilePath: *location*
baseDirectory: *location*
```
You must provide the following additional information for each application you declare in your build configuration:
appRoot
The root, within the repository, that the application starts in\. This key must exist, but may have no value if the application can be automatically discovered\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
b248116b45cf-0 | You can use bash shell scripting to set branch\-specific build settings\. For example, the following script uses the system environment variable *$AWS\_BRANCH* to execute one set of commands if the branch name is *main* and a different 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
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
66089184f0d9-0 | 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:
commands:
- npm run build
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
7e4a54245f37-0 | The amplifyPush 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
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
30631ddcb4b4-0 | The following build settings set the output directory to the public folder\.
```
frontend:
phases:
commands:
build:
- yarn run build
artifacts:
baseDirectory: public
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
ee0c4cb719e4-0 | You can use npm or yarn to install packages during the build\.
```
frontend:
phases:
build:
commands:
- npm install -g pkg-foo
- pkg-foo deploy
- yarn run build
artifacts:
baseDirectory: public
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
436058b5154d-0 | 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
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
2297b3049fe5-0 | You can install OS packages for missing dependencies\.
```
build:
phases:
preBuild:
commands:
- yum install -y <package>
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
511859abf8c3-0 | The **envCache** provides key\-value storage at build time\. Values stored in the envCache can only be modified 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>
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
22e5bb66e3f6-0 | To skip an automatic build on a particular commit, include the text **\[skip\-cd\]** at the end of the commit message\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
e5a29cae0b14-0 | You can configure Amplify Console to disable automatic builds on every code commit\. To set up, choose **App settings > General** and then scroll to the **Branches** section that lists all the connected branches\. Select a branch, and then choose **Action > Disable auto build**\. Further commits to that branch will no longer trigger a new build\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/build-settings.md |
9de84290f1df-0 | If you encounter issues when adding a custom domain to an app in the AWS Amplify Console, consult the following topics in this section\.
**Topics**
+ [How do I verify that my CNAME resolves?](#how-do-i-verify-that-my-cname-resolves)
+ [My domain hosted with a third\-party is stuck in the Pending Verification state](#my-domain-hosted-with-a-third-party-is-stuck-in-the-pending-verification-state)
+ [My domain hosted with Amazon Route 53 is stuck in the Pending Verification state](#my-domain-hosted-with-amazon-route-53-is-stuck-in-the-pending-verification-state)
+ [I get a CNAMEAlreadyExistsException error](#i-get-a-cnamealreadyexistsexception-error) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
8476be43a011-0 | 1. After you update your DNS records with your third\-party domain provider, you can use a tool such as [dig](https://en.wikipedia.org/wiki/Dig_(command)) or a free website such as [https://www\.whatsmydns\.net/](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**\.
![\[Screenshot of whatsmydns.net where you enter the name of a website to check.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-troubleshooting-whatsmydns-1Update.png)
1. 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\.
![\[Screenshot of whatsmydns.net that displays the results of a resolving CNAME.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-troubleshooting-whatsmydns-2Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
d77287925f9b-0 | 1. If your custom domain is stuck in the **Pending Verification** 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\.
1. If your CNAME records are not resolving, confirm that the CNAME entry exists in your DNS settings with your domain provider\.
**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 Verification** state\.
1. If you have verified 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 verification 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](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
85236e9cbb52-0 | If you transferred your domain to Amazon Route 53, it is possible that your domain has different name servers than those issued by the Amplify Console when your app was created\. Perform the following steps to diagnose the cause of the error\.
1. Sign in to the [Amazon Route 53 console](https://console.aws.amazon.com/route53/home)
1. In the navigation pane, choose **Hosted Zones** and then choose the name of the domain you are connecting\.
1. 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\.
![\[Screenshot of the Hosted Zone Details section of the Route 53 console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/1555952748759-111.png)
1. 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\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
85236e9cbb52-1 | ![\[Screenshot of the Registered domains section of the Route 53 console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/1555952748759-607.png)
1. If this doesn't resolve the issue, see [GitHub Issues](https://github.com/aws-amplify/amplify-console/issues) and open a new issue if it doesn’t already exist\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
236bccb0fd56-0 | 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\. Perform the following steps to diagnose the cause of the error\.
1. Sign in to the [Amazon CloudFront console](https://console.aws.amazon.com/cloudfront/home?#) and verify that you don't have this domain deployed to any other distribution\. A single CNAME record can be attached to one CloudFront distribution at a time\.
1. If you previously deployed the domain to a CloudFront distribution you must remove it\.
1. Choose **Distributions** on the left navigation menu\.
1. Select the checkbox next to the name of the distribution to edit, then choose **Distribution Settings**\.
1. Choose the **General** tab, and then choose **Edit**\.
1. Remove the domain name from **Alternate Domain Names \(CNAMEs\)**\. Then choose, **Yes, Edit** to save your change\.
1. Check to see whether this domain is connected to a different 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**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
236bccb0fd56-1 | 1. 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, see [GitHub Issues](https://github.com/aws-amplify/amplify-console/issues) and open a new issue if it doesn’t already exist\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domain-troubleshoot-guide.md |
3cfc8ed37d0f-0 | Environment variables are key\-value pairs that are available at build time\. These configurations can be anything, including the following:
+ Database connection details
+ Third\-party API keys
+ Different customization parameters
+ Secrets
As a best practice, you can use environment variables to expose these configurations\. All environment variables that you add are encrypted to prevent rogue access, so you can use them to store secret information\.
**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](getting-started.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
23f27d3fe358-0 | **To set environment variables**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. In the Amplify Console, choose **App Settings**, and then choose **Environment variables**\.
1. In the **Environment variables** section, choose **Manage variables**\.
1. In the **Manage variables** section, under **Variable**, enter your key\. For **Value**, enter your value\. By default, the Amplify console applies the environment variables across all branches, so you don’t have to re\-enter variables when you connect a new branch\.
![\[Screenshot of the Manage variables section.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/envvars.png)
1. \(Optional\) To customize an environment variable specifically for a branch, add a branch override as follows:
1. Choose **Actions** and then choose **Add variable override**\.
1. You now have a set of environment variables specific to your branch\.
![\[An animated gif demonstrating how to add a branch override.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend.gif)
1. Choose **Save**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
215984866b26-0 | To access an environment variable during a build, edit your build settings to include the environment variable in your build commands\.
**To edit build settings to include an environment variable**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. In the Amplify Console, choose **App Settings**, then choose **Build settings**\.
1. In the **App build specification** section, choose **Edit**\.
1. Add the environment variable to your build command\. You should now be able to access your environment variable during your next build\.
```
build:
commands:
- npm run build:$BUILD_ENV
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
2d34fdfc2df8-0 | **To connect a branch to an app**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. 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**
1. When connecting a branch to a new app, in the **Configure build settings** step of the wizard, choose **Create new environment**, and enter the name of your backend environment\. The following screenshot shows the **Backend deployments** section of the Amplify console with **backend** entered for the backend environment name\.
![\[Screenshot of the Backend deployments section in the Amplify Console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-newenvironment-1.png)
1. Expand the **Advanced settings** section in the build settings configuration wizard 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 Console environment variables](#amplify-console-environment-variables)\.
+ **Connecting a branch to an existing app** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
2d34fdfc2df8-1 | + **Connecting a branch to an existing app**
1. 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**\.
1. In the **Environment variables** section, choose **Manage variables**\.
1. In the **Manage variables** section, for **Variable** \(key\), enter your client ID\. For **Value**, enter your client secret\. For the list of Amplify system environment variables that are available by default, see the table in [Amplify Console environment variables](#amplify-console-environment-variables)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
8021c4282184-0 | You can use the following environment variables that are accessible by default within the Amplify Console\.
****
| Variable name | Description | Example value |
| --- | --- | --- |
| AWS\_APP\_ID | The app ID of the current build | abcd123 |
| AWS\_BRANCH | The branch name of the current build | main |
| AWS\_BRANCH\_ARN | The branch ARN of the current build | arn:xxxxx/xxxx/xxxxx |
| AWS\_CLONE\_URL | The clone URL used to fetch the git repository contents | [git@github\.com](mailto:git@github.com):<user\-name>/<repo\-name>\.git |
| AWS\_COMMIT\_ID | The commit ID of the current build\. “HEAD” for rebuilds | xxxxxxxxxxxxxxxxxx |
| AWS\_JOB\_ID | The job ID of the current build\. This includes some padding of ‘0’ so it always has the same length\. | 0000000001 |
| \_LIVE\_UPDATES | The tool will be upgraded to the latest version\. | \[\{“name”:”Amplify CLI”,”pkg”:”@aws\-amplify/cli”,”type”:”npm”,”version”:”latest”\}\] | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
8021c4282184-1 | | AMPLIFY\_FACEBOOK\_CLIENT\_ID | The Facebook client ID\. | 123456 |
| AMPLIFY\_FACEBOOK\_CLIENT\_SECRET | The Facebook client secret\. | example123456 |
| AMPLIFY\_GOOGLE\_CLIENT\_ID | The Google client ID\. | 123456 |
| AMPLIFY\_GOOGLE\_CLIENT\_SECRET | The Google client secret\. | example123456 |
| AMPLIFY\_AMAZON\_CLIENT\_ID | The Amazon client ID\. | 123456 |
| AMPLIFY\_AMAZON\_CLIENT\_SECRET | The Amazon client secret\. | example123456 |
| \_BUILD\_TIMEOUT | The build timeout duration in minutes\. | 30 | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/environment-variables.md |
75dc661e734b-0 | A feature branch deployment consists of a **frontend**, and \(optionally\) a **backend** environment\. The frontend is built and deployed to a global content delivery network \(CDN\), while the backend is deployed by the Amplify CLI to AWS\. For more information about this deployment scenario, see [Getting Started with Fullstack Continuous Deployments](deploy-backend.md)\.
You can use the Amplify Console to continuously deploy backend resources such as GraphQL APIs and Lambda functions with your feature branch deployment\. You can use the following models to deploy your backend and frontend with the Amplify Console:
**Topics**
+ [Feature branch workflow](#standard)
+ [GitFlow workflow](#gitflow)
+ [Per\-developer sandbox](#sandbox) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
2b3c6d98677b-0 | + Create **prod**, **test**, and **dev** backend environments with the Amplify CLI\.
+ Map **prod** and **test** to **main** \(formerly referred to as master\) and **develop** branches\.
+ Teammates can use the **dev** backend environment to test against **feature** branches\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-environments-2.png)
1. Install the Amplify CLI to initialize a new Amplify project\.
```
npm install -g @aws-amplify/cli
```
1. 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
```
1. Add *test* and *dev* backend environments\.
```
amplify env add | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
2b3c6d98677b-1 | 1. 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
amplify env add
? Do you want to use an existing environment? (Y/n): n
? Enter a name for the environment: dev
...
amplify push
```
1. 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
```
1. Visit the Amplify Console in the AWS 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\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend-5.png)
1. Switch to the **Frontend environments** tab and connect your repository provider and *main* branch\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
2b3c6d98677b-2 | 1. Switch to the **Frontend environments** tab and connect your repository provider and *main* branch\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend-6.png)
1. In the build settings screen, pick an existing backend environment to set up continuous deployment with the main branch\. Choose *prod* from the dropdown and grant the service role to Amplify Console\. Choose **Save and deploy**\. After the build completes you will get a main branch deployment available at *https://main\.appid\.amplifyapp\.com*\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend-2.png)
1. Connect *develop* branch in Amplify Console \(assume *develop* and *main* branch are the same at this point\)\. Choose the *test* backend environment\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend-4.png)
1. The Amplify Console is now setup\. 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 | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
2b3c6d98677b-3 | ```
git checkout -b newinternet
amplify env checkout dev
amplify add api
...
amplify push
```
1. After you finish 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
```
1. To preview what the changes will look like, go to the 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 find 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
```
1. 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 | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
2b3c6d98677b-4 | ```
git checkout develop
git merge newinternet
git push
```
1. This will kickoff a build that will update the backend as well as the frontend in the Amplify Console 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\.
1. Delete your feature branch from Git, Amplify Console, 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
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
a0d9e1a914e3-0 | GitFlow uses two branches to record the history of the project\. The *main* branch \(formerly referred to as master branch\) tracks release code only, and the *develop* branch is used as an integration branch for new features\. GitFlow simplifies parallel development by isolating new development from completed work\. New development \(such as features and non\-emergency bug fixes\) is done in *feature* branches\. When the developer is satisfied 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 *hotfix* branches \(to fix emergency bugs\)\.
The diagram below shows a recommended setup with GitFlow\. You can follow the same process as described in the feature branch workflow section above\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-environments-3.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
5b5865370740-0 | + 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 the Amplify Console has its own backend\. This ensures that the Amplify Console uses the Git repository as a single source of truth from which to deploy changes, rather than relying on developers on the team to manually push their backend or front end to production from their local computers\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-env-central-workflow.png)
1. Install the Amplify CLI to initialize a new Amplify project\.
```
npm install -g @aws-amplify/cli
```
1. Initialize a *kita* backend environment for your project\. If you don’t have a project, create one using bootstrap tools like create\-react\-app or Gatsby\.
```
cd next-unicorn
amplify init
? Do you want to use an existing environment? (Y/n): n
? Enter a name for the environment: kita
...
amplify push
```
1. Push code to a Git repository of your choice \(in this example we’ll assume you pushed to main \(formerly referred to as master\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
5b5865370740-1 | 1. Push code to a Git repository of your choice \(in this example we’ll assume you pushed to main \(formerly referred to as master\)\.
```
git commit -am 'Added kita sandbox'
git push origin main
```
1. Connect your repo > *main* to the Amplify Console\.
1. 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 Console\. 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\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend-3.png)
1. Connect *develop* branch in Amplify Console \(assume *develop* and *main* branch are the same at this point\) and choose *Create new environment*\. After the build completes you will get a develop branch deployment available at *https://develop\.appid\.amplifyapp\.com* with a new backend environment that is linked to the branch\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/team-workflows-with-amplify-cli-backend-environments.md |
8a0363388542-0 | The Amplify Console supports instant cache invalidation of the content delivery network \(CDN\) on every code commit\. This enables you to deploy updates to your single page or static app instantly, without giving up the performance benefits of CDN caching\.
To learn more about how the Amplify Console handles cache invalidations, see the blog post [AWS Amplify Console supports instant cache invalidation and delta deployments on every code commit](http://aws.amazon.com/blogs/mobile/aws-amplify-console-supports-instant-cache-invalidation-and-delta-deployments/)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/instant-cache-invalidation.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/ttl.md |
00e5969cb7be-0 | Manual deploys allows you to publish your web app to the Amplify Console without connecting a Git provider\. You can choose to drag and drop a folder from your desktop, or reference an Amazon S3 bucket or external URL\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/manual-deploys.md |
90b158d91588-0 | Drag and drop a folder from your desktop to host your site in seconds\. Log in to the [Amplify Console](https://console.aws.amazon.com/amplify/home) and choose **Deploy without a Git provider**\. Give your app a name, and a name for the environment \(e\.g\. development or production\)\. Drag and drop files from your desktop to publish your web app\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/manual-deploys.gif) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/manual-deploys.md |
26822302ee70-0 | Reference assets that are uploaded to an Amazon S3 bucket, or provide a public URL to files stored elswhere\.
For Amazon S3, choose the bucket and zip file to deploy your site\. You can also set up AWS Lambda triggers so your site is updated everytime new assets are uploaded\. [This blog post](http://aws.amazon.com/blogs/mobile/deploy-files-s3-dropbox-amplify-console/) walks through setting up a Lambda trigger to automatically deploy changes to Amplify on any updates to a bucket\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/manual-deploys-s3.png)
**Note**
When you create the zip 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”, first 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\.
```
<Error>
<Code>AccessDenied</Code>
<Message>Access Denied</Message>
<RequestId>4442587FB7D0A2F9</RequestId>
<HostId>...</HostId>
</Error>
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/manual-deploys.md |
06fe4b8aa576-0 | -----
*****Copyright © 2020 Amazon Web Services, Inc. and/or its affiliates. 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 affiliated with, connected to, or
sponsored by Amazon.
----- | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/index.md |
fec68f4a6d03-0 | + [Welcome to the AWS Amplify Console](welcome.md)
+ [Getting Started with Existing Code](getting-started.md)
+ [Getting Started with Fullstack Continuous Deployments](deploy-backend.md)
+ [Set Up Custom Domains](custom-domains.md)
+ [Understanding DNS terminology and concepts](understanding-dns-terminology-and-concepts.md)
+ [Add a custom domain managed by Amazon Route 53](to-add-a-custom-domain-managed-by-amazon-route-53.md)
+ [Add a custom domain managed by a third-party DNS provider](to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md)
+ [Add a custom domain managed by GoDaddy](to-add-a-custom-domain-managed-by-godaddy.md)
+ [Add a custom domain managed by Google Domains](to-add-a-custom-domain-managed-by-google-domains.md)
+ [Manage subdomains](to-manage-subdomains.md)
+ [Set up automatic subdomains for a Amazon Route 53 custom domain](to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md)
+ [Troubleshooting custom domains](custom-domain-troubleshoot-guide.md)
+ [Configuring Build Settings](build-settings.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/index.md |
fec68f4a6d03-1 | + [Configuring Build Settings](build-settings.md)
+ [Feature branch deployments and team workflows](multi-environments.md)
+ [Team workflows with Amplify CLI backend environments](team-workflows-with-amplify-cli-backend-environments.md)
+ [Pattern-based feature branch deployments](pattern-based-feature-branch-deployments.md)
+ [Manual Deploys](manual-deploys.md)
+ [Deploy to Amplify Console Button](one-click.md)
+ [Web previews](pr-previews.md)
+ [Add End-to-End tests to your app](running-tests.md)
+ [Using Redirects](redirects.md)
+ [Restricting access](access-control.md)
+ [Environment variables](environment-variables.md)
+ [Custom Headers](custom-headers.md)
+ [Incoming Webhooks](webhooks.md)
+ [Access logs](access-logs.md)
+ [Notifications](notifications.md)
+ [Custom Build Images and Live Package Updates](custom-build-image.md)
+ [Adding a Service Role to the Amplify Console When You Connect an App](how-to-service-role-amplify-console.md)
+ [Using instant cache invalidations to manage app performance](ttl.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/index.md |
fec68f4a6d03-2 | + [Using instant cache invalidations to manage app performance](ttl.md)
+ [AWS Amplify reference](aws-amplify-reference-chapter.md)
+ [AWS CloudFormation support](cloudformation-support-chapter.md)
+ [AWS CLI support](aws-cli-support-chapter.md)
+ [Resource tagging support](resource-tagging-support-chapter.md)
+ [Document History for AWS Amplify](document-history.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/index.md |
39b124095415-0 | The Amplify Console is designed to work with feature branch and GitFlow workflows\. The Amplify Console leverages Git branches to create new deployments every time a developer connects a new branch in their repository\. After connecting your first branch, you can create a new feature branch deployment by adding a branch as follows:
1. On the branch list page, choose **Connect branch**\.
1. Choose a branch from your repository\.
1. Save and then deploy your app\.
Your app now has two deployments available at *https://main\.appid\.amplifyapp\.com* and *https://dev\.appid\.amplifyapp\.com*\. This may vary from team\-to\-team, but typically the **main branch** \(formerly referred to as the master branch\) tracks release code and is your production branch\. The **develop branch** is used as an integration branch to test new features\. This way beta testers can test unreleased features on the develop branch deployment, without affecting any of the production end users on the main branch deployment\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-environments-1.png)
**Topics**
+ [Team workflows with Amplify CLI backend environments](team-workflows-with-amplify-cli-backend-environments.md)
+ [Pattern\-based feature branch deployments](pattern-based-feature-branch-deployments.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/multi-environments.md |
cecf7396343b-0 | Use the AWS Command Line Interface to create Amplify Console apps programmatically from the command line\. For information, see the [ AWS CLI documentation\.](https://docs.aws.amazon.com/cli/latest/reference/amplify/index.html) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/aws-cli-support-chapter.md |
d70afc2d2b48-0 | If you are working on unreleased features you can password protect feature branches that are not ready to be accessed publicly\.
![\[Video graphic of password protected sign in.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/password.gif)
**To set passwords on feature branches**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose the app you want to set feature branch passwords on\.
1. In the navigation pane, choose **App settings**, and then choose **Access control**\.
1. In the **Access control settings** section, choose **Manage access**\.
![\[Screenshot of the Access control settings section listing the branches connected to the app.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/accesscontrol1.png)
1. Do one of the following in **Access control settings**:
+ To set a username and password that applies to all connected branches, turn on **Apply a global password**\. For example, if you have **main**, **dev**, and **feature** branches connected, you can use a global password to set the same user name and password for all branches\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/access-control.md |
d70afc2d2b48-1 | + To exclude branches from a global password, turn on **Apply a global password**, and then choose **Publicly viewable** for **Access setting** for any branch that you want to exclude\.
+ To apply a username and password to an individual branch, turn off **Apply a global password**\. For the branch that you want to enter a unique username and password for, choose **Restricted\-password required** for **Access setting** and enter a username and password\.
![\[Screenshot of the Branch access section showing the options for applying passwords globally or per branch.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/accesscontrol2.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/access-control.md |
e623afa7386f-0 | 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\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/understanding-dns-terminology-and-concepts.md |
18c2f654358c-0 | 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 qualified 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\.
**NS record**
An NS record points to name servers that look up your domain details\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/understanding-dns-terminology-and-concepts.md |
8d2d500b8681-0 | 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 find 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\.
The Amplify Console uses a CNAME record to verify that you own your custom domain\. If you host your domain with Route 53, verification is done automatically on your behalf\. However, if you host your domain with a third\-party provider such as GoDaddy or Google, you have to manually update your domain’s DNS settings and add a new CNAME record provided by the Amplify Console\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/understanding-dns-terminology-and-concepts.md |
f61c22fdce74-0 | When you add a custom domain in the Amplify Console, there are a number of steps that need to completed before you can view your app using your custom domain\. The following grapic shows the order of the steps that the Amplify Console performs from SSl creation, to SSL configuration and verification, and finally, domain activation\.
![\[Workflow diagram of the steps in the Amplify Console domain activation process.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/1555951758569-803.png)
The following list describes each step in the domain set up process in detail\.
**SSL create**
The AWS Amplify Console issues an SSL certificate for setting up a secure custom domain\.
**SSL configuration and verification**
Before issuing an SSL certificate, the Amplify Console verifies that you are the owner of the domain\. For domains managed by Amazon Route 53, Amplify automatically updates the DNS verification record\. For domains managed outside of Route 53, you need to manually add the DNS verification record displayed by the Amplify console into your domain with a third\-party DNS provider\.
**Domain activation**
The domain is successfully verified\. For domains managed outside of Route 53, you need to manually add the CNAME records displayed by the Amplify console into your domain with a third\-party DNS provider\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/understanding-dns-terminology-and-concepts.md |
94a4115f4d2e-0 | Set up an incoming webhook in the Amplify Console to trigger a build without comitting code to your Git repository\. Webhook triggers can be used with headless CMS tools \(such as Contentful or GraphCMS\) to trigger builds on content changes, or to trigger daily builds using services such as Zapier\.
1. Log in to the [Amplify Console](https://console.aws.amazon.com/amplify/home) and choose your app\.
1. Navigate to **App Settings > Build Settings** and scroll to the **Incoming webhook** container\. Choose **Create webhook**
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/webhooks.png)
1. Give your webhook a name and choose **Save**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/webhooks2.png)
1. You can copy the webhook URL or run a curl command in your command line to trigger a new build\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/webhooks3.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/webhooks.md |
120fb1efbfbe-0 | You can use the AWS Command Line Interface to tag Amplify resources\. For more information, see the [AWS CLI tag\-resource documentation\.](https://docs.aws.amazon.com/cli/latest/reference/amplify/tag-resource.html) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/resource-tagging-support-chapter.md |
a72947cc2146-0 | **To add a custom domain managed by Amazon Route 53**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose your app that you want to connect to a custom domain\.
1. In the navigation pane, choose **App Settings**, **Domain management**\.
1. On the **Domain management** page, choose **Add domain**\.
![\[Screenshot of the Domain management section in the Amplify console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-customdomain-1.png)
1. For **Domain**, enter your root domain, choose the domain you want to use when it appears in the list, and then choose **Configure Domain**\.
As you start typing, any root domains that you already manage in Route 53 appear in the list\. For example, if the name of your domain is **https://example\.com**, enter **example\.com** for **Domain**\.
![\[Screenshot of the Domain management section in the Amplify console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-customdomain-2.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-amazon-route-53.md |
a72947cc2146-1 | 1. By default, the Amplify console 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 configuration if you want to add subdomains only\. To change the default configuration, choose **Rewrites and redirects** from the navigation pane, configure your domain, and then choose **Save**\.
![\[Screenshot of the Add domain section in the Amplify console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-customdomain-configureUpdate.png)
**Note**
It can take up to 24 hours for the DNS to propagate and to issue the SSL certificate\. For help with resolving errors that occur, see [Troubleshooting custom domains](custom-domain-troubleshoot-guide.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-amazon-route-53.md |
fd15213ef808-0 | For the latest AWS terminology, see the [AWS glossary](https://docs.aws.amazon.com/general/latest/gr/glos-chap.html) in the *AWS General Reference*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/glossary.md |
7885cf8e9e57-0 | Use the following procedure to disable MFA in the AWS SSO console\.
**To disable MFA**
1. Open the [AWS SSO console](https://console.aws.amazon.com/singlesignon)\.
1. In the left navigation pane, choose **Settings**\.
1. On the **Settings** page, choose **Configure**\.
1. On the **Configure authentication** page, choose **Never \(disabled\)**\.
1. Choose **Save Changes**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/how-to-disable-mfa.md |
0cab298e0a29-0 | With [AWS SSO\-Integrated Application Enablement](app-enablement.md), AWS enterprise applications can exist in a child account in your organization but still use your AWS SSO identities\. This provides your application end users with an easy sign\-in experience and allows for delegation of administrator of your applications to operators in a child account\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
4e12762bd1d3-0 | If you want to constrain which of your AWS Organizations accounts that an integrated application can be used, you can do so using service control policies \(SCPs\)\. You can use SCPs to block access to the AWS SSO user and group information and to prevent the application from being started except in designated accounts\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
54565325c3b0-0 | To use AWS SSO\-integrated applications, you must first enable AWS SSO to allow them access\. For more information, see [AWS SSO\-Integrated Application Enablement](app-enablement.md)\.
After they are enabled, integrated applications can access user and group information directly from AWS SSO\. As a result, you won’t have to manage access in both AWS SSO and then again inside the application\. Instead, AWS SSO delegates application access to the application administrator\. To add users to integrated applications, use the console of the application where you created the application\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
bcf7fb21a27b-0 | If you only want to stop or restart user authentications to your application, use the following procedure to either disable or enable your application\.
**To disable or enable your application**
1. In the AWS SSO console, choose **Applications** in the left navigation pane\.
1. Select the application in the list\.
1. Choose **Actions**, and then choose either **Disable** or **Enable**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
5ec60a69ead9-0 | To remove an integrated application, visit the AWS Management Console where you manage your application\. By removing the app this way, the application can gracefully remove resources that you might otherwise pay for\. For emergency purposes only, you can force\-remove an application from the AWS SSO console\. AWS strongly recommends that you avoid this as such an action is irreversible and you might not be able to recover data from the application\.
Before you force\-remove, consider the following options:
+ You can stop user authentications to this application without removing it by using the **Disable** option instead\. For more information, see [Disable or Enable an AWS SSO\-Integrated Application](#awsapps-disable-enable)\.
+ If you want to disconnect the application from AWS SSO permanently, use the AWS Management Console where you created the application and remove it there instead\. This helps to avoid unnecessary application\-related charges that may otherwise appear if you continue with force\-remove\. This process also removes the application from AWS SSO\.
**Warning**
Force\-remove should only be used as a last resort\. This operation deletes all user permissions to this application, disconnects the application from AWS SSO, and renders the application inaccessible\.
**To force\-remove an AWS application**
1. In the AWS SSO console, choose **Applications** in the left navigation pane\.
1. Choose the application you want to remove in the list\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
5ec60a69ead9-1 | 1. Choose the application you want to remove in the list\.
1. On the application **Details** page, under **Remove Application**, choose **force\-remove**\.
1. On the **Force\-remove application** page, review the warning message\. If you agree, enter **remove**, and then choose **Force\-remove**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/awsapps.md |
58bcce985ccf-0 | AWS Single Sign\-On is a cloud\-based single sign\-on \(SSO\) service that makes it easy to centrally manage SSO access to all of your AWS accounts and cloud applications\. Specifically, it helps you manage SSO access and user permissions across all your AWS accounts in AWS Organizations\. AWS SSO also helps you manage access and permissions to commonly used third\-party software as a service \(SaaS\) applications, AWS SSO\-integrated applications as well as | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/what-is.md |
58bcce985ccf-1 | applications, AWS SSO\-integrated applications as well as custom applications that support Security Assertion Markup Language \(SAML\) 2\.0\. AWS SSO includes a user portal where your end\-users can find and access all their assigned AWS accounts, cloud applications, and custom applications in one place\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/what-is.md |
7ef5d16b5a2d-0 | AWS SSO provides the following features:
**Integration with AWS Organizations**
AWS SSO is integrated deeply with AWS Organizations and AWS API operations, unlike other cloud native SSO solutions\. AWS SSO natively integrates with AWS Organizations and enumerates all your AWS accounts\. If you have organized your accounts under organizational units \(OUs\) you will see them displayed that way within the AWS SSO console\. That way you can quickly discover your AWS accounts, deploy common sets of permissions, and manage access from a central location\.
**SSO access to your AWS accounts and cloud applications**
AWS SSO makes it simple for you to manage SSO across all your AWS accounts, cloud applications, AWS SSO\-integrated applications, and custom SAML 2\.0–based applications, without custom scripts or third\-party SSO solutions\. Use the AWS SSO console to quickly assign which users should have one\-click access to only the applications that you've authorized for their personalized end\-user portal\.
**Create and manage users and groups in AWS SSO** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/what-is.md |
7ef5d16b5a2d-1 | **Create and manage users and groups in AWS SSO**
When you enable the service for the first time, we create a default store for you in AWS SSO\. You can use this store to manage your users and groups directly in the console\. Or, if you prefer, you can connect to an existing AWS Managed Microsoft AD directory and manage your users with standard Active Directory management tools provided in Windows Server\. You can also provision users and groups from an external identity provider into AWS SSO and manage access permissions in the AWS SSO console\. If you choose to manage your users in AWS SSO, you can quickly create users and then easily organize them into groups, all within the console\.
**Leverage your existing corporate identities**
AWS SSO is integrated with Microsoft AD through the AWS Directory Service\. That means your employees can sign in to your AWS SSO user portal using their corporate Active Directory credentials\. To grant Active Directory users access to accounts and applications, you simply add them to the appropriate Active Directory groups\. For example, you can grant the DevOps group SSO access to your production AWS accounts\. Users added to the DevOps group are then granted SSO access to these AWS accounts automatically\. This automation makes it easy to onboard new users and give existing users access to new accounts and applications quickly\.
**Compatible with commonly used cloud applications** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/what-is.md |
7ef5d16b5a2d-2 | **Compatible with commonly used cloud applications**
AWS SSO supports commonly used cloud applications such as Salesforce, Box, and Office 365\. This cuts the time needed to set up these applications for SSO by providing application integration instructions\. These instructions act as guard rails to help administrators set up and troubleshoot these SSO configurations\. This eliminates the need for administrators to learn the configuration nuances of each cloud application\.
**Easy to set up and monitor usage**
With AWS SSO, you can enable a highly available SSO service with just a few clicks\. There is no additional infrastructure to deploy or AWS account to set up\. AWS SSO is a highly available and a completely secure infrastructure that scales to your needs and does not require software or hardware to manage\. AWS SSO records all sign\-in activity in AWS CloudTrail, giving you the visibility to monitor and audit SSO activity in one place\.
**Co\-exists with existing IAM users, roles, and policies**
Enabling AWS SSO, including enabling AWS Organizations, has no impact on the users, roles, or policies that you’re already managing in IAM\. You can continue to use your existing access management processes and tools as your organization adopts AWS SSO\.
**No\-cost identity management**
You can add any AWS account managed using AWS Organizations to AWS SSO\. Both AWS SSO and AWS Organizations are available at no additional cost\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/what-is.md |
233b773148c3-0 | Use the following procedure to allow your users to self\-register their own MFA devices\.
**To allow users to register their own MFA devices**
1. Open the [AWS SSO console](https://console.aws.amazon.com/singlesignon)\.
1. In the left navigation pane, choose **Settings**\.
1. On the **Settings** page, choose **Configure**\.
1. On the **Configure authentication** page, under **Who can manage MFA devices**, choose **Users and administrators can add and manage MFA devices**\.
1. Choose **Save Changes**\.
**Note**
After you set up self\-registration for your users, you may want to send them a link to the procedure [How to Register a Device for Use with Multi\-Factor Authentication](user-device-registration.md)\. This topic provides instructions on how to set up their own MFA devices\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/how-to-allow-user-registration.md |
baa6079f96a8-0 | Users and groups that you create in your AWS SSO store are available in AWS SSO only\. Use the following procedure to add users to your AWS SSO store\.
**To add a user**
1. Open the [AWS SSO console](https://console.aws.amazon.com/singlesignon)\.
1. Choose **Users**\.
1. Choose **Add user** and provide the following required information:
1. **Username** – This user name will be required to sign in to the user portal and cannot be changed later\.
1. **Password** – Choose from one of the following choices to send the user's password\.
1. **Send an email to the user with password setup instructions** – This option automatically sends the user an email addressed from Amazon Web Services\. The email invites the user on behalf of your company to access the AWS SSO user portal\.
1. **Generate a one\-time password that you can share with the user** – This option provides you with the user portal URL and password details that you can manually send to the user from your email address\.
1. **Email address**
1. **Confirm email address**
1. **First name** – You must enter a name here for automatic provisioning to work\. For more information, see [Automatic Provisioning](provision-automatically.md)\.
1. **Last name** – You must enter a name here for automatic provisioning to work\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/addusers.md |
baa6079f96a8-1 | 1. **Last name** – You must enter a name here for automatic provisioning to work\.
1. **Display name**
**Note**
\(Optional\) You can provide additional attributes such as **Employee ID** and **Office 365 Immutable ID** to help map the user's identity in AWS SSO with certain business applications that the user needs to use\.
1. Choose **Next: Groups**\.
1. Select one or more groups that you want the user to be a member of\. Then choose **Add user**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/addusers.md |
fe316809e2b7-0 | While on the **Manage SAML 2\.0 certificates** page, you might notice colored status indicator icons\. These icons appear in the **Expires on** column next to each certificate in the list\. The following describes the criteria that AWS SSO uses to determine which icon is displayed for each certificate\.
+ **Red** – Indicates that a certificate is currently expired\.
+ **Yellow** – Indicates that a certificate will expire in 90 days or less\.
+ **Green** – Indicates that a certificate is currently valid and will remain valid for at least 90 more days\.
**To check the current status of a certificate**
1. In the [AWS SSO console](https://console.aws.amazon.com/singlesignon), choose **Settings**\.
1. On the **Settings** page, under **Identity source**, next to **Authentication**, choose **View details**\.
1. On the **SAML 2\.0 authentication** page, under **Identity provider metadata**, choose **Manage certificates**\.
1. On the **Manage SAML 2\.0 certificates** page, review the status of the certificates in the list as indicated in the **Expires on** column\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/samlcertexpirationindicators.md |
f5b2f7e16698-0 | You can assign users in your connected directory permissions to the master account or member accounts in your AWS Organizations organization based on [common job functions](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_job-functions.html)\. Or you can use custom permissions to meet your specific security requirements\. For example, you can grant database administrators broad permissions to Amazon RDS in development accounts but limit their permissions in production accounts\. AWS SSO configures all the necessary user permissions in your AWS accounts automatically\.
**Note**
If you need to grant users or groups permissions to operate in the AWS Organizations master account, because it is a highly privileged account, there are additional security restrictions which require you to have the [IAMFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/IAMFullAccess) policy or equivalent permissions before you can set this up\. These additional security restrictions are not required for any of the member accounts in your AWS organization\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/useraccess.md |
53489b260fc7-0 | Use the following procedure to assign SSO access to users and groups in your connected directory and use permission sets to determine their level of access\.
**Note**
To simplify administration of access permissions, we recommended that you assign access directly to groups rather than to individual users\. With groups you can grant or deny permissions to groups of users rather than having to apply those permissions to each individual\. If a user moves to a different organization, you simply move that user to a different group and they automatically receive the permissions that are needed for the new organization\.
**To assign access to users or groups**
1. Open the [AWS SSO console](https://console.aws.amazon.com/singlesignon)\.
**Note**
Make sure that the AWS SSO console is using the Region where your AWS Managed Microsoft AD directory is located before you move to the next step\.
1. Choose **AWS accounts**\.
1. Under the **AWS organization** tab, in the list of AWS accounts, choose one or more accounts to which you want to assign access\.
**Note**
The AWS SSO Console supports selecting up to 10 AWS accounts at a time per permission set when assigning user access\. If you need to assign more than 10 AWS accounts to the same set of users, repeat this procedure for the additional accounts, selecting the same users and permission set when prompted\.
1. Choose **Assign users**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-single-sign-on-user-guide/doc_source/useraccess.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.