Class SsoCredentialsProvider
java.lang.Object
software.amazon.awssdk.services.sso.auth.SsoCredentialsProvider
- All Implemented Interfaces:
AutoCloseable
,AwsCredentialsProvider
,IdentityProvider<AwsCredentialsIdentity>
,ToCopyableBuilder<SsoCredentialsProvider.Builder,
,SsoCredentialsProvider> SdkAutoCloseable
public final class SsoCredentialsProvider
extends Object
implements AwsCredentialsProvider, SdkAutoCloseable, ToCopyableBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>
An implementation of
AwsCredentialsProvider
that periodically sends a GetRoleCredentialsRequest
to the AWS
Single Sign-On Service to maintain short-lived sessions to use for authentication. These sessions are updated using a single
calling thread (by default) or asynchronously (if SsoCredentialsProvider.Builder.asyncCredentialUpdateEnabled(Boolean)
is set).
If the credentials are not successfully updated before expiration, calls to resolveCredentials()
will block until
they are updated successfully.
Users of this provider must close()
it when they are finished using it.
This is created using builder()
.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A builder for creating a customSsoCredentialsProvider
. -
Method Summary
Modifier and TypeMethodDescriptionstatic software.amazon.awssdk.services.sso.auth.SsoCredentialsProvider.BuilderImpl
builder()
Get a builder for creating a customSsoCredentialsProvider
.void
close()
The amount of time, relative to session token expiration, that the cached credentials are considered close to stale and should be updated.ReturnsAwsCredentials
that can be used to authorize an AWS request.The amount of time, relative to session token expiration, that the cached credentials are considered stale and should no longer be used.Take this object and create a builder that contains all of the current property values of this object.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.auth.credentials.AwsCredentialsProvider
identityType, resolveIdentity
Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider
resolveIdentity, resolveIdentity
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
staleTime
The amount of time, relative to session token expiration, that the cached credentials are considered stale and should no longer be used. All threads will block until the value is updated. -
prefetchTime
The amount of time, relative to session token expiration, that the cached credentials are considered close to stale and should be updated. -
builder
public static software.amazon.awssdk.services.sso.auth.SsoCredentialsProvider.BuilderImpl builder()Get a builder for creating a customSsoCredentialsProvider
. -
resolveCredentials
Description copied from interface:AwsCredentialsProvider
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.
- Specified by:
resolveCredentials
in interfaceAwsCredentialsProvider
- Returns:
- AwsCredentials which the caller can use to authorize an AWS request.
-
close
public void close()Description copied from interface:SdkAutoCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSdkAutoCloseable
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SsoCredentialsProvider.Builder,
SsoCredentialsProvider> - Returns:
- a builder for type T
-