From 497105f477c36acc275630e3eedb3c318e50562d Mon Sep 17 00:00:00 2001
From: David Souther <davidsouther+github@gmail.com>
Date: Wed, 17 Jul 2024 11:57:17 -0400
Subject: [PATCH] docs(credential-providers): update fromNodeProviderChain.ts
 docblock (#6086)

Clarify documentation on how init properties are used in fromNodeProviderChain
---
 .../credential-providers/src/fromNodeProviderChain.ts     | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/packages/credential-providers/src/fromNodeProviderChain.ts b/packages/credential-providers/src/fromNodeProviderChain.ts
index 2c39f9feaa65..efcbf3184a84 100644
--- a/packages/credential-providers/src/fromNodeProviderChain.ts
+++ b/packages/credential-providers/src/fromNodeProviderChain.ts
@@ -15,9 +15,15 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
  * // const { fromNodeProviderChain } = require("@aws-sdk/credential-providers") // CommonJS import
  *
  * const credentialProvider = fromNodeProviderChain({
- *   //...any input of fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
+ *   // init properties for fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
  *   // fromProcess(), fromInstanceMetadata(), fromContainerMetadata()
  *
+ *   // For instance, to ignore the ini shared cache, change the credentials filepath for all
+ *   // providers, and set the sso start id:
+ *   ignoreCache: true,
+ *   filepath: "~/.config/aws/credentials",
+ *   ssoStartUrl: "https://d-abc123.awsapps.com/start"
+ *
  *   // Optional. Custom STS client configurations overriding the default ones.
  *   clientConfig: { region },
  *   // Optional. Custom STS client middleware plugin to modify the client default behavior.