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

Clarify that non-aws-config based config Builders don't have good defaults #1226

Open
Mark-Simulacrum opened this issue Dec 20, 2024 · 0 comments
Labels
documentation This is a problem with documentation needs-triage This issue or PR still needs to be triaged.

Comments

@Mark-Simulacrum
Copy link

Describe the issue

Customers using e.g. aws_sdk_sts::config::Builder::new() and customizing a few settings (e.g., credential provider) don't currently receive defaults for other fields, such as the retry policy.

Ideally we'd have strong warnings against usage of these methods in favor of the aws-config constructors, and potentially consider some stronger messaging (e.g., deprecating in favor of without_defaults() or similarly less "easy to use" methods). Note that there's a bunch of ways to get such a builder today:

Each should likely have similar treatment. The docs on the Config struct also say:

The service config can also be constructed manually using its builder.

Which probably should be clarified to say "and this is almost certainly not what you want".

Links

(Also present in every other SDK):

@Mark-Simulacrum Mark-Simulacrum added documentation This is a problem with documentation needs-triage This issue or PR still needs to be triaged. labels Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Development

No branches or pull requests

1 participant