software.amazon.awssdk.auth.credentials

Class ProcessCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.ProcessCredentialsProvider

All Implemented Interfaces:

AwsCredentialsProvider

public final class ProcessCredentialsProvider
extends Object
implements AwsCredentialsProvider

A credentials provider that can load credentials from an external process. This is used to support the credential_process setting in the profile credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes for more information. Created using builder(). Available settings:

• Command - The command that should be executed to retrieve credentials.
• CredentialRefreshThreshold - 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 - The maximum amount of data that can be returned by the external process before an exception is raised. Default: 1024 bytes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessCredentialsProvider.Builder Used to configure and create a ProcessCredentialsProvider.

Method Summary

Modifier and Type	Method and Description
static ProcessCredentialsProvider.Builder	builder() Retrieve a new builder that can be used to create and configure a ProcessCredentialsProvider.
AwsCredentials	resolveCredentials() Returns AwsCredentials that can be used to authorize an AWS request.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ProcessCredentialsProvider.Builder builder()

Retrieve a new builder that can be used to create and configure a ProcessCredentialsProvider.

resolveCredentials

public AwsCredentials resolveCredentials()

Description copied from interface: AwsCredentialsProvider

Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.

Specified by:

resolveCredentials in interface AwsCredentialsProvider

Returns:

AwsCredentials which the caller can use to authorize an AWS request.