Class StsGetSessionTokenCredentialsProvider.Builder
- java.lang.Object
-
- software.amazon.awssdk.services.sts.auth.StsCredentialsProvider.BaseBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
-
- software.amazon.awssdk.services.sts.auth.StsGetSessionTokenCredentialsProvider.Builder
-
- All Implemented Interfaces:
Buildable
,CopyableBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
,SdkBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
- Enclosing class:
- StsGetSessionTokenCredentialsProvider
@NotThreadSafe public static final class StsGetSessionTokenCredentialsProvider.Builder extends StsCredentialsProvider.BaseBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
A builder (created byStsGetSessionTokenCredentialsProvider.builder()
) for creating aStsGetSessionTokenCredentialsProvider
.
-
-
Constructor Summary
Constructors Constructor Description Builder(StsGetSessionTokenCredentialsProvider provider)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StsGetSessionTokenCredentialsProvider
build()
Build the credentials provider using the configuration applied to this builder.StsGetSessionTokenCredentialsProvider.Builder
refreshRequest(Consumer<GetSessionTokenRequest.Builder> getFederationTokenRequest)
Similar torefreshRequest(GetSessionTokenRequest)
, but takes a lambda to configure a newGetSessionTokenRequest.Builder
.StsGetSessionTokenCredentialsProvider.Builder
refreshRequest(GetSessionTokenRequest getSessionTokenRequest)
Configure theGetSessionTokenRequest
that should be periodically sent to the STS service to update the session token when it gets close to expiring.-
Methods inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider.BaseBuilder
asyncCredentialUpdateEnabled, prefetchTime, staleTime, stsClient
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation
-
-
-
-
Constructor Detail
-
Builder
public Builder(StsGetSessionTokenCredentialsProvider provider)
-
-
Method Detail
-
refreshRequest
public StsGetSessionTokenCredentialsProvider.Builder refreshRequest(GetSessionTokenRequest getSessionTokenRequest)
Configure theGetSessionTokenRequest
that should be periodically sent to the STS service to update the session token when it gets close to expiring. If this is not specified, default values are used.- Parameters:
getSessionTokenRequest
- The request to send to STS whenever the assumed session expires.- Returns:
- This object for chained calls.
-
refreshRequest
public StsGetSessionTokenCredentialsProvider.Builder refreshRequest(Consumer<GetSessionTokenRequest.Builder> getFederationTokenRequest)
Similar torefreshRequest(GetSessionTokenRequest)
, but takes a lambda to configure a newGetSessionTokenRequest.Builder
. This removes the need to calledGetSessionTokenRequest.builder()
andStsRequest.Builder.build()
.
-
build
public StsGetSessionTokenCredentialsProvider build()
Description copied from class:StsCredentialsProvider.BaseBuilder
Build the credentials provider using the configuration applied to this builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
- Overrides:
build
in classStsCredentialsProvider.BaseBuilder<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>
-
-