Package com.amazonaws.auth
Class InstanceProfileCredentialsProvider
java.lang.Object
com.amazonaws.auth.InstanceProfileCredentialsProvider
- All Implemented Interfaces:
AWSCredentialsProvider
Credentials provider implementation that loads credentials from the Amazon
EC2 Instance Metadata Service.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AWSCredentials
The current instance profile credentialsprotected Date
The expiration for the current instance profile credentialsprotected Date
The time of the last attempt to check for new credentials -
Constructor Summary
ConstructorsConstructorDescriptionInstanceProfileCredentialsProvider
(boolean refreshCredentialsAsync) Spins up a new thread to refresh the credentials asynchronously if refreshCredentialsAsync is set to true, otherwise the credentials will be refreshed from the instance metadata service synchronously, -
Method Summary
-
Field Details
-
credentials
The current instance profile credentials -
credentialsExpiration
The expiration for the current instance profile credentials -
lastInstanceProfileCheck
The time of the last attempt to check for new credentials
-
-
Constructor Details
-
InstanceProfileCredentialsProvider
public InstanceProfileCredentialsProvider() -
InstanceProfileCredentialsProvider
public InstanceProfileCredentialsProvider(boolean refreshCredentialsAsync) Spins up a new thread to refresh the credentials asynchronously if refreshCredentialsAsync is set to true, otherwise the credentials will be refreshed from the instance metadata service synchronously,- Parameters:
refreshCredentialsAsync
- true if credentials needs to be refreshed asynchronously else false.
-
-
Method Details
-
getCredentials
Description copied from interface:AWSCredentialsProvider
Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.- Specified by:
getCredentials
in interfaceAWSCredentialsProvider
- Returns:
- AWSCredentials which the caller can use to authorize an AWS request.
-
refresh
public void refresh()Description copied from interface:AWSCredentialsProvider
Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.- Specified by:
refresh
in interfaceAWSCredentialsProvider
-
needsToLoadCredentials
protected boolean needsToLoadCredentials() -
toString
-
finalize
-