software.amazon.awssdk.imds.internal

Class DefaultEc2MetadataClient

java.lang.Object

software.amazon.awssdk.imds.internal.BaseEc2MetadataClient

software.amazon.awssdk.imds.internal.DefaultEc2MetadataClient

All Implemented Interfaces:

AutoCloseable, Ec2MetadataClient, SdkAutoCloseable

@Immutable
 @ThreadSafe
public final class DefaultEc2MetadataClient
extends BaseEc2MetadataClient
implements Ec2MetadataClient

An Implementation of the Ec2Metadata Interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultEc2MetadataClient.Ec2MetadataBuilder

Nested classes/interfaces inherited from interface software.amazon.awssdk.imds.Ec2MetadataClient

Ec2MetadataClient.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.imds.internal.BaseEc2MetadataClient

DEFAULT_TOKEN_TTL, endpoint, IMDS_HTTP_DEFAULTS, requestMarshaller, retryPolicy, tokenTtl

Method Summary

Modifier and Type	Method and Description
static DefaultEc2MetadataClient.Ec2MetadataBuilder	builder() Creates a default builder for Ec2MetadataClient.
void	close()
Ec2MetadataResponse	get(String path) Gets the specified instance metadata value by the given path.

Methods inherited from class software.amazon.awssdk.imds.internal.BaseEc2MetadataClient

shouldRetry, uncheckedInputStreamToUtf8

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.imds.Ec2MetadataClient

create

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

builder

public static DefaultEc2MetadataClient.Ec2MetadataBuilder builder()

Description copied from interface: Ec2MetadataClient

Creates a default builder for Ec2MetadataClient.

Specified by:

builder in interface Ec2MetadataClient

get

public Ec2MetadataResponse get(String path)

Gets the specified instance metadata value by the given path. Will retry base on the retry policy provided, in the case of an IOException during request. Will not retry on SdkClientException, like 4XX HTTP error.

Specified by:

get in interface Ec2MetadataClient

Parameters:

path - Input path of the resource to get.

Returns:

Instance metadata value as part of MetadataResponse Object

Throws:

SdkClientException - if the request for a token or the request for the Metadata does not have a 2XX SUCCESS response, if the maximum number of retries is reached, or if another IOException is thrown during the request.