Skip to content
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.

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

docs(credential-providers): fix env var names and caller example #3412

Merged
merged 2 commits into from
Aug 17, 2023

Conversation

corford
Copy link
Contributor

@corford corford commented Mar 11, 2022

Issue

None

Description

  • The documentation for @aws-sdk/credential-providers fromTokenFile method contains typos for the roleArn and roleSessionName environment variable names. This PR fixes that.
  • The EKS code example for @aws-sdk/credential-provider-node incorrectly shows how to set the roleAssumerWithWebIdentity STS client config option. This PR fixes that.

Testing

N/A (though I can confirm both changes were needed to successfully run our app on an EKS cluster in eu-west-1 with IRSA )

Additional context

  • A correct illustration of how to set roleAssumerWithWebIdentity with getDefaultRoleAssumerWithWebIdentity() can be found in the fromTokenFile SDK source code.
  • getDefaultRoleAssumerWithWebIdentity() does not make use of the AWS_REGION environment variable if one is set (see here)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

…DefaultRoleAssumerWithWebIdentity caller example
Copy link
Contributor

@kuhe kuhe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moving to #5104 due to conflict

nm, I've fixed the conflict here

@kuhe kuhe closed this Aug 17, 2023
@kuhe kuhe reopened this Aug 17, 2023
@kuhe kuhe merged commit 7196b68 into aws:main Aug 17, 2023
@github-actions
Copy link

github-actions bot commented Sep 1, 2023

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants