From e20ff788e9db349585f423a15c82938d52c900d6 Mon Sep 17 00:00:00 2001 From: siddsriv Date: Thu, 4 Apr 2024 18:33:07 +0000 Subject: [PATCH] chore(ec2-metadata-service): readme update to link to imds credentials method --- packages/ec2-metadata-service/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/ec2-metadata-service/README.md b/packages/ec2-metadata-service/README.md index 23baf67c7ae07..b36bda7100240 100644 --- a/packages/ec2-metadata-service/README.md +++ b/packages/ec2-metadata-service/README.md @@ -34,3 +34,5 @@ const metadata = await metadataService.request("/latest/meta-data/", {}); // req Note that by default, requests to IMDS are in accordance with [IMDSv2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html). Read more about Instance Metadata here: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html + +The @aws-sdk/ec2-metadata-service package is a standalone utility and not part of the default credential provider chain. If you want to use IMDS for credentials, you can use the [fromInstanceMetadata() method](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/Variable/fromInstanceMetadata/).