StsAssumeRoleWithSamlCredentialsProvider (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.StsAssumeRoleWithSamlCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, IdentityProvider<AwsCredentialsIdentity>, ToCopyableBuilder<StsAssumeRoleWithSamlCredentialsProvider.Builder,StsAssumeRoleWithSamlCredentialsProvider>, SdkAutoCloseable
```
@ThreadSafe
public final class StsAssumeRoleWithSamlCredentialsProvider
extends StsCredentialsProvider
implements ToCopyableBuilder<StsAssumeRoleWithSamlCredentialsProvider.Builder,StsAssumeRoleWithSamlCredentialsProvider>
```
An implementation of AwsCredentialsProvider that periodically sends an AssumeRoleWithSamlRequest 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). If the credentials are not successfully updated before expiration, calls to StsCredentialsProvider.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`	`StsAssumeRoleWithSamlCredentialsProvider.Builder`	A builder (created by `builder()`) for creating a `StsAssumeRoleWithSamlCredentialsProvider`.

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 StsAssumeRoleWithSamlCredentialsProvider.Builder`	`builder()`	Create a builder for an `StsAssumeRoleWithSamlCredentialsProvider`.
`protected AwsSessionCredentials`	`getUpdatedCredentials(StsClient stsClient)`
`StsAssumeRoleWithSamlCredentialsProvider.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
close, prefetchTime, resolveCredentials, 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 StsAssumeRoleWithSamlCredentialsProvider.Builder builder()
```
    Create a builder for an StsAssumeRoleWithSamlCredentialsProvider.
  - getUpdatedCredentials
```
protected AwsSessionCredentials getUpdatedCredentials(StsClient stsClient)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public StsAssumeRoleWithSamlCredentialsProvider.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StsAssumeRoleWithSamlCredentialsProvider.Builder,StsAssumeRoleWithSamlCredentialsProvider>