com.adaptris.aws

Class STSAssumeroleCredentialsBuilder

java.lang.Object

com.adaptris.aws.STSAssumeroleCredentialsBuilder

All Implemented Interfaces:

AWSCredentialsProviderBuilder

@ComponentProfile(summary="Create a set of credentials via STS",
                  tag="amazon,aws,sts,assumerole",
                  since="4.0.0")
public class STSAssumeroleCredentialsBuilder
extends java.lang.Object
implements AWSCredentialsProviderBuilder

AWS credentials that makes use of AWS STS

AWS Security Token Service (STS) enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). For more information about using this service, see Temporary Security Credentials.

In the adapter configuration file this class is aliased as aws-sts-assumerole-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
STSAssumeroleCredentialsBuilder()

Method Summary

Modifier and Type	Method and Description
com.amazonaws.auth.AWSCredentialsProvider	build()
com.amazonaws.auth.AWSCredentialsProvider	build(AWSCredentialsProviderBuilder.BuilderConfig conf)
AWSCredentialsProviderBuilder	getCredentials() The underlying credentials used to access STS.
@NonNull java.lang.String	getRoleArn() The required roleArn parameter when starting a session.
java.lang.Integer	getRoleDurationSeconds() The duration for which we want to have an assumed role session to be active
java.lang.String	getRoleExternalId() An external id used in the service call used to retrieve session credentials
@NonNull java.lang.String	getRoleSessionName() The required roleSessionName when starting a session.
java.lang.String	getScopeDownPolicy() An IAM policy in JSON format to scope down permissions granted from the assume role.
KeyValuePairSet	getSessionTags() The collection of tags which we want to pass to the assume role request
java.util.List<java.lang.String>	getTransitiveTagKeys() The transitive tag keys we want to pass to the assume role request
void	setCredentials(AWSCredentialsProviderBuilder credentials) The underlying credentials used to access STS.
void	setRoleArn(@NonNull java.lang.String roleArn) The required roleArn parameter when starting a session.
void	setRoleDurationSeconds(java.lang.Integer roleDurationSeconds) The duration for which we want to have an assumed role session to be active
void	setRoleExternalId(java.lang.String roleExternalId) An external id used in the service call used to retrieve session credentials
void	setRoleSessionName(@NonNull java.lang.String roleSessionName) The required roleSessionName when starting a session.
void	setScopeDownPolicy(java.lang.String scopeDownPolicy) An IAM policy in JSON format to scope down permissions granted from the assume role.
void	setSessionTags(KeyValuePairSet sessionTags) The collection of tags which we want to pass to the assume role request
void	setTransitiveTagKeys(java.util.List<java.lang.String> transitiveTagKeys) The transitive tag keys we want to pass to the assume role request
STSAssumeroleCredentialsBuilder	withCredentials(AWSCredentialsProviderBuilder a)
STSAssumeroleCredentialsBuilder	withRoleArn(java.lang.String s)
STSAssumeroleCredentialsBuilder	withRoleExternalId(java.lang.String s)
STSAssumeroleCredentialsBuilder	withRoleSessionName(java.lang.String s)

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

defaultIfNull

Constructor Detail

STSAssumeroleCredentialsBuilder

public STSAssumeroleCredentialsBuilder()

Method Detail

build

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

Specified by:

build in interface AWSCredentialsProviderBuilder

Throws:

java.lang.Exception

build

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

Specified by:

build in interface AWSCredentialsProviderBuilder

Throws:

java.lang.Exception

withCredentials

public STSAssumeroleCredentialsBuilder withCredentials(AWSCredentialsProviderBuilder a)

withRoleArn

public STSAssumeroleCredentialsBuilder withRoleArn(java.lang.String s)

withRoleSessionName

public STSAssumeroleCredentialsBuilder withRoleSessionName(java.lang.String s)

withRoleExternalId

public STSAssumeroleCredentialsBuilder withRoleExternalId(java.lang.String s)

getCredentials

public AWSCredentialsProviderBuilder getCredentials()

The underlying credentials used to access STS.

setCredentials

public void setCredentials(AWSCredentialsProviderBuilder credentials)

The underlying credentials used to access STS.

getRoleArn

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

The required roleArn parameter when starting a session.

setRoleArn

public void setRoleArn(@NonNull
                       @NonNull java.lang.String roleArn)

The required roleArn parameter when starting a session.

getRoleSessionName

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

The required roleSessionName when starting a session.

setRoleSessionName

public void setRoleSessionName(@NonNull
                               @NonNull java.lang.String roleSessionName)

The required roleSessionName when starting a session.

getRoleExternalId

public java.lang.String getRoleExternalId()

An external id used in the service call used to retrieve session credentials

setRoleExternalId

public void setRoleExternalId(java.lang.String roleExternalId)

An external id used in the service call used to retrieve session credentials

getTransitiveTagKeys

public java.util.List<java.lang.String> getTransitiveTagKeys()

The transitive tag keys we want to pass to the assume role request

This defaults to null to avoid configuration clutter

setTransitiveTagKeys

public void setTransitiveTagKeys(java.util.List<java.lang.String> transitiveTagKeys)

The transitive tag keys we want to pass to the assume role request

This defaults to null to avoid configuration clutter

getSessionTags

public KeyValuePairSet getSessionTags()

The collection of tags which we want to pass to the assume role request

This defaults to null to avoid configuration clutter

setSessionTags

public void setSessionTags(KeyValuePairSet sessionTags)

The collection of tags which we want to pass to the assume role request

This defaults to null to avoid configuration clutter

getRoleDurationSeconds

public java.lang.Integer getRoleDurationSeconds()

The duration for which we want to have an assumed role session to be active

This defaults to null to avoid configuration clutter

setRoleDurationSeconds

public void setRoleDurationSeconds(java.lang.Integer roleDurationSeconds)

The duration for which we want to have an assumed role session to be active

This defaults to null to avoid configuration clutter

getScopeDownPolicy

public java.lang.String getScopeDownPolicy()

An IAM policy in JSON format to scope down permissions granted from the assume role.

This is passed though to STSAssumeRoleSessionCredentialsProvider.Builder#withScopeDownPolicy(String) as-is with no checking, is completely optional and defaults to null to avoid configuration clutter

setScopeDownPolicy

public void setScopeDownPolicy(java.lang.String scopeDownPolicy)

An IAM policy in JSON format to scope down permissions granted from the assume role.

This is passed though to STSAssumeRoleSessionCredentialsProvider.Builder#withScopeDownPolicy(String) as-is with no checking, is completely optional and defaults to null to avoid configuration clutter