software.amazon.awssdk.services.sts.auth

Class StsAssumeRoleCredentialsProvider

java.lang.Object

software.amazon.awssdk.services.sts.auth.StsCredentialsProvider

software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, ToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,StsAssumeRoleCredentialsProvider>, SdkAutoCloseable

@ThreadSafe
public final class StsAssumeRoleCredentialsProvider
extends StsCredentialsProvider
implements ToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,StsAssumeRoleCredentialsProvider>

An implementation of AwsCredentialsProvider that periodically sends an AssumeRoleRequest 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 and Description
static class	StsAssumeRoleCredentialsProvider.Builder A builder (created by builder()) for creating a StsAssumeRoleCredentialsProvider.

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

Modifier and Type	Method and Description
static StsAssumeRoleCredentialsProvider.Builder	builder() Create a builder for an StsAssumeRoleCredentialsProvider.
protected AwsSessionCredentials	getUpdatedCredentials(StsClient stsClient) Implemented by a child class to call STS and get a new set of credentials to be used by this provider.
StsAssumeRoleCredentialsProvider.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.utils.builder.ToCopyableBuilder

copy

Method Detail

builder

public static StsAssumeRoleCredentialsProvider.Builder builder()

Create a builder for an StsAssumeRoleCredentialsProvider.

getUpdatedCredentials

protected AwsSessionCredentials getUpdatedCredentials(StsClient stsClient)

Description copied from class: StsCredentialsProvider

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

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public StsAssumeRoleCredentialsProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,StsAssumeRoleCredentialsProvider>