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

Class SsoCredentialsProvider.BuilderImpl

java.lang.Object

software.amazon.awssdk.services.sso.auth.SsoCredentialsProvider.BuilderImpl

All Implemented Interfaces:

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

Enclosing class:

SsoCredentialsProvider

protected static final class SsoCredentialsProvider.BuilderImpl
extends Object
implements SsoCredentialsProvider.Builder

Constructor Summary

Constructors

Constructor	Description
BuilderImpl(SsoCredentialsProvider provider)

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 SsoCredentialsProvider.Builder.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 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 Details

BuilderImpl

public BuilderImpl(SsoCredentialsProvider provider)

Method Details

ssoClient

public SsoCredentialsProvider.Builder ssoClient(SsoClient ssoClient)

Description copied from interface: SsoCredentialsProvider.Builder

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.

Specified by:

ssoClient in interface SsoCredentialsProvider.Builder

asyncCredentialUpdateEnabled

public SsoCredentialsProvider.Builder asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)

Description copied from interface: SsoCredentialsProvider.Builder

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.

Specified by:

asyncCredentialUpdateEnabled in interface SsoCredentialsProvider.Builder

staleTime

public SsoCredentialsProvider.Builder staleTime(Duration staleTime)

Description copied from interface: SsoCredentialsProvider.Builder

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.

Specified by:

staleTime in interface SsoCredentialsProvider.Builder

prefetchTime

public SsoCredentialsProvider.Builder prefetchTime(Duration prefetchTime)

Description copied from interface: SsoCredentialsProvider.Builder

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 SsoCredentialsProvider.Builder.asyncCredentialUpdateEnabled(java.lang.Boolean).

By default, this is 5 minutes.

Specified by:

prefetchTime in interface SsoCredentialsProvider.Builder

refreshRequest

public SsoCredentialsProvider.Builder refreshRequest(GetRoleCredentialsRequest getRoleCredentialsRequest)

Description copied from interface: SsoCredentialsProvider.Builder

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

Specified by:

refreshRequest in interface SsoCredentialsProvider.Builder

refreshRequest

public SsoCredentialsProvider.Builder refreshRequest(Supplier<GetRoleCredentialsRequest> getRoleCredentialsRequestSupplier)

Description copied from interface: SsoCredentialsProvider.Builder

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

Specified by:

refreshRequest in interface SsoCredentialsProvider.Builder

sourceChain

public SsoCredentialsProvider.Builder sourceChain(String sourceChain)

Description copied from interface: SsoCredentialsProvider.Builder

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.

Specified by:

sourceChain in interface SsoCredentialsProvider.Builder

build

public SsoCredentialsProvider build()

Description copied from interface: SsoCredentialsProvider.Builder

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>

Specified by:

build in interface SsoCredentialsProvider.Builder