All Known Subinterfaces:

AWSSessionCredentialsProvider

All Known Implementing Classes:

AWSCredentialsProviderChain, AWSStaticCredentialsProvider, ClasspathPropertiesFileCredentialsProvider, ContainerCredentialsProvider, DefaultAWSCredentialsProviderChain, EC2ContainerCredentialsProviderWrapper, EnvironmentVariableCredentialsProvider, InstanceProfileCredentialsProvider, ProcessCredentialsProvider, ProfileAssumeRoleCredentialsProvider, ProfileCredentialsProvider, ProfileProcessCredentialsProvider, ProfileStaticCredentialsProvider, PropertiesFileCredentialsProvider, StaticCredentialsProvider, STSAssumeRoleSessionCredentialsProvider, STSAssumeRoleWithWebIdentitySessionCredentialsProvider, STSProfileCredentialsServiceProvider, STSSessionCredentialsProvider, SystemPropertiesCredentialsProvider, WebIdentityFederationSessionCredentialsProvider, WebIdentityTokenCredentialsProvider

public interface AWSCredentialsProvider

• Method Summary

  All Methods

  Modifier and Type	Method and 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.

• Method Detail

  • getCredentials

    AWSCredentials getCredentials()

    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.

    Returns:

    AWSCredentials which the caller can use to authorize an AWS request.

  • refresh

    void refresh()

    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.