Package software.amazon.awssdk.crt.auth.credentials

Class CredentialsProvider

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.auth.credentials.CredentialsProvider

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

CachedCredentialsProvider, CognitoCredentialsProvider, DefaultChainCredentialsProvider, DelegateCredentialsProvider, EcsCredentialsProvider, ProfileCredentialsProvider, StaticCredentialsProvider, StsCredentialsProvider, StsWebIdentityCredentialsProvider, X509CredentialsProvider

public class CredentialsProvider
extends CrtResource

A base class that represents a source of AWS credentials

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

CrtResource.ResourceInstance

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<Credentials>	getCredentials()	Request credentials from the provider
java.util.concurrent.CompletableFuture<java.lang.Void>	getShutdownCompleteFuture()	Learn when this object has finished shutting down.

Methods inherited from class software.amazon.awssdk.crt.CrtResource

addRef, addReferenceTo, close, collectNativeResource, collectNativeResources, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, logNativeResources, removeReferenceTo, setDescription, waitForNoResources

Methods inherited from class java.lang.Object

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

Method Detail

getCredentials

public java.util.concurrent.CompletableFuture<Credentials> getCredentials()

Request credentials from the provider

Returns:

A Future for Credentials that will be completed when they are acquired.

getShutdownCompleteFuture

public java.util.concurrent.CompletableFuture<java.lang.Void> getShutdownCompleteFuture()

Learn when this object has finished shutting down.

Returns:

future that completes when all of this object's native resources have shut down or released properly.