[Docs]: aws_db_proxy auth block username is invalid for auth_scheme SECRETS

[sheepwall]

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_proxy#auth-2

Description

When trying to supply

  auth {
    description               = "Auth for RDS Proxy"
    secret_arn                = aws_secretsmanager_secret.rds_proxy_secret.arn
    iam_auth                  = "REQUIRED"
    client_password_auth_type = "MYSQL_NATIVE_PASSWORD"
    auth_scheme               = "SECRETS"
    username = "admin"
  }

You get api error InvalidParameterValue: UserName must not be set in UserAuthConfig when SECRETS AuthScheme is used.

Might be pretty obvious after a couple of second's thought, but saw nothing about it.

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[stefanfreitag]

Possibly related issue

• The documented auth > username field does not exist on aws_rds_proxy #20146