software.amazon.awssdk.services.sts.auth

Class StsAssumeRoleWithSamlCredentialsProvider

java.lang.Object

software.amazon.awssdk.services.sts.auth.StsAssumeRoleWithSamlCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

@ThreadSafe
public class StsAssumeRoleWithSamlCredentialsProvider
extends Object

An implementation of AwsCredentialsProvider that periodically sends a AssumeRoleWithSamlRequest to the AWS Security Token Service to maintain short-lived sessions to use for authentication. These sessions are updated asynchronously in the background as they get close to expiring. If the credentials are not successfully updated asynchronously in the background, calls to resolveCredentials() will begin to block in an attempt to update the credentials synchronously. 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(). This is created using builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StsAssumeRoleWithSamlCredentialsProvider.Builder A builder (created by builder()) for creating a StsAssumeRoleWithSamlCredentialsProvider.

Method Summary

Modifier and Type	Method and Description
static StsAssumeRoleWithSamlCredentialsProvider.Builder	builder() Create a builder for an StsAssumeRoleWithSamlCredentialsProvider.
void	close()
AwsCredentials	resolveCredentials() Returns AwsCredentials that can be used to authorize an AWS request.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static StsAssumeRoleWithSamlCredentialsProvider.Builder builder()

Create a builder for an StsAssumeRoleWithSamlCredentialsProvider.

toString

public String toString()

Overrides:

toString in class Object

resolveCredentials

public AwsCredentials resolveCredentials()

Description copied from interface: AwsCredentialsProvider

Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.

Specified by:

resolveCredentials in interface AwsCredentialsProvider

Returns:

AwsCredentials which the caller can use to authorize an AWS request.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable