com.amazonaws.auth

Class ProcessCredentialsProvider

java.lang.Object

com.amazonaws.auth.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.
• ExpirationBuffer - 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: 64000 bytes.

Migrating to the AWS SDK for Java v2

The v2 equivalent of this class is ProcessCredentialsProvider

See Migration Guide for more information.

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.
org.joda.time.DateTime	getCredentialExpirationTime() Get the time at which this credentials provider will block to refresh the credentials.
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
void	refresh() Forces this credentials provider to refresh its credentials.

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.

getCredentials

public AWSCredentials getCredentials()

Description copied from interface: AWSCredentialsProvider

Returns AWSCredentials which the caller can use 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.

Specified by:

getCredentials in interface AWSCredentialsProvider

Returns:

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

refresh

public void refresh()

Description copied from interface: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

Specified by:

refresh in interface AWSCredentialsProvider

getCredentialExpirationTime

public org.joda.time.DateTime getCredentialExpirationTime()

Get the time at which this credentials provider will block to refresh the credentials. This is usually the expiration time returned by the credentials process, minus the configured expiration buffer.