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
|
|
|
|
|
2023-11-19 02:58:42 -08:00
|
|
|
import Config from "@site/src/components/Config.js";
|
|
|
|
|
|
|
|
<Config
|
|
|
|
data={{
|
|
|
|
type: "aws",
|
|
|
|
style: "powerline",
|
|
|
|
powerline_symbol: "\uE0B0",
|
|
|
|
foreground: "#ffffff",
|
|
|
|
background: "#FFA400",
|
|
|
|
template: " \uE7AD {{.Profile}}{{if .Region}}@{{.Region}}{{end}}",
|
|
|
|
}}
|
|
|
|
/>
|
2021-02-12 03:49:37 -08:00
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2024-04-04 14:20:48 -07:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
| ----------------- | :-------: | :-----: | -------------------------------------------- |
|
|
|
|
| `display_default` | `boolean` | `true` | display the segment when default user or not |
|
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
|