2021-02-12 03:49:37 -08:00
|
|
|
---
|
|
|
|
id: aws
|
|
|
|
title: AWS Context
|
|
|
|
sidebar_label: AWS
|
|
|
|
---
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
|
|
Display the currently active AWS profile and region.
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"type": "aws",
|
|
|
|
"style": "powerline",
|
|
|
|
"powerline_symbol": "\uE0B0",
|
|
|
|
"foreground": "#ffffff",
|
|
|
|
"background": "#FFA400",
|
2022-03-27 01:12:47 -07:00
|
|
|
"template": " \uE7AD {{.Profile}}{{if .Region}}@{{.Region}}{{end}}"
|
2021-02-12 03:49:37 -08:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2022-09-16 07:32:48 -07:00
|
|
|
| Name | Type | Description |
|
|
|
|
| ----------------- | ------------------------------------------------------------------------------ | ----------- |
|
|
|
|
| `display_default` | `boolean` - display the segment or not when the user profile matches `default` | defaults |
|
|
|
|
|
2021-02-18 09:47:53 -08:00
|
|
|
to `true`
|
2021-02-12 03:49:37 -08:00
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
2022-09-16 07:32:48 -07:00
|
|
|
```template
|
2022-02-01 03:10:46 -08:00
|
|
|
{{ .Profile }}{{ if .Region }}@{{ .Region }}{{ end }}
|
|
|
|
```
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
### Properties
|
2021-02-12 03:49:37 -08:00
|
|
|
|
2022-09-16 07:32:48 -07:00
|
|
|
| Name | Type | Description |
|
|
|
|
| ---------- | -------- | ---------------------------- |
|
|
|
|
| `.Profile` | `string` | the currently active profile |
|
|
|
|
| `.Region` | `string` | the currently active region |
|
2021-02-12 03:49:37 -08:00
|
|
|
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|