Class ProcessCredentialsProvider.Builder
java.lang.Object
software.amazon.awssdk.auth.credentials.ProcessCredentialsProvider.Builder
- All Implemented Interfaces:
Buildable
,CopyableBuilder<ProcessCredentialsProvider.Builder,
,ProcessCredentialsProvider> SdkBuilder<ProcessCredentialsProvider.Builder,
ProcessCredentialsProvider>
- Enclosing class:
ProcessCredentialsProvider
public static class ProcessCredentialsProvider.Builder
extends Object
implements CopyableBuilder<ProcessCredentialsProvider.Builder,ProcessCredentialsProvider>
Used to configure and create a
ProcessCredentialsProvider
. See ProcessCredentialsProvider.builder()
creation.-
Method Summary
Modifier and TypeMethodDescriptionasyncCredentialUpdateEnabled
(Boolean asyncCredentialUpdateEnabled) Configure whether the provider should fetch credentials asynchronously in the background.build()
An immutable object that is created from the properties that have been set on the builder.Deprecated.Configure the command that should be executed to retrieve credentials, as a list of strings.credentialRefreshThreshold
(Duration credentialRefreshThreshold) Configure the amount of time between when the credentials expire and when the credentials should start to be refreshed.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
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
-
Method Details
-
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
Deprecated.The recommended approach is to specify the command as a list of Strings, usingcommand(List)
instead, which makes it easier to programmatically add parameters to commands without needing to escape those parameters to protect against command injection.Configure the command that should be executed to retrieve credentials. SeeProcessBuilder
for details on how this command is used. -
command
Configure the command that should be executed to retrieve credentials, as a list of strings. SeeProcessBuilder
for details on how this command is used. -
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
Configure the maximum amount of data that can be returned by the external process before an exception is raised.Default: 64000 bytes (64KB).
-
build
Description copied from interface:SdkBuilder
An immutable object that is created from the properties that have been set on the builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<ProcessCredentialsProvider.Builder,
ProcessCredentialsProvider> - Returns:
- an instance of T
-
command(List)
instead, which makes it easier to programmatically add parameters to commands without needing to escape those parameters to protect against command injection.