Skip to content

docs: document --default-region flag for sso generate/populate #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cunymatthieu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document --default-region flag for sso generate/populate #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/content/docs/usage/automatic-config-generation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,30 @@ credential_process = granted credential-process --profile gen_AccountName/RoleNa
# ...
```

### Set a default region

By default, generated profiles don't include a `region` key, so the AWS CLI falls back to your environment variables or `default` profile region. Use `--default-region` to write an explicit `region` on every generated profile. This region is independent of the SSO region, which is useful when your SSO instance lives in one region but you want your API calls to default to another.

```
granted sso generate --sso-region us-east-1 --default-region eu-west-1 https://example.awsapps.com/start
```

Output:

```
[profile AccountName/RoleName]
region = eu-west-1
granted_sso_region = us-east-1
granted_sso_account_id = 123456789012
granted_sso_role_name = RoleName
granted_sso_start_url = https://example.awsapps.com/start
commonfate_generated_by = aws-sso
credential_process = granted credential-process --profile AccountName/RoleName
# ...
```

The flag accepts region shorthands (for example `ew1` expands to `eu-west-1`) and applies the same region to all generated profiles. It is available on both the `generate` and `populate` commands.

### Prune stale generated profiles

When `--prune` is provided, profiles with the `commonfate_generated_by` key will be removed if they no longer exist in the source. This can be useful for removing roles which no longer exist in AWS SSO. The `--prune` flag is only supported on the `populate` command.
Expand Down