StsWebIdentityTokenFileCredentialsProvider (AWS Java SDK :: Services :: AWS STS 2.25.12 API)

java.lang.Object
- software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
- - software.amazon.awssdk.services.sts.auth.StsWebIdentityTokenFileCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, IdentityProvider<AwsCredentialsIdentity>, ToCopyableBuilder<StsWebIdentityTokenFileCredentialsProvider.Builder,StsWebIdentityTokenFileCredentialsProvider>, SdkAutoCloseable
```
public final class StsWebIdentityTokenFileCredentialsProvider
extends StsCredentialsProvider
implements ToCopyableBuilder<StsWebIdentityTokenFileCredentialsProvider.Builder,StsWebIdentityTokenFileCredentialsProvider>
```
An implementation of AwsCredentialsProvider that periodically sends an AssumeRoleWithWebIdentityRequest to the AWS Security Token Service to maintain short-lived sessions to use for authentication. These sessions are updated using a single calling thread (by default) or asynchronously (if StsCredentialsProvider.BaseBuilder.asyncCredentialUpdateEnabled(Boolean) is set). Unlike StsAssumeRoleWithWebIdentityCredentialsProvider, this reads the web identity information, including AWS role ARN, AWS session name and the location of a web identity token file from system properties and environment variables. The web identity token file is expected to contain the web identity token to use with each request. If the credentials are not successfully updated before expiration, calls to resolveCredentials() will block until they are updated successfully. Users of this provider must StsCredentialsProvider.close() it when they are finished using it. This is created using builder().

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StsWebIdentityTokenFileCredentialsProvider.Builder
- Nested classes/interfaces inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
  StsCredentialsProvider.BaseBuilder<B extends StsCredentialsProvider.BaseBuilder<B,T>,T extends ToCopyableBuilder<B,T>>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StsWebIdentityTokenFileCredentialsProvider.Builder`	`builder()`
`protected AwsSessionCredentials`	`getUpdatedCredentials(StsClient stsClient)`
`AwsCredentials`	`resolveCredentials()`
`StsWebIdentityTokenFileCredentialsProvider.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
close, prefetchTime, staleTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 Detail
  - builder
```
public static StsWebIdentityTokenFileCredentialsProvider.Builder builder()
```
  - resolveCredentials
```
public AwsCredentials resolveCredentials()
```
    Specified by:
    
    resolveCredentials in interface AwsCredentialsProvider
    
    Overrides:
    
    resolveCredentials in class StsCredentialsProvider
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getUpdatedCredentials
```
protected AwsSessionCredentials getUpdatedCredentials(StsClient stsClient)
```
  - toBuilder
```
public StsWebIdentityTokenFileCredentialsProvider.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StsWebIdentityTokenFileCredentialsProvider.Builder,StsWebIdentityTokenFileCredentialsProvider>