Package com.adaptris.aws

Class ProfileCredentialsBuilder

java.lang.Object

com.adaptris.aws.ProfileCredentialsBuilder

All Implemented Interfaces:

AWSCredentialsProviderBuilder

@ComponentProfile(summary="Credentials provider based on AWS configuration profiles",
                  since="3.9.2")
public class ProfileCredentialsBuilder
extends java.lang.Object
implements AWSCredentialsProviderBuilder

Credentials provider based on AWS configuration profiles

In the adapter configuration file this class is aliased as aws-profile-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	Description
ProfileCredentialsBuilder()

Method Summary

Modifier and Type	Method	Description
com.amazonaws.auth.AWSCredentialsProvider	build()
java.lang.String	getConfigFile()	The profile configuration file.
java.lang.String	getProfileName()	The profile within configuration.
java.lang.Long	getRefreshIntervalNanos()	The refresh interval in nano seconds.
void	setConfigFile(java.lang.String configFile)	The profile configuration file.
void	setProfileName(java.lang.String profileName)	The profile within configuration.
void	setRefreshIntervalNanos(java.lang.Long refreshIntervalNanos)	The refresh interval in nano seconds.
ProfileCredentialsBuilder	withConfigFile(java.lang.String s)
ProfileCredentialsBuilder	withProfileName(java.lang.String s)
ProfileCredentialsBuilder	withRefreshIntervalNanos(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

Constructor Detail

ProfileCredentialsBuilder

public ProfileCredentialsBuilder()

Method Detail

build

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

Specified by:

build in interface AWSCredentialsProviderBuilder

Throws:

java.lang.Exception

withConfigFile

public ProfileCredentialsBuilder withConfigFile(java.lang.String s)

withProfileName

public ProfileCredentialsBuilder withProfileName(java.lang.String s)

withRefreshIntervalNanos

public ProfileCredentialsBuilder withRefreshIntervalNanos(java.lang.Long l)

getConfigFile

public java.lang.String getConfigFile()

The profile configuration file.

If not specified then the behaviour is down to the AWS SDK. This probably means that ~/.aws/config is used as the configuration file.

setConfigFile

public void setConfigFile(java.lang.String configFile)

The profile configuration file.

If not specified then the behaviour is down to the AWS SDK. This probably means that ~/.aws/config is used as the configuration file.

getProfileName

public java.lang.String getProfileName()

The profile within configuration.

If not specified then the behaviour is down to the AWS SDK. This will probably mean the default profile.

setProfileName

public void setProfileName(java.lang.String profileName)

The profile within configuration.

If not specified then the behaviour is down to the AWS SDK. This will probably mean the default profile.

getRefreshIntervalNanos

public java.lang.Long getRefreshIntervalNanos()

The refresh interval in nano seconds.

This maps onto ProfileCredentialsProvider#setRefreshIntervalNanos(long}. The corresponding ProfileCredentialsProvider#setRefreshForceIntervalNanos(long) is set to 2x whatever you have configured here.

setRefreshIntervalNanos

public void setRefreshIntervalNanos(java.lang.Long refreshIntervalNanos)

The refresh interval in nano seconds.

This maps onto ProfileCredentialsProvider#setRefreshIntervalNanos(long}. The corresponding ProfileCredentialsProvider#setRefreshForceIntervalNanos(long) is set to 2x whatever you have configured here.