org.apache.hadoop.fs.s3a.auth

Class IAMInstanceCredentialsProvider

java.lang.Object

org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider

All Implemented Interfaces:

com.amazonaws.auth.AWSCredentialsProvider, Closeable, AutoCloseable

Direct Known Subclasses:

SharedInstanceCredentialProvider

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class IAMInstanceCredentialsProvider
extends Object
implements com.amazonaws.auth.AWSCredentialsProvider, Closeable

This is an IAM credential provider which wraps an EC2ContainerCredentialsProviderWrapper to provide credentials when the S3A connector is instantiated on AWS EC2 or the AWS container services.

When it fails to authenticate, it raises a NoAwsCredentialsException which can be recognized by retry handlers as a non-recoverable failure.

It is implicitly public; marked evolving as we can change its semantics.

Constructor Summary

Constructors

Constructor and Description
IAMInstanceCredentialsProvider()

Method Summary

Modifier and Type	Method and Description
void	close()
com.amazonaws.auth.AWSCredentials	getCredentials() Ask for the credentials.
void	refresh()

Methods inherited from class java.lang.Object

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

Constructor Detail

IAMInstanceCredentialsProvider

public IAMInstanceCredentialsProvider()

Method Detail

getCredentials

public com.amazonaws.auth.AWSCredentials getCredentials()

Ask for the credentials. Failure invariably means "you aren't running in an EC2 VM or AWS container".

Specified by:

getCredentials in interface com.amazonaws.auth.AWSCredentialsProvider

Returns:

the credentials

Throws:

NoAwsCredentialsException - on auth failure to indicate non-recoverable.

refresh

public void refresh()

Specified by:

refresh in interface com.amazonaws.auth.AWSCredentialsProvider

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException