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(clients): document client-level profile configuration #6737

Merged
merged 4 commits into from
Dec 17, 2024
Merged

Conversation

kuhe
Copy link
Contributor

@kuhe kuhe commented Dec 16, 2024

documentation for #6728

@kuhe kuhe requested a review from a team as a code owner December 16, 2024 15:57
durationSeconds: 7200,
// Optional overrides. This is passed to an inner STS client
// instantiated to resolve the credentials. Region and profile
// are inherited from the upper client if present unless overridden.

Choose a reason for hiding this comment

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

Small point: I notice that the terms "upper", "inner", "parent" etc are used often in connection with clients. But as a user, they don't mean a lot to me. Is it possible to explain these things in another way?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added terminology section to these docs. I'll continue using these terms since they appear in the code as well. The terminology sections explains outer/inner is as data/credentials.

I can't always say data client since that can clash with data-plane control-plane client terminology.

@kuhe kuhe merged commit 0e65e09 into main Dec 17, 2024
2 checks passed
@kuhe kuhe deleted the kuhe-patch-1 branch December 17, 2024 17:21
Copy link

github-actions bot commented Jan 2, 2025

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 Jan 2, 2025
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.

3 participants