Package software.amazon.awssdk.identity.spi

Interface IdentityProvider<IdentityT extends Identity>

All Known Subinterfaces:

AwsCredentialsProvider, HttpCredentialsProvider, SdkTokenProvider

All Known Implementing Classes:

AnonymousCredentialsProvider, AwsCredentialsProviderChain, ContainerCredentialsProvider, DefaultAwsTokenProvider, DefaultCredentialsProvider, EnvironmentVariableCredentialsProvider, InstanceProfileCredentialsProvider, LazyAwsCredentialsProvider, LazyTokenProvider, ProcessCredentialsProvider, ProfileCredentialsProvider, ProfileTokenProvider, SdkTokenProviderChain, SsoAccessTokenProvider, SsoCredentialsProvider, SsoOidcTokenProvider, StaticCredentialsProvider, StaticTokenProvider, StsAssumeRoleCredentialsProvider, StsAssumeRoleWithSamlCredentialsProvider, StsAssumeRoleWithWebIdentityCredentialsProvider, StsCredentialsProvider, StsGetFederationTokenCredentialsProvider, StsGetSessionTokenCredentialsProvider, StsWebIdentityTokenFileCredentialsProvider, SystemPropertyCredentialsProvider, SystemSettingsCredentialsProvider, WebIdentityTokenFileCredentialsProvider

@ThreadSafe
public interface IdentityProvider<IdentityT extends Identity>

Interface for loading Identity that is used for authentication.

Method Summary

Modifier and Type	Method	Description
Class<IdentityT>	identityType()	Retrieve the class of identity this identity provider produces.
default CompletableFuture<? extends IdentityT>	resolveIdentity()	Resolve the identity from this identity provider.
default CompletableFuture<? extends IdentityT>	resolveIdentity(Consumer<ResolveIdentityRequest.Builder> consumer)	Resolve the identity from this identity provider.
CompletableFuture<? extends IdentityT>	resolveIdentity(ResolveIdentityRequest request)	Resolve the identity from this identity provider.

Method Details

identityType

Class<IdentityT> identityType()

Retrieve the class of identity this identity provider produces. This is necessary for the SDK core to determine which identity provider should be used to resolve a specific type of identity.

resolveIdentity

CompletableFuture<? extends IdentityT> resolveIdentity(ResolveIdentityRequest request)

Resolve the identity from this identity provider.

Parameters:

request - The request to resolve an Identity

resolveIdentity

default CompletableFuture<? extends IdentityT> resolveIdentity(Consumer<ResolveIdentityRequest.Builder> consumer)

Resolve the identity from this identity provider. Similar to resolveIdentity(ResolveIdentityRequest), but takes a lambda to configure a new ResolveIdentityRequest.Builder. This removes the need to call ResolveIdentityRequest.builder() and SdkBuilder.build().

Parameters:

consumer - A Consumer to which an empty ResolveIdentityRequest.Builder will be given.

resolveIdentity

default CompletableFuture<? extends IdentityT> resolveIdentity()

Resolve the identity from this identity provider.