Skip to content

Commit

Permalink
Update username template description for AWS (#19690)
Browse files Browse the repository at this point in the history
Update username template description for AWS by calling out what DisplayName and PolicyName actually are placeholders for
  • Loading branch information
ram-parameswaran authored Mar 24, 2023
1 parent 5b35ae4 commit 14eda8a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion website/content/api-docs/secret/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ valid AWS credentials with proper permissions.

To ensure generated usernames are within length limits for both STS/IAM, the template must adequately handle
both conditional cases (see [Conditional Templates](https://pkg.go.dev/text/template)). As an example, if no template
is provided the field defaults to the template:
is provided the field defaults to the template below. It is to be noted that, DisplayName is the name of the vault
authenticated user running the AWS credential generation and PolicyName is the name of the Role for which the
credential is being generated for:

```
{{ if (eq .Type "STS") }}
Expand Down

0 comments on commit 14eda8a

Please sign in to comment.