com.adaptris.aws

Class ProcessCredentialsBuilder

java.lang.Object

com.adaptris.aws.ProcessCredentialsBuilder

All Implemented Interfaces:

AWSCredentialsProviderBuilder

@ComponentProfile(summary="Credentials provider that can load credentials from an external process",
                  since="3.9.2")
public class ProcessCredentialsBuilder
extends java.lang.Object
implements AWSCredentialsProviderBuilder

Credentials provider that can load credentials from an external process.

See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes for more information

In the adapter configuration file this class is aliased as aws-process-credentials-builder which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adaptris.aws.AWSCredentialsProviderBuilder

AWSCredentialsProviderBuilder.BuilderConfig

Constructor Summary

Constructors

Constructor and Description
ProcessCredentialsBuilder()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.auth.AWSCredentialsProvider	build()
@NonNull java.lang.String	getCommand() The command that should be executed to retrieve credentials including arguments
java.lang.Integer	getExpirationBufferSeconds() The number of seconds between when the credentials expire and when the credentials should start to be refreshed.
java.lang.Long	getProcessOutputLimitBytes() The maximum amount of data that can be returned by the external process before an exception is raised.
void	setCommand(@NonNull java.lang.String command) The command that should be executed to retrieve credentials including arguments
void	setExpirationBufferSeconds(java.lang.Integer expirationBufferSeconds) The number of seconds between when the credentials expire and when the credentials should start to be refreshed.
void	setProcessOutputLimitBytes(java.lang.Long processOutputLimitBytes) The maximum amount of data that can be returned by the external process before an exception is raised.
ProcessCredentialsBuilder	withCommand(java.lang.String s)
ProcessCredentialsBuilder	withExpirationBufferSeconds(java.lang.Integer i)
ProcessCredentialsBuilder	withProcessOutputLimitBytes(java.lang.Long l)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.aws.AWSCredentialsProviderBuilder

build, defaultIfNull

Constructor Detail

ProcessCredentialsBuilder

public ProcessCredentialsBuilder()

Method Detail

build

public com.amazonaws.auth.AWSCredentialsProvider build()
                                                throws java.lang.Exception

Specified by:

build in interface AWSCredentialsProviderBuilder

Throws:

java.lang.Exception

withCommand

public ProcessCredentialsBuilder withCommand(java.lang.String s)

withProcessOutputLimitBytes

public ProcessCredentialsBuilder withProcessOutputLimitBytes(java.lang.Long l)

withExpirationBufferSeconds

public ProcessCredentialsBuilder withExpirationBufferSeconds(java.lang.Integer i)

getCommand

@NonNull
public @NonNull java.lang.String getCommand()

The command that should be executed to retrieve credentials including arguments

e.g. if you have a custom aws credentials program that takes arguments then you could have /opt/bin/awscreds-custom --username interlok here. The program is expected to output JSON data as per the documentation

setCommand

public void setCommand(@NonNull
                       @NonNull java.lang.String command)

The command that should be executed to retrieve credentials including arguments

e.g. if you have a custom aws credentials program that takes arguments then you could have /opt/bin/awscreds-custom --username interlok here. The program is expected to output JSON data as per the documentation

getProcessOutputLimitBytes

public java.lang.Long getProcessOutputLimitBytes()

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

If not specified, then the AWS internal default is used (currently 1024 bytes).

setProcessOutputLimitBytes

public void setProcessOutputLimitBytes(java.lang.Long processOutputLimitBytes)

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

If not specified, then the AWS internal default is used (currently 1024 bytes).

getExpirationBufferSeconds

public java.lang.Integer getExpirationBufferSeconds()

The number of seconds between when the credentials expire and when the credentials should start to be refreshed.

This setting allows the credentials to be refreshed before they are reported to expire. If not configured, then the AWS internal default is used (currently 15 seconds)

setExpirationBufferSeconds

public void setExpirationBufferSeconds(java.lang.Integer expirationBufferSeconds)

The number of seconds between when the credentials expire and when the credentials should start to be refreshed.

This setting allows the credentials to be refreshed before they are reported to expire. If not configured, then the AWS internal default is used (currently 15 seconds)