Class StsGetSessionTokenCredentialsProvider
- java.lang.Object
-
- software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
-
- software.amazon.awssdk.services.sts.auth.StsGetSessionTokenCredentialsProvider
-
- All Implemented Interfaces:
AutoCloseable
,AwsCredentialsProvider
,IdentityProvider<AwsCredentialsIdentity>
,ToCopyableBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
,SdkAutoCloseable
@ThreadSafe public class StsGetSessionTokenCredentialsProvider extends StsCredentialsProvider implements ToCopyableBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
An implementation ofAwsCredentialsProvider
that periodically sends aGetSessionTokenRequest
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 (ifStsCredentialsProvider.BaseBuilder.asyncCredentialUpdateEnabled(Boolean)
is set). If the credentials are not successfully updated before expiration, calls toStsCredentialsProvider.resolveCredentials()
will block until they are updated successfully. Users of this provider mustStsCredentialsProvider.close()
it when they are finished using it. This is created usingbuilder()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StsGetSessionTokenCredentialsProvider.Builder
A builder (created bybuilder()
) for creating aStsGetSessionTokenCredentialsProvider
.-
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 StsGetSessionTokenCredentialsProvider.Builder
builder()
Create a builder for anStsGetSessionTokenCredentialsProvider
.protected AwsSessionCredentials
getUpdatedCredentials(StsClient stsClient)
StsGetSessionTokenCredentialsProvider.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 StsGetSessionTokenCredentialsProvider.Builder builder()
Create a builder for anStsGetSessionTokenCredentialsProvider
.
-
getUpdatedCredentials
protected AwsSessionCredentials getUpdatedCredentials(StsClient stsClient)
-
toBuilder
public StsGetSessionTokenCredentialsProvider.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
-
-