Package software.amazon.awssdk.services.sts.auth

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 by StsGetSessionTokenCredentialsProvider.builder()) for creating a StsGetSessionTokenCredentialsProvider.

Constructor Summary

Constructors

Constructor	Description
Builder(StsGetSessionTokenCredentialsProvider provider)

Method Summary

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 to refreshRequest(GetSessionTokenRequest), but takes a lambda to configure a new GetSessionTokenRequest.Builder.
StsGetSessionTokenCredentialsProvider.Builder	refreshRequest(GetSessionTokenRequest getSessionTokenRequest)	Configure the GetSessionTokenRequest that should be periodically sent to the STS service to update the session token when it gets close to expiring.
StsGetSessionTokenCredentialsProvider.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

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 the GetSessionTokenRequest 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 to refreshRequest(GetSessionTokenRequest), but takes a lambda to configure a new GetSessionTokenRequest.Builder. This removes the need to called GetSessionTokenRequest.builder() and StsRequest.Builder.build().

sourceChain

public StsGetSessionTokenCredentialsProvider.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 StsGetSessionTokenCredentialsProvider 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<StsGetSessionTokenCredentialsProvider.Builder,StsGetSessionTokenCredentialsProvider>

Overrides:

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