Package com.amazonaws.auth
Class EnvironmentVariableCredentialsProvider
- java.lang.Object
-
- com.amazonaws.auth.EnvironmentVariableCredentialsProvider
-
- All Implemented Interfaces:
AWSCredentialsProvider
public class EnvironmentVariableCredentialsProvider extends Object implements AWSCredentialsProvider
AWSCredentialsProvider
implementation that provides credentials by looking at the:AWS_ACCESS_KEY_ID
(orAWS_ACCESS_KEY
) andAWS_SECRET_KEY
(orAWS_SECRET_ACCESS_KEY
) environment variables.
-
-
Constructor Summary
Constructors Constructor Description EnvironmentVariableCredentialsProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AWSCredentials
getCredentials()
Returns AWSCredentials which the caller can use to authorize an AWS request.void
refresh()
Forces this credentials provider to refresh its credentials.String
toString()
-
-
-
Method Detail
-
getCredentials
public AWSCredentials 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
-
-