Skip to content

Commit 558ead9

Browse files
edwardfoyle0618
andauthored
fix: clarify root user signin for bootstrap (aws-amplify#7587)
* fix: clarify root user signin for bootstrap * fix mdx linting error --------- Co-authored-by: MJ Zhang <[email protected]>
1 parent 33046e8 commit 558ead9

File tree

1 file changed

+20
-24
lines changed
  • src/pages/[platform]/start/account-setup

1 file changed

+20
-24
lines changed

src/pages/[platform]/start/account-setup/index.mdx

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ import { getCustomStaticPath } from '@/utils/getCustomStaticPath';
22

33
export const meta = {
44
title: 'Configure AWS for local development',
5-
description: 'Learn how to set up your AWS account and configure it locally for use with Amplify.',
5+
description:
6+
'Learn how to set up your AWS account and configure it locally for use with Amplify.',
67
platforms: [
78
'android',
89
'angular',
@@ -35,9 +36,9 @@ export function getStaticProps(context) {
3536

3637
</Callout>
3738

38-
This guide will help you set up Temporary credentials with [IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) and [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html), which will enable you to define Single-sign on (SSO), users, groups, permission sets, and more for your team. AWS Organizations can grow to house multiple AWS accounts. Users within the organization can traverse the AWS account(s) as their permission set allows.
39+
This guide will help you set up Temporary credentials with [IAM Identity Center](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) and [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html), which will enable you to define Single-sign on (SSO), users, groups, permission sets, and more for your team. AWS Organizations can grow to house multiple AWS accounts. Users within the organization can traverse the AWS account(s) as their permission set allows.
3940

40-
Amplify leverages the standard local credentials chain provider to simplify access to AWS services. While this guide highlights IAM Identity Center, you can explore additional methods for [authenticating with AWS locally](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-prereqs-keys).
41+
Amplify leverages the standard local credentials chain provider to simplify access to AWS services. While this guide highlights IAM Identity Center, you can explore additional methods for [authenticating with AWS locally](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-prereqs-keys).
4142

4243
<Accordion title="IAM Identity Center terminology">
4344

@@ -46,7 +47,6 @@ IAM Identity Center enables users to sign in using a single user identity to acc
4647
### Users
4748

4849
Users refers to the location where user identities and group information are stored and managed. IAM Identity Center can integrate with external identity sources like Microsoft Active Directory or use a built-in identity store provided by AWS.
49-
5050

5151
### Permission Set
5252

@@ -71,7 +71,6 @@ You can use temporary security credentials to make programmatic requests for AWS
7171

7272
</Accordion>
7373

74-
7574
## Set up Identity Center
7675

7776
Follow the steps below if **you have never set up AWS profiles before**. If you already have a profile, attach the `AmplifyBackendDeployFullAccess` managed policy to your [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_attach-policy.html).
@@ -80,21 +79,22 @@ Follow the steps below if **you have never set up AWS profiles before**. If you
8079

8180
Sign in to the AWS Console to access [IAM Identity Center page](https://console.aws.amazon.com/singlesignon/home) and choose **Enable**.
8281

83-
![AWS IAM Identity Center page indicating the "enable" button.](/images/gen2/account-setup/sso-enable.png)
82+
![AWS IAM Identity Center page indicating the "enable" button.](/images/gen2/account-setup/sso-enable.png)
8483

8584
A dialog will open, prompting you to "Choose how to configure IAM Identity Center in your AWS environment." Select **Enable with AWS Organizations** and choose **Continue**.
8685

87-
![AWS IAM Identity Center enable dialog with AWS Organizations, indicating to "continue".](/images/gen2/account-setup/sso-enable-dialog.png)
86+
![AWS IAM Identity Center enable dialog with AWS Organizations, indicating to "continue".](/images/gen2/account-setup/sso-enable-dialog.png)
8887

8988
Next, we are going to automate a number of steps that simulate the operations of setting up a user in the IdC console. To get started open CloudShell, located in the console footer.
9089

9190
<Video src="/images/gen2/account-setup/sso-cloud-shell.mp4" />
9291

9392
Paste the following command in the CloudShell terminal and enter an email address you would like to associate with this AWS account:
9493

95-
``` bash title="CloudShell" showLineNumbers={false}
94+
```bash title="CloudShell" showLineNumbers={false}
9695
read -p "Enter email address: " user_email # hit enter
9796
```
97+
9898
```console showLineNumbers={false}
9999
Enter email address: <your-email-address>
100100
```
@@ -135,8 +135,7 @@ Username: amplify-admin
135135
![AWS IAM Identity Center dashboard indicating "permission sets" in the navigation pane.](/images/gen2/account-setup/sso-dashboard-highlight-permission-sets.png)
136136

137137
- Select **Create permission set**.
138-
- When prompted for the permission set type, choose **Custom permission set**. Then choose **Next**.
139-
Expand **AWS Managed Policies (set)** and search for _amplify_. Select **AmplifyBackendDeployFullAccess** and choose **Next**.
138+
- When prompted for the permission set type, choose **Custom permission set**. Then choose **Next**. Expand **AWS Managed Policies (set)** and search for _amplify_. Select **AmplifyBackendDeployFullAccess** and choose **Next**.
140139

141140
![AWS IAM Identity Center custom permission set page with the "AmplifyBackendDeployFullAccess" AWS managed policy selected.](/images/gen2/account-setup/sso-permission-set-custom.png)
142141

@@ -157,7 +156,7 @@ Expand **AWS Managed Policies (set)** and search for _amplify_. Select **Amplify
157156
![AWS IAM Identity Center "AWS accounts" page with the management account checked.](/images/gen2/account-setup/sso-aws-accounts.png)
158157

159158
- When prompted to assign a user or group, select the **Users** tab, select the user created in step 13, and choose **Next**.
160-
159+
161160
![AWS IAM Identity Center "AWS accounts" page assigning "amplify-admin" to the management AWS account](/images/gen2/account-setup/sso-aws-accounts-add-user.png)
162161

163162
- Assign the permission set created in step 9 and choose **Next**.
@@ -169,11 +168,12 @@ Expand **AWS Managed Policies (set)** and search for _amplify_. Select **Amplify
169168
- Navigate to the copied URL and sign in as your user, _amplify-admin_. After signing in, you should have access to an AWS account.
170169

171170
![AWS IAM Identity Center access portal displaying an AWS account.](/images/gen2/account-setup/sso-access-portal.png)
171+
172172
</Accordion>
173173

174174
### 2. Create password for user
175175

176-
Now create a password for the user that we need for the next step. In the IdC console, navigate to _Users > amplify_admin > Reset password > Send an email to the user with instructions for resetting the password_.
176+
Now create a password for the user that we need for the next step. In the IdC console, navigate to _Users > amplify_admin > Reset password > Send an email to the user with instructions for resetting the password_.
177177

178178
<Video src="/images/gen2/account-setup/sso-reset-password.mp4" />
179179

@@ -189,11 +189,10 @@ Now, set up an AWS profile that is linked to the user you just created on your l
189189

190190
Install the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
191191

192-
193192
<BlockSwitcher>
194193

195194
<Block name="Mac">
196-
In your browser, download the macOS pkg file:
195+
In your browser, download the macOS pkg file:
197196

198197
[Install on Mac](https://awscli.amazonaws.com/AWSCLIV2.pkg)
199198

@@ -221,7 +220,7 @@ unzip awscliv2.zip
221220

222221
### 4. Set up local AWS profile
223222

224-
Open your terminal, you are ready to configure an AWS profile that uses the SSO user. Use the information from CloudShell to populate the information below.
223+
Open your terminal, you are ready to configure an AWS profile that uses the SSO user. Use the information from CloudShell to populate the information below.
225224

226225
```console title="Terminal" showLineNumbers={false}
227226
//highlight-next-line
@@ -233,11 +232,11 @@ aws configure sso
233232
| SSO registration scopes [sso:account:access]: <leave blank>
234233
| Attempting to automatically open the SSO authorization page in your default browser.
235234
| If the browser does not open or you wish to use a different device to authorize this request, open the following URL:
236-
|
235+
|
237236
| https://device.sso.us-east-2.amazonaws.com/
238-
|
237+
|
239238
| Then enter the code:
240-
|
239+
|
241240
| SOME-CODE
242241

243242
## browser opens
@@ -279,17 +278,15 @@ sso_region = <your-region>
279278
sso_registration_scopes = sso:account:access
280279
```
281280

282-
283281
### 5. Bootstrap your AWS account
284282

285-
Now you are ready to use this AWS profile with AWS Amplify. Open your Amplify project and start the sandbox. If you have multiple local profiles or named your profile something other than `default`, you can specify a profile with `--profile`.
286-
283+
Now you are ready to use this AWS profile with AWS Amplify. Open your Amplify project and start the sandbox. If you have multiple local profiles or named your profile something other than `default`, you can specify a profile with `--profile`.
287284

288285
```bash title="Terminal" showLineNumbers={false}
289286
// highlight-next-line
290287
npx ampx sandbox
291288

292-
# OR
289+
# OR
293290

294291
// highlight-next-line
295292
npx ampx sandbox --profile <profile-name>
@@ -306,8 +303,7 @@ Bootstrapping is the process of provisioning resources for the AWS CDK before yo
306303

307304
![Bootstrap status message indicating that the given Region has not been bootstrapped and that the user needs to sign in to the console and re-run the npx ampx sandbox command to complete the bootstrap process.](/images/gen2/account-setup/profile4.png)
308305

309-
During the first-time setup, `npx ampx sandbox` will ask you to sign in to the AWS Management Console. Once you're signed in, you will be redirected to the Amplify console. On the **Create new app** page, choose **Initialize setup now**. It may take a few minutes for the bootstrapping process to complete.
310-
306+
During the first-time setup, `npx ampx sandbox` will ask you to sign in to the AWS Management Console. You must sign in as the account root user or as a user that has AdministratorAccess. Once signed in, you will be redirected to the Amplify console. On the **Create new app** page, choose **Initialize setup now**. It may take a few minutes for the bootstrapping process to complete.
311307

312308
![Create new app page in Amplify console with the Initialize setup now button.](/images/gen2/account-setup/profile5.png)
313309

0 commit comments

Comments
 (0)