Package software.amazon.awssdk.services.sso.auth

Class SsoCredentialsProvider

java.lang.Object

software.amazon.awssdk.services.sso.auth.SsoCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, IdentityProvider<AwsCredentialsIdentity>, ToCopyableBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>, SdkAutoCloseable

@SdkPublicApi
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

Nested Classes

Modifier and Type	Class	Description
static interface	SsoCredentialsProvider.Builder	A builder for creating a custom SsoCredentialsProvider.
protected static final class	SsoCredentialsProvider.BuilderImpl

Method Summary

Modifier and Type	Method	Description
static SsoCredentialsProvider.BuilderImpl	builder()	Get a builder for creating a custom SsoCredentialsProvider.
void	close()
Duration	prefetchTime()	The amount of time, relative to session token expiration, that the cached credentials are considered close to stale and should be updated.
AwsCredentials	resolveCredentials()
Duration	staleTime()	The amount of time, relative to session token expiration, that the cached credentials are considered stale and should no longer be used.
SsoCredentialsProvider.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

public Duration 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

public Duration 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 SsoCredentialsProvider.BuilderImpl builder()

Get a builder for creating a custom SsoCredentialsProvider.

resolveCredentials

public AwsCredentials resolveCredentials()

Specified by:

resolveCredentials in interface AwsCredentialsProvider

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

toBuilder

public SsoCredentialsProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>