com.amazonaws.auth

Class STSAssumeRoleWithWebIdentitySessionCredentialsProvider

java.lang.Object

com.amazonaws.auth.STSAssumeRoleWithWebIdentitySessionCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider, AWSSessionCredentialsProvider, Closeable, AutoCloseable

public class STSAssumeRoleWithWebIdentitySessionCredentialsProvider
extends Object
implements AWSSessionCredentialsProvider, Closeable

Migrating to the AWS SDK for Java v2

The v2 equivalent of this class is StsAssumeRoleWithWebIdentityCredentialsProvider

See Migration Guide for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	STSAssumeRoleWithWebIdentitySessionCredentialsProvider.Builder Provides a builder pattern to avoid combinatorial explosion of the number of parameters that are passed to constructors.

Method Summary

Modifier and Type	Method and Description
void	close() Shut down this credentials provider, shutting down the thread that performs asynchronous credential refreshing.
AWSSessionCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
void	refresh() Forces this credentials provider to refresh its credentials.

Methods inherited from class java.lang.Object

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

Method Detail

getCredentials

public AWSSessionCredentials getCredentials()

Description copied from interface: AWSCredentialsProvider

Returns AWSCredentials which the caller can use 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.

Specified by:

getCredentials in interface AWSCredentialsProvider

Specified by:

getCredentials in interface AWSSessionCredentialsProvider

Returns:

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

refresh

public void refresh()

Description copied from interface: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

Specified by:

refresh in interface AWSCredentialsProvider

close

public void close()

Shut down this credentials provider, shutting down the thread that performs asynchronous credential refreshing. This should not be invoked if the credentials provider is still in use by an AWS client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable