Class StsAssumeRoleWithWebIdentityCredentialsProvider.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

StsAssumeRoleWithWebIdentityCredentialsProvider

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

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

Constructor Summary

Constructors

Constructor	Description
Builder(StsAssumeRoleWithWebIdentityCredentialsProvider provider)

Method Summary

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

Method Details

refreshRequest

public StsAssumeRoleWithWebIdentityCredentialsProvider.Builder refreshRequest(AssumeRoleWithWebIdentityRequest assumeRoleWithWebIdentityRequest)

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

Parameters:

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

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleWithWebIdentityCredentialsProvider.Builder refreshRequest(Supplier<AssumeRoleWithWebIdentityRequest> assumeRoleWithWebIdentityRequest)

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

Parameters:

assumeRoleWithWebIdentityRequest - A supplier

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleWithWebIdentityCredentialsProvider.Builder refreshRequest(Consumer<AssumeRoleWithWebIdentityRequest.Builder> assumeRoleWithWebIdentityRequest)

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

sourceChain

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

Overrides:

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

Returns:

an instance of T