software.amazon.awssdk.auth.credentials

Class ProcessCredentialsProvider.Builder

java.lang.Object

software.amazon.awssdk.auth.credentials.ProcessCredentialsProvider.Builder

Enclosing class:

ProcessCredentialsProvider

public static class ProcessCredentialsProvider.Builder
extends Object

Used to configure and create a ProcessCredentialsProvider. See ProcessCredentialsProvider.builder() creation.

Method Summary

Modifier and Type	Method and Description
ProcessCredentialsProvider.Builder	asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled) Configure whether the provider should fetch credentials asynchronously in the background.
ProcessCredentialsProvider	build()
ProcessCredentialsProvider.Builder	command(String command) Configure the command that should be executed to retrieve credentials.
ProcessCredentialsProvider.Builder	credentialRefreshThreshold(Duration credentialRefreshThreshold) Configure the amount of time between when the credentials expire and when the credentials should start to be refreshed.
ProcessCredentialsProvider.Builder	processOutputLimit(long outputByteLimit) Configure the maximum amount of data that can be returned by the external process before an exception is raised.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

asyncCredentialUpdateEnabled

public ProcessCredentialsProvider.Builder asyncCredentialUpdateEnabled(Boolean asyncCredentialUpdateEnabled)

Configure whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider.

By default, this is disabled.

command

public ProcessCredentialsProvider.Builder command(String command)

Configure the command that should be executed to retrieve credentials.

credentialRefreshThreshold

public ProcessCredentialsProvider.Builder credentialRefreshThreshold(Duration credentialRefreshThreshold)

Configure the amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed *before* they are reported to expire.

Default: 15 seconds.

processOutputLimit

public ProcessCredentialsProvider.Builder processOutputLimit(long outputByteLimit)

Configure the maximum amount of data that can be returned by the external process before an exception is raised.

Default: 1024 bytes.

build

public ProcessCredentialsProvider build()