Skip to content

Commit edccb18

Browse files
JadenSimonJadenSimon
authored
fix(docs): update documentation relating to credentials (#2983)
## Problem Outdated documentation that refers to non-existent commands. ## Solution Update the documentation
1 parent 92109d6 commit edccb18

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

‎README.quickstart.cloud9.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The Toolkit provides commands (prefixed with `AWS:`) to the AWS Cloud9 _Go to An
112112
| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
113113
| `AWS: About Toolkit` | Displays information about the AWS Toolkit. |
114114
| `AWS: Add SAM Debug Configuration` | Creates an `aws-sam` Debug Configuration from a function in the given source file |
115-
| `AWS: Choose AWS Profile...` | Selects the current credentials profile used to connect to AWS. |
115+
| `AWS: Connect to AWS` | Select or create a connection to AWS. |
116116
| `AWS: Create a new Issue on Github` | Opens the AWS Toolkit's [New Issue page on Github](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
117117
| `AWS: Create Credentials Profile` | Creates an AWS credentials profile. |
118118
| `AWS: Create Lambda SAM Application` | Generates code files for a new AWS serverless Lambda application. For more information, see [Creating a Serverless Application](https://docs.aws.amazon.com/cloud9/latest/user-guide/latest/user-guide/create-sam.html) in the user guide. |
@@ -123,7 +123,7 @@ The Toolkit provides commands (prefixed with `AWS:`) to the AWS Cloud9 _Go to An
123123
| `AWS: Edit SAM Debug Configuration` | Shows a tool that helps you create, edit, run, and debug a SAM _launch config_ (`type:aws-sam`). |
124124
| `AWS: Detect SAM CLI` | Checks whether the Toolkit can communicate correctly with the AWS SAM CLI that is installed. |
125125
| `AWS: Show or Hide Regions` | Adds or removes AWS Regions in the **AWS Explorer**. |
126-
| `AWS: Sign out` | Disconnects the Toolkit from the currently-connected AWS account. |
126+
| `AWS: Sign out` | Disconnect the Toolkit from the current AWS connection. |
127127
| `AWS: Submit Quick Feedback...` | Submit a private, one-way message and sentiment to the AWS Toolkit dev team. For larger issues that warrant conversations or bugfixes, please submit an issue in Github with the **AWS: Create a New Issue on Github** command. |
128128
| `AWS: Toggle SAM hints in source files` | Toggles AWS SAM-related Inline Actions in source files |
129129
| `AWS: View Toolkit Logs` | Displays log files that contain general Toolkit diagnostic information. |

‎README.quickstart.vscode.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ palette_, available by selecting _View > Command Palette_ or by typing
236236
| :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
237237
| `AWS: About Toolkit` | Displays information about the AWS Toolkit. |
238238
| `AWS: Add SAM Debug Configuration` | Creates an `aws-sam` Debug Configuration from a function in the current source file |
239-
| `AWS: Choose AWS Profile...` | Selects the current credentials profile used to connect to AWS. For more information, see [Connecting to AWS](https://docs.aws.amazon.com/console/toolkit-for-vscode/connect). |
239+
| `AWS: Connect to AWS` | Select or create a connection to AWS. For more information, see [Connecting to AWS](https://docs.aws.amazon.com/console/toolkit-for-vscode/connect). |
240240
| `AWS: Copy Log Stream Name` | Copies the name of the active CloudWatch Log Stream |
241241
| `AWS: Create a new Step Functions state machine` | Generates a new Amazon States Language definition to use as the definition for a new Step Functions state machine. For more information, see [State Machine Templates](https://docs.aws.amazon.com//toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#templates-stepfunctions) in the user guide. |
242242
| `AWS: Create a new Issue on Github` | Opens the AWS Toolkit's [New Issue page on Github](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
@@ -256,7 +256,7 @@ palette_, available by selecting _View > Command Palette_ or by typing
256256
| `AWS: Report an Issue` | In the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit, opens the page to [create a new issue](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
257257
| `AWS: Save Current Log Content To File` | Saves currently-loaded CloudWatch Log Stream data to a local `.log` file. |
258258
| `AWS: Show or Hide Regions` | Adds or removes AWS Regions in the **AWS Explorer**. |
259-
| `AWS: Sign out` | Disconnects the Toolkit from the currently-connected AWS account. |
259+
| `AWS: Sign out` | Disconnect the Toolkit from the current AWS connection. |
260260
| `AWS: Submit Quick Feedback...` | Submit a private, one-way message and sentiment to the AWS Toolkit dev team. For larger issues that warrant conversations or bugfixes, please submit an issue in Github with the **AWS: Create a New Issue on Github** command. |
261261
| `AWS: Toggle SAM hints in source files` | Toggles AWS SAM-related Codelenses in source files |
262262
| `AWS: View Toolkit Logs` | Displays log files that contain general Toolkit diagnostic information. |

‎resources/walkthrough/setup-connect.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
To interact with Amazon Web Services \(AWS\) through the AWS Toolkit for Visual Studio Code, you must establish a connection to AWS\.
44

5-
## Prerequisties
5+
## How to connect
66

7-
- An AWS account. This account enables you to use AWS services. To get an AWS account, on the [AWS home page](https://aws.amazon.com), choose `Create an AWS Account`.
8-
- [AWS credentials](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/obtain-credentials.html). You can obtain credentials through AWS or an external credential process that isn't directly supported by AWS.
7+
Choose the most appropriate method based on your requirements.
8+
9+
- [AWS access keys](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/obtain-credentials.html)
10+
- [IAM Identity Center](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/sso-credentials.html)
11+
- [External credentials](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/external-credential-process.html)
912

1013
## Connect to AWS through the Toolkit for VS Code
1114

0 commit comments

Comments
 (0)