From 77f99ff065bdcf4733fa354a4741b3bc1f6b4316 Mon Sep 17 00:00:00 2001 From: George Fu Date: Tue, 2 Sep 2025 12:36:37 -0400 Subject: [PATCH] docs(credential-providers): remove unnecessary STS header documentation --- packages/credential-providers/README.md | 29 ------------------------- 1 file changed, 29 deletions(-) diff --git a/packages/credential-providers/README.md b/packages/credential-providers/README.md index 32cb9218a7d22..4b04e81be3c51 100644 --- a/packages/credential-providers/README.md +++ b/packages/credential-providers/README.md @@ -948,35 +948,6 @@ new S3({ }); ``` -## Add Custom Headers to STS assume-role calls - -You can specify the plugins--groups of middleware, to inject to the STS client. -For example, you can inject custom headers to each STS assume-role calls. It's -available in [`fromTemporaryCredentials()`](#fromtemporarycredentials), -[`fromWebToken()`](#fromwebtoken), [`fromTokenFile()`](#fromtokenfile), [`fromIni()`](#fromini). - -Code example: - -```javascript -const addConfusedDeputyMiddleware = (next) => (args) => { - args.request.headers["x-amz-source-account"] = account; - args.request.headers["x-amz-source-arn"] = sourceArn; - return next(args); -}; -const confusedDeputyPlugin = { - applyToStack: (stack) => { - stack.add(addConfusedDeputyMiddleware, { step: "finalizeRequest" }); - }, -}; -const provider = fromTemporaryCredentials({ - // Required. Options passed to STS AssumeRole operation. - params: { - RoleArn: "arn:aws:iam::1234567890:role/Role", - }, - clientPlugins: [confusedDeputyPlugin], -}); -``` - [getcredentialsforidentity_api]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html [getid_api]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html [assumerole_api]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html