Struct ProxyConfig 

pub struct ProxyConfig { /* private fields */ }

Proxy configuration for HTTP clients

Supports HTTP and HTTPS proxy configuration with authentication and bypass rules. Can be configured programmatically or automatically detected from environment variables.

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

// HTTP proxy for all traffic
let config = ProxyConfig::http("http://proxy.example.com:8080")?;

// HTTPS traffic through HTTP proxy (common case - no TLS needed for proxy connection)
let config = ProxyConfig::https("http://proxy.example.com:8080")?
    .with_basic_auth("username", "password")
    .no_proxy("localhost,*.internal");

// Detect from environment variables
let config = ProxyConfig::from_env();

Implementations

impl ProxyConfig

pub fn http<U>(proxy_url: U) -> Result<Self, ProxyError>

where U: TryInto<Uri>, U::Error: Display,

Create a new proxy configuration for HTTP traffic only

Arguments

• proxy_url - The HTTP proxy URL

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

let config = ProxyConfig::http("http://proxy.example.com:8080")?;

pub fn https<U>(proxy_url: U) -> Result<Self, ProxyError>

where U: TryInto<Uri>, U::Error: Display,

Create a new proxy configuration for HTTPS traffic only

This proxy will only be used for https:// requests. HTTP requests will connect directly unless a separate HTTP proxy is configured.

The proxy URL itself can use either HTTP or HTTPS scheme:

• http://proxy.example.com:8080 - Connect to proxy using HTTP (no TLS needed)
• https://proxy.example.com:8080 - Connect to proxy using HTTPS (TLS required)

Note: If the proxy URL itself uses HTTPS scheme, TLS support must be available when building the connector, otherwise connections will fail.

Arguments

• proxy_url - The proxy URL

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

// HTTPS traffic through HTTP proxy (no TLS needed for proxy connection)
let config = ProxyConfig::https("http://proxy.example.com:8080")?;

// HTTPS traffic through HTTPS proxy (TLS needed for proxy connection)
let config = ProxyConfig::https("https://secure-proxy.example.com:8080")?;

pub fn all<U>(proxy_url: U) -> Result<Self, ProxyError>

where U: TryInto<Uri>, U::Error: Display,

Create a new proxy configuration for all HTTP and HTTPS traffic

This proxy will be used for both http:// and https:// requests. This is equivalent to setting both HTTP and HTTPS proxies to the same URL.

Note: If the proxy URL itself uses HTTPS scheme, TLS support must be available when building the connector, otherwise connections will fail.

Arguments

• proxy_url - The proxy URL

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

let config = ProxyConfig::all("http://proxy.example.com:8080")?;

pub fn disabled() -> Self

Create a proxy configuration that disables all proxy usage

This is useful for explicitly disabling proxy support even when environment variables are set.

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

let config = ProxyConfig::disabled();

pub fn with_basic_auth<U, P>(self, username: U, password: P) -> Self

where U: Into<String>, P: Into<String>,

Add basic authentication to this proxy configuration

Arguments

• username - Username for proxy authentication
• password - Password for proxy authentication

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

let config = ProxyConfig::http("http://proxy.example.com:8080")?
    .with_basic_auth("username", "password");

pub fn no_proxy<S: AsRef<str>>(self, rules: S) -> Self

Add NO_PROXY rules to this configuration

NO_PROXY rules specify hosts that should bypass the proxy and connect directly.

Arguments

• rules - Comma-separated list of bypass rules

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

let config = ProxyConfig::http("http://proxy.example.com:8080")?
    .no_proxy("localhost,127.0.0.1,*.internal,10.0.0.0/8");

pub fn from_env() -> Self

Create proxy configuration from environment variables

Reads standard proxy environment variables:

• HTTP_PROXY / http_proxy: HTTP proxy URL
• HTTPS_PROXY / https_proxy: HTTPS proxy URL
• ALL_PROXY / all_proxy: Proxy for all protocols (fallback)
• NO_PROXY / no_proxy: Comma-separated bypass rules

If no proxy environment variables are set, this returns a configuration that won’t intercept any requests (equivalent to no proxy).

Examples

use aws_smithy_http_client::proxy::ProxyConfig;

// Always succeeds, even if no environment variables are set
let config = ProxyConfig::from_env();

pub fn is_disabled(&self) -> bool

Check if proxy is disabled (no proxy configuration)

pub fn is_from_env(&self) -> bool

Check if this configuration uses environment variables

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProxyConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.