Skip to content

Commit 2ad4d49

Browse files
committed
Added config section to README.md
1 parent ecfce4b commit 2ad4d49

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,13 @@ sso_region = us-east-1
136136
sso_registration_scopes = sso:account:access
137137
sso_start_url = https://d-0000000000.awsapps.com/start
138138
```
139+
140+
## Configuration File
141+
142+
The Knox config file is located at `~/.aws/knox/config.yaml`. Below are the configuration options available:
143+
144+
| Option | Default | Description |
145+
|-----------------------|---------|--------------------------------------------------------------------------------------------------------|
146+
| `default_connect_uid` | `0` | Default user ID for SSM sessions initiated with the `knox connect` command. |
147+
| `max_items_to_show` | `10` | Maximum number of items to display when listing profiles or options. |
148+
| `select_cached_first` | `false` | When selecting credentials, specifies whether to default to showing the cached role credentials first. |

0 commit comments

Comments
 (0)