chore(ec2-metadata-service): readme update to link to imds credential…

…s method
aws · Apr 4, 2024 · e20ff78 · e20ff78
1 parent c349825
commit e20ff78
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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/).