@ThreadSafe public final class StsAssumeRoleCredentialsProvider extends StsCredentialsProvider implements ToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,StsAssumeRoleCredentialsProvider>
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()
.Modifier and Type | Class and Description |
---|---|
static class |
StsAssumeRoleCredentialsProvider.Builder
A builder (created by
builder() ) for creating a
StsAssumeRoleCredentialsProvider . |
StsCredentialsProvider.BaseBuilder<B extends StsCredentialsProvider.BaseBuilder<B,T>,T extends ToCopyableBuilder<B,T>>
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() |
close, prefetchTime, resolveCredentials, staleTime
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
copy
identityType, resolveIdentity
resolveIdentity, resolveIdentity
public static StsAssumeRoleCredentialsProvider.Builder builder()
StsAssumeRoleCredentialsProvider
.protected AwsSessionCredentials getUpdatedCredentials(StsClient stsClient)
StsCredentialsProvider
public StsAssumeRoleCredentialsProvider.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StsAssumeRoleCredentialsProvider.Builder,StsAssumeRoleCredentialsProvider>
Copyright © 2023. All rights reserved.