docs: add comment about clientConfig

aws · Apr 26, 2024 · 5b7b4a0 · 5b7b4a0
1 parent 9de6c47
commit 5b7b4a0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/credential-provider-ini/src/fromIni.ts b/packages/credential-provider-ini/src/fromIni.ts
@@ -38,7 +38,12 @@ export interface FromIniInit extends SourceProfileInit, CredentialProviderOption
    */
   roleAssumerWithWebIdentity?: (params: AssumeRoleWithWebIdentityParams) => Promise<AwsCredentialIdentity>;
 
-  clientConfig?: any; // STSClientConfig;
+  /**
+   * STSClientConfig to be used for creating STS Client for assuming role.
+   * @internal
+   */
+  clientConfig?: any;
+
   clientPlugins?: Pluggable<any, any>[];
 }
 

diff --git a/packages/credential-provider-web-identity/src/fromWebToken.ts b/packages/credential-provider-web-identity/src/fromWebToken.ts
@@ -136,9 +136,10 @@ export interface FromWebTokenInit
   roleAssumerWithWebIdentity?: (params: AssumeRoleWithWebIdentityParams) => Promise<AwsCredentialIdentity>;
 
   /**
+   * STSClientConfig to be used for creating STS Client for assuming role.
    * @internal
    */
-  clientConfig?: any; // STSClientConfig;
+  clientConfig?: any;
 
   /**
    * @internal