Interface AwsCredentialsProvider
-
- All Superinterfaces:
IdentityProvider<AwsCredentialsIdentity>
- All Known Subinterfaces:
HttpCredentialsProvider
- All Known Implementing Classes:
AnonymousCredentialsProvider
,AwsCredentialsProviderChain
,ContainerCredentialsProvider
,DefaultCredentialsProvider
,EnvironmentVariableCredentialsProvider
,InstanceProfileCredentialsProvider
,LazyAwsCredentialsProvider
,ProcessCredentialsProvider
,ProfileCredentialsProvider
,StaticCredentialsProvider
,SystemPropertyCredentialsProvider
,SystemSettingsCredentialsProvider
,WebIdentityTokenFileCredentialsProvider
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface AwsCredentialsProvider extends IdentityProvider<AwsCredentialsIdentity>
Interface for loadingAwsCredentials
that are used for authentication.Commonly-used implementations include
StaticCredentialsProvider
for a fixed set of credentials and theDefaultCredentialsProvider
for discovering credentials from the host's environment. The AWS Security Token Service (STS) client also provides implementations of this interface for loading temporary, limited-privilege credentials from AWS STS.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Class<AwsCredentialsIdentity>
identityType()
AwsCredentials
resolveCredentials()
ReturnsAwsCredentials
that can be used to authorize an AWS request.default CompletableFuture<AwsCredentialsIdentity>
resolveIdentity(ResolveIdentityRequest request)
-
Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider
resolveIdentity, resolveIdentity
-
-
-
-
Method Detail
-
resolveCredentials
AwsCredentials resolveCredentials()
ReturnsAwsCredentials
that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can choose 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.If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.
- Returns:
- AwsCredentials which the caller can use to authorize an AWS request.
-
identityType
default Class<AwsCredentialsIdentity> identityType()
- Specified by:
identityType
in interfaceIdentityProvider<AwsCredentialsIdentity>
-
resolveIdentity
default CompletableFuture<AwsCredentialsIdentity> resolveIdentity(ResolveIdentityRequest request)
- Specified by:
resolveIdentity
in interfaceIdentityProvider<AwsCredentialsIdentity>
-
-