Class StsAssumeRoleCredentialsProvider
java.lang.Object
software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider
- All Implemented Interfaces:
AutoCloseable
,AwsCredentialsProvider
,IdentityProvider<AwsCredentialsIdentity>
,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
Modifier and TypeClassDescriptionstatic final class
A builder (created bybuilder()
) for creating aStsAssumeRoleCredentialsProvider
.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 TypeMethodDescriptionbuilder()
Create a builder for anStsAssumeRoleCredentialsProvider
.Take this object and create a builder that contains all of the current property values of this object.toString()
Methods inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider
close, prefetchTime, resolveCredentials, staleTime
Methods inherited from class java.lang.Object
equals, 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 Details
-
builder
Create a builder for anStsAssumeRoleCredentialsProvider
. -
toString
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,
StsAssumeRoleCredentialsProvider> - Returns:
- a builder for type T
-