IMDS client
SDKs implement an Instance Metadata Service Version 2 (IMDSv2) client using session-oriented requests. For more information on IMDSv2, see Use IMDSv2 in the Amazon EC2 User Guide. The IMDS client is configurable via a client configuration object available in the SDK code base.
Configure this functionality by using the following:
retries- client configuration object member-
The number of additional retry attempts for any failed request.
Default value: 3
Valid values: Number greater than 0.
port- client configuration object member-
The port for the endpoint.
Default value: 80
Valid values: Number.
token_ttl- client configuration object member-
The TTL of the token.
Default value: 21,600 seconds (6 hours, the maximum time allotted).
Valid values: Number.
endpoint- client configuration object member-
The endpoint of IMDS.
Default value: If
endpoint_modeequalsIPv4, then default endpoint ishttp://169.254.169.254. Ifendpoint_modeequalsIPv6, then default endpoint ishttp://[fd00:ec2::254].Valid values: Valid URI.
The following options are supported by most SDKs. See your specific SDK code base for details.
endpoint_mode- client configuration object member-
The endpoint mode of IMDS.
Default value:
IPv4Valid values:
IPv4,IPv6 http_open_timeout- client configuration object member (name may vary)-
The number of seconds to wait for the connection to open.
Default value: 1 second.
Valid values: Number greater than 0.
http_read_timeout- client configuration object member (name may vary)-
The number of seconds for one chunk of data to be read.
Default value: 1 second.
Valid values: Number greater than 0.
http_debug_output- client configuration object member (name may vary)-
Sets an output stream for debugging.
Default value: None.
Valid values: A valid I/O stream, like STDOUT.
backoff- client configuration object member (name may vary)-
The number of seconds to sleep in between retries or a customer provided backoff function to call. This overrides the default exponential backoff strategy.
Default value: Varies by SDK.
Valid values: Varies by SDK. Can be either a numeric value or a call out to a custom function.
Compatibility with AWS SDKs
The following SDKs support the features and settings described in this topic. Any partial exceptions are noted. Any JVM system property settings are supported by the AWS SDK for Java and the AWS SDK for Kotlin only.
| SDK | Supported | Notes or more information |
|---|---|---|
| AWS CLI v2 | Yes | |
| SDK for C++ | No | |
| SDK for Go V2 (1.x) |
Yes | |
| SDK for Go 1.x (V1) | Yes | |
| SDK for Java 2.x | Yes | |
| SDK for Java 1.x | Yes | |
| SDK for JavaScript 3.x | Yes | |
| SDK for JavaScript 2.x | Yes | |
| SDK for Kotlin | No | |
| SDK for .NET 3.x | Yes | |
| SDK for PHP 3.x | Yes | |
| SDK for Python (Boto3) |
Yes | |
| SDK for Ruby 3.x | Yes | |
| SDK for Rust | Yes | |
| SDK for Swift | Yes | |
| Tools for PowerShell | Yes |
