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

Class StsAssumeRoleWithSamlCredentialsProvider.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

StsAssumeRoleWithSamlCredentialsProvider

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

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

Constructor Summary

Constructors

Constructor	Description
Builder(StsAssumeRoleWithSamlCredentialsProvider provider)

Method Summary

Modifier and Type	Method	Description
StsAssumeRoleWithSamlCredentialsProvider	build()	Build the credentials provider using the configuration applied to this builder.
StsAssumeRoleWithSamlCredentialsProvider.Builder	refreshRequest(Consumer<AssumeRoleWithSamlRequest.Builder> assumeRoleWithSamlRequest)	Similar to refreshRequest(AssumeRoleWithSamlRequest), but takes a lambda to configure a new AssumeRoleWithSamlRequest.Builder.
StsAssumeRoleWithSamlCredentialsProvider.Builder	refreshRequest(Supplier<AssumeRoleWithSamlRequest> assumeRoleWithSamlRequestSupplier)	Similar to refreshRequest(AssumeRoleWithSamlRequest), but takes a Supplier to supply the request to STS.
StsAssumeRoleWithSamlCredentialsProvider.Builder	refreshRequest(AssumeRoleWithSamlRequest assumeRoleWithSamlRequest)	Configure the AssumeRoleWithSamlRequest that should be periodically sent to the STS service to update the session token when it gets close to expiring.
StsAssumeRoleWithSamlCredentialsProvider.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(StsAssumeRoleWithSamlCredentialsProvider provider)

Method Detail

refreshRequest

public StsAssumeRoleWithSamlCredentialsProvider.Builder refreshRequest(AssumeRoleWithSamlRequest assumeRoleWithSamlRequest)

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

Parameters:

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

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleWithSamlCredentialsProvider.Builder refreshRequest(Supplier<AssumeRoleWithSamlRequest> assumeRoleWithSamlRequestSupplier)

Similar to refreshRequest(AssumeRoleWithSamlRequest), but takes a Supplier to supply the request to STS.

Parameters:

assumeRoleWithSamlRequestSupplier - A supplier

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleWithSamlCredentialsProvider.Builder refreshRequest(Consumer<AssumeRoleWithSamlRequest.Builder> assumeRoleWithSamlRequest)

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

sourceChain

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

Overrides:

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