software.amazon.awssdk.services.sts.auth

Class StsAssumeRoleCredentialsProvider.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

StsAssumeRoleCredentialsProvider

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

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

Method Summary

Modifier and Type	Method and Description
StsAssumeRoleCredentialsProvider	build() Build the credentials provider using the configuration applied to this builder.
StsAssumeRoleCredentialsProvider.Builder	refreshRequest(AssumeRoleRequest assumeRoleRequest) Configure the AssumeRoleRequest that should be periodically sent to the STS service to update the assumed credentials.
StsAssumeRoleCredentialsProvider.Builder	refreshRequest(Consumer<AssumeRoleRequest.Builder> assumeRoleRequest) Similar to refreshRequest(AssumeRoleRequest), but takes a lambda to configure a new AssumeRoleRequest.Builder.
StsAssumeRoleCredentialsProvider.Builder	refreshRequest(Supplier<AssumeRoleRequest> assumeRoleRequestSupplier) Similar to refreshRequest(AssumeRoleRequest), but takes a Supplier to supply the request to STS.

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

Method Detail

refreshRequest

public StsAssumeRoleCredentialsProvider.Builder refreshRequest(AssumeRoleRequest assumeRoleRequest)

Configure the AssumeRoleRequest that should be periodically sent to the STS service to update the assumed credentials.

Parameters:

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

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleCredentialsProvider.Builder refreshRequest(Supplier<AssumeRoleRequest> assumeRoleRequestSupplier)

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

Parameters:

assumeRoleRequestSupplier - A supplier

Returns:

This object for chained calls.

refreshRequest

public StsAssumeRoleCredentialsProvider.Builder refreshRequest(Consumer<AssumeRoleRequest.Builder> assumeRoleRequest)

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

build

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

Overrides:

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