Interface WebIdentityTokenFileCredentialsProvider.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<WebIdentityTokenFileCredentialsProvider.Builder,WebIdentityTokenFileCredentialsProvider>
,SdkBuilder<WebIdentityTokenFileCredentialsProvider.Builder,WebIdentityTokenFileCredentialsProvider>
- Enclosing class:
- WebIdentityTokenFileCredentialsProvider
public static interface WebIdentityTokenFileCredentialsProvider.Builder extends CopyableBuilder<WebIdentityTokenFileCredentialsProvider.Builder,WebIdentityTokenFileCredentialsProvider>
A builder for creating a customWebIdentityTokenFileCredentialsProvider
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebIdentityTokenFileCredentialsProvider.Builder
asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)
Define whether the provider should fetch credentials asynchronously in the background.WebIdentityTokenFileCredentialsProvider
build()
Create aWebIdentityTokenFileCredentialsProvider
using the configuration applied to this builder.WebIdentityTokenFileCredentialsProvider.Builder
prefetchTime(Duration prefetchTime)
Configure the amount of time, relative to STS token expiration, that the cached credentials are considered close to stale and should be updated.WebIdentityTokenFileCredentialsProvider.Builder
roleArn(String roleArn)
Define the role arn that should be used by this credentials provider.WebIdentityTokenFileCredentialsProvider.Builder
roleSessionDuration(Duration sessionDuration)
WebIdentityTokenFileCredentialsProvider.Builder
roleSessionName(String roleSessionName)
Define the role session name that should be used by this credentials provider.WebIdentityTokenFileCredentialsProvider.Builder
staleTime(Duration staleTime)
Configure the amount of time, relative to STS token expiration, that the cached credentials are considered stale and must be updated.WebIdentityTokenFileCredentialsProvider.Builder
webIdentityTokenFile(Path webIdentityTokenFile)
Define the absolute path to the web identity token file that should be used by this credentials provider.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation
-
-
-
-
Method Detail
-
roleArn
WebIdentityTokenFileCredentialsProvider.Builder roleArn(String roleArn)
Define the role arn that should be used by this credentials provider.
-
roleSessionName
WebIdentityTokenFileCredentialsProvider.Builder roleSessionName(String roleSessionName)
Define the role session name that should be used by this credentials provider.
-
webIdentityTokenFile
WebIdentityTokenFileCredentialsProvider.Builder webIdentityTokenFile(Path webIdentityTokenFile)
Define the absolute path to the web identity token file that should be used by this credentials provider.
-
asyncCredentialUpdateEnabled
WebIdentityTokenFileCredentialsProvider.Builder asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)
Define whether the provider should fetch credentials asynchronously in the background.
-
prefetchTime
WebIdentityTokenFileCredentialsProvider.Builder prefetchTime(Duration prefetchTime)
Configure the amount of time, relative to STS token expiration, that the cached credentials are considered close to stale and should be updated.Prefetch updates will occur between the specified time and the stale time of the provider. Prefetch updates may be asynchronous. See
asyncCredentialUpdateEnabled(java.lang.Boolean)
.By default, this is 5 minutes.
-
staleTime
WebIdentityTokenFileCredentialsProvider.Builder staleTime(Duration staleTime)
Configure the amount of time, relative to STS token expiration, that the cached credentials are considered stale and must be updated. All threads will block until the value is updated.By default, this is 1 minute.
-
roleSessionDuration
WebIdentityTokenFileCredentialsProvider.Builder roleSessionDuration(Duration sessionDuration)
- Parameters:
sessionDuration
-- Returns:
-
build
WebIdentityTokenFileCredentialsProvider build()
Create aWebIdentityTokenFileCredentialsProvider
using the configuration applied to this builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<WebIdentityTokenFileCredentialsProvider.Builder,WebIdentityTokenFileCredentialsProvider>
-
-