software.amazon.awssdk.services.sts.auth

Class StsWebIdentityTokenFileCredentialsProvider

java.lang.Object

software.amazon.awssdk.services.sts.auth.StsWebIdentityTokenFileCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

public final class StsWebIdentityTokenFileCredentialsProvider
extends Object

A credential provider that will read web identity token file path, aws role arn, aws session name from system properties or environment variables and StsClient for using web identity token credentials with STS

StsWebIdentityTokenFileCredentialsProvider allows passing of a custom StsClient at the time of instantiation of the provider. The user needs to make sure that this StsClient handles IdpCommunicationErrorException in retry policy.

This Web Identity Token File Credentials Provider extends StsCredentialsProvider that supports periodically updating session credentials. Refer StsCredentialsProvider for more details.

STWebIdentityTokenFileCredentialsProvider differs from StsWebIdentityTokenFileCredentialsProvider which is in sts package:

1. This Credentials Provider supports custom StsClient
2. This Credentials Provider supports periodically updating session credentials. Refer StsCredentialsProvider

If asyncCredentialUpdateEnabled is set to true then this provider creates a thread in the background to periodically update credentials. If this provider is no longer needed, the background thread can be shut down using close().

See Also:

StsCredentialsProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	StsCredentialsProvider.BaseBuilder<B extends StsCredentialsProvider.BaseBuilder<B,T>,T> Extended by child class's builders to share configuration across credential providers.
static class	StsWebIdentityTokenFileCredentialsProvider.Builder

Method Summary

Modifier and Type	Method and Description
static StsWebIdentityTokenFileCredentialsProvider.Builder	builder()
void	close()
protected Credentials	getUpdatedCredentials(StsClient stsClient) Implemented by a child class to call STS and get a new set of credentials to be used by this provider.
Duration	prefetchTime() The amount of time, relative to STS 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 STS token expiration, that the cached credentials are considered stale and should no longer be used.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static StsWebIdentityTokenFileCredentialsProvider.Builder builder()

resolveCredentials

public AwsCredentials resolveCredentials()

Specified by:

resolveCredentials in interface AwsCredentialsProvider

toString

public String toString()

Overrides:

toString in class Object

getUpdatedCredentials

protected Credentials getUpdatedCredentials(StsClient stsClient)

Implemented by a child class to call STS and get a new set of credentials to be used by this provider.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

staleTime

public Duration staleTime()

The amount of time, relative to STS 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 STS token expiration, that the cached credentials are considered close to stale and should be updated.