From 14eda8a1783b22f60fd4dba1bc40c7bb46d16943 Mon Sep 17 00:00:00 2001 From: ram-parameswaran <109940849+ram-parameswaran@users.noreply.github.com> Date: Fri, 24 Mar 2023 13:56:55 +1100 Subject: [PATCH] Update username template description for AWS (#19690) Update username template description for AWS by calling out what DisplayName and PolicyName actually are placeholders for --- website/content/api-docs/secret/aws.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/secret/aws.mdx b/website/content/api-docs/secret/aws.mdx index 5d60934112..e2c99fc11f 100644 --- a/website/content/api-docs/secret/aws.mdx +++ b/website/content/api-docs/secret/aws.mdx @@ -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") }}