Package software.amazon.awssdk.services.sso.auth

Interface SsoCredentialsProvider.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>, SdkBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>

All Known Implementing Classes:

SsoCredentialsProvider.BuilderImpl

Enclosing class:

SsoCredentialsProvider

public static interface SsoCredentialsProvider.Builder
extends CopyableBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>

A builder for creating a custom SsoCredentialsProvider.

Method Summary

Modifier and Type	Method	Description
SsoCredentialsProvider.Builder	asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)	Configure whether the provider should fetch credentials asynchronously in the background.
SsoCredentialsProvider	build()	Create a SsoCredentialsProvider using the configuration applied to this builder.
SsoCredentialsProvider.Builder	prefetchTime(Duration prefetchTime)	Configure the amount of time, relative to SSO session token expiration, that the cached credentials are considered close to stale and should be updated.
SsoCredentialsProvider.Builder	refreshRequest(Supplier<GetRoleCredentialsRequest> getRoleCredentialsRequestSupplier)	Similar to refreshRequest(GetRoleCredentialsRequest), but takes a Supplier to supply the request to SSO.
SsoCredentialsProvider.Builder	refreshRequest(GetRoleCredentialsRequest getRoleCredentialsRequest)	Configure the GetRoleCredentialsRequest that should be periodically sent to the SSO service to update the credentials.
SsoCredentialsProvider.Builder	sourceChain(String sourceChain)	An optional string denoting previous credentials providers that are chained with this one.
SsoCredentialsProvider.Builder	ssoClient(SsoClient ssoclient)	Configure the SsoClient to use when calling SSO to update the session.
SsoCredentialsProvider.Builder	staleTime(Duration staleTime)	Configure the amount of time, relative to SSO session token expiration, that the cached credentials are considered stale and should no longer be used.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Method Details

ssoClient

SsoCredentialsProvider.Builder ssoClient(SsoClient ssoclient)

Configure the SsoClient to use when calling SSO to update the session. This client should not be shut down as long as this credentials provider is in use.

asyncCredentialUpdateEnabled

SsoCredentialsProvider.Builder asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)

Configure whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but addtiional resources are used to maintian the provider.

By default, this is disabled.

staleTime

SsoCredentialsProvider.Builder staleTime(Duration staleTime)

Configure the amount of time, relative to SSO session token expiration, that the cached credentials are considered stale and should no longer be used. All threads will block until the value is updated.

By default, this is 1 minute.

prefetchTime

SsoCredentialsProvider.Builder prefetchTime(Duration prefetchTime)

Configure the amount of time, relative to SSO session 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.

refreshRequest

SsoCredentialsProvider.Builder refreshRequest(GetRoleCredentialsRequest getRoleCredentialsRequest)

Configure the GetRoleCredentialsRequest that should be periodically sent to the SSO service to update the credentials.

refreshRequest

SsoCredentialsProvider.Builder refreshRequest(Supplier<GetRoleCredentialsRequest> getRoleCredentialsRequestSupplier)

Similar to refreshRequest(GetRoleCredentialsRequest), but takes a Supplier to supply the request to SSO.

sourceChain

SsoCredentialsProvider.Builder sourceChain(String sourceChain)

An optional string denoting previous credentials providers that are chained with this one. This method is primarily intended for use by AWS SDK internal components and should not be used directly by external users.

build

SsoCredentialsProvider build()

Create a SsoCredentialsProvider using the configuration applied to this builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<SsoCredentialsProvider.Builder,SsoCredentialsProvider>

Returns: