Class StsGetFederationTokenCredentialsProvider.Builder

java.lang.Object

software.amazon.awssdk.services.sts.auth.StsCredentialsProvider.BaseBuilder<StsGetFederationTokenCredentialsProvider.Builder,StsGetFederationTokenCredentialsProvider>

software.amazon.awssdk.services.sts.auth.StsGetFederationTokenCredentialsProvider.Builder

All Implemented Interfaces:

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

Enclosing class:

StsGetFederationTokenCredentialsProvider

@NotThreadSafe
public static final class StsGetFederationTokenCredentialsProvider.Builder
extends StsCredentialsProvider.BaseBuilder<StsGetFederationTokenCredentialsProvider.Builder,StsGetFederationTokenCredentialsProvider>

A builder (created by StsGetFederationTokenCredentialsProvider.builder()) for creating a StsGetFederationTokenCredentialsProvider.

Constructor Summary

Constructors

Constructor	Description
Builder(StsGetFederationTokenCredentialsProvider provider)

Method Summary

Modifier and Type	Method	Description
StsGetFederationTokenCredentialsProvider	build()	Build the credentials provider using the configuration applied to this builder.
StsGetFederationTokenCredentialsProvider.Builder	refreshRequest(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)	Similar to refreshRequest(GetFederationTokenRequest), but takes a lambda to configure a new GetFederationTokenRequest.Builder.
StsGetFederationTokenCredentialsProvider.Builder	refreshRequest(GetFederationTokenRequest getFederationTokenRequest)	Configure the GetFederationTokenRequest that should be periodically sent to the STS service to update the session token when it gets close to expiring.
StsGetFederationTokenCredentialsProvider.Builder	sourceChain(String sourceChain)	Configure the source of this credentials provider.

Methods inherited from class software.amazon.awssdk.services.sts.auth.StsCredentialsProvider.BaseBuilder

asyncCredentialUpdateEnabled, prefetchTime, staleTime, stsClient

Methods inherited from class java.lang.Object

equals, 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

Builder

public Builder(StsGetFederationTokenCredentialsProvider provider)

Method Details

refreshRequest

public StsGetFederationTokenCredentialsProvider.Builder refreshRequest(GetFederationTokenRequest getFederationTokenRequest)

Configure the GetFederationTokenRequest that should be periodically sent to the STS service to update the session token when it gets close to expiring.

Parameters:

getFederationTokenRequest - The request to send to STS whenever the assumed session expires.

Returns:

This object for chained calls.

refreshRequest

public StsGetFederationTokenCredentialsProvider.Builder refreshRequest(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)

Similar to refreshRequest(GetFederationTokenRequest), but takes a lambda to configure a new GetFederationTokenRequest.Builder. This removes the need to called GetFederationTokenRequest.builder() and StsRequest.Builder.build().

sourceChain

public StsGetFederationTokenCredentialsProvider.Builder sourceChain(String sourceChain)

Configure the source of this credentials provider. This is used for business metrics tracking to identify the credential provider chain.

Note: This method is primarily intended for use by AWS SDK internal components and should not be used directly by external users.

Parameters:

sourceChain - The source identifier for business metrics tracking.

Returns:

This object for chained calls.

build

public StsGetFederationTokenCredentialsProvider build()

Description copied from class: StsCredentialsProvider.BaseBuilder

Build the credentials provider using the configuration applied to this builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<StsGetFederationTokenCredentialsProvider.Builder,StsGetFederationTokenCredentialsProvider>

Overrides:

build in class StsCredentialsProvider.BaseBuilder<StsGetFederationTokenCredentialsProvider.Builder,StsGetFederationTokenCredentialsProvider>

Returns:

an instance of T