archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-02-01 16:07:28 +00:00
Code Issues Projects Releases Wiki Activity

chore: add docstrings to addProxyToAwsClient (#13280)

Browse Source 
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Tomasz Czubocha <tomasz.czubocha@gmail.com>
This commit is contained in:
coderabbitai[bot] 2026-01-20 17:54:40 +00:00 committed by GitHub
parent 1da1bb5a02
commit f15ac17dc2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
packages/util/src/proxy/aws.js
View File

@ -162,17 +162,14 @@ function buildProxyOptionsFromEnv(overrides = {}) {
}
/**
* Adds proxy (and optional CA/cafile) support to an AWS SDK v3 client using aws-sdk-v3-proxy,
* while honoring additional environment variables:
* - proxy, HTTP_PROXY, http_proxy, HTTPS_PROXY, https_proxy
* - NO_PROXY, no_proxy (bypasses proxy for matching hosts)
* - ca, HTTPS_CA, https_ca (PEM content)
* - cafile, HTTPS_CAFILE, https_cafile (path to PEM file)
* Augments an AWS SDK v3 client with proxy support and optional CA configuration derived from environment variables or explicit overrides.
*
* Honors environment-driven proxy configuration (HTTP_PROXY/HTTPS_PROXY/HTTP/HTTPS proxy, generic proxy), CA/cafile values, NO_PROXY/no_proxy bypass rules, and applies a build-time custom User-Agent when available.
*
* @template T
* @param {T} client - An instance of an AWS SDK v3 client
* @param {object} [options] - Optional overrides passed to aws-sdk-v3-proxy
* @returns {T} The same client, enhanced with proxy support if applicable
* @param {T} client - An AWS SDK v3 client instance to enhance.
* @param {object} [options] - Overrides for proxy behavior passed to aws-sdk-v3-proxy.
* @returns {T} The same client instance, enhanced to use the configured proxy and TLS options when applicable.
*/
export function addProxyToAwsClient(client, options = {}) {
// Add custom user-agent to identify Serverless Framework requests