GH-1220 Document HTTP proxy configuration for AWS clients#1639
Open
BK202503 wants to merge 1 commit into
Open
Conversation
Add a subsection under "Customizing AWS Clients" in core.adoc that shows how to wire an HTTP proxy through `AwsSyncClientCustomizer` / `AwsAsyncClientCustomizer`. Covers both the Apache (synchronous) and Netty (asynchronous) HTTP clients in AWS SDK v2 — they live in different packages and have slightly different builder APIs (`endpoint(URI)` vs. `host(String) + port(int)`), which catches users migrating from Spring Cloud AWS 2.x where AWS SDK v1's `ClientConfiguration#setProxyHost` covered both. Notes `nonProxyHosts(Set<String>)` for excluding the EC2 instance metadata service (169.254.169.254), and points to the per-client customizer interfaces (e.g. `S3ClientCustomizer`) when only one integration needs to go through the proxy. Closes awspring#1220. Signed-off-by: BK202503 <199436087+BK202503@users.noreply.github.com>
BK202503
requested review from
MatejNedic,
maciejwalkowiak and
tomazfernandes
as code owners
June 24, 2026 14:39
github-actions
Bot
added
the
type: documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1220.
What
Adds a subsection under "Customizing AWS Clients" in
core.adocthat shows how to wire an HTTP proxy throughAwsSyncClientCustomizer/AwsAsyncClientCustomizer, with examples for both the Apache (sync) and Netty (async) HTTP clients in AWS SDK v2.Why
#1220 (opened by @maciejwalkowiak) flagged that proxy configuration is undocumented in Spring Cloud AWS 3.x. Users migrating from 2.x — where AWS SDK v1's
ClientConfiguration#setProxyHostcovered both sync and async — hit two specific gotchas that the docs now call out:ProxyConfigurationclasses live in different packages —software.amazon.awssdk.http.apache.ProxyConfigurationfor the sync (Apache) client andsoftware.amazon.awssdk.http.nio.netty.ProxyConfigurationfor the async (Netty) client.endpoint(URI), Netty takeshost(String)andport(int)separately.The section reuses the same code-block style as the surrounding "Customizing AWS Clients" examples and points at the per-client customizer interfaces (e.g.
S3ClientCustomizer) when only a single integration needs to go through the proxy.nonProxyHosts(Set<String>)is shown with169.254.169.254to call out the EC2 instance metadata service case.Validation
asciidoctor docs/src/main/asciidoc/core.adocrenders the file with zero warnings; the new subsection appears as<h4>nested under the existing<h3>"Customizing AWS Clients", with the GraalVM section unchanged as the next sibling.AI agent disclosure
I used an AI coding agent (Claude Code) to draft this docs section. I have read every line, verified the AWS SDK v2
ProxyConfigurationAPIs against the SDK Javadoc, confirmed the import paths match what other tests in the repo already use (software.amazon.awssdk.http.apache.ApacheHttpClientetc.), and will be the one responding to review.