software.amazon.msk.auth.iam.internals

Class MSKCredentialProvider

java.lang.Object

software.amazon.msk.auth.iam.internals.MSKCredentialProvider

All Implemented Interfaces:

com.amazonaws.auth.AWSCredentialsProvider, java.lang.AutoCloseable

public class MSKCredentialProvider
extends java.lang.Object
implements com.amazonaws.auth.AWSCredentialsProvider, java.lang.AutoCloseable

This AWS Credential Provider is used to load up AWS Credentials based on options provided on the Jaas config line. As as an example sasl.jaas.config = IAMLoginModule required awsProfileName={profile name}; The currently supported options are: 1. A particular AWS Credential profile: awsProfileName={profile name} 2. A particular AWS IAM Role, with optional access key id, secret key and session token OR optional external id, and optionally AWS IAM role session name and AWS region for the STS endpoint: awsRoleArn={IAM Role ARN}, awsRoleAccessKeyId={access key id}, awsRoleSecretAccessKey={secret access key}, awsRoleSessionToken={session token}, awsRoleSessionName={session name}, awsStsRegion={region name} 3. Optional arguments to configure retries when we fail to load credentials: awsMaxRetries={Maximum number of retries}, awsMaxBackOffTimeMs={Maximum back off time between retries in ms} 4. Optional argument to help debug credentials used to establish connections: awsDebugCreds={true|false} 5. If no options is provided, the DefaultAWSCredentialsProviderChain is used. The DefaultAWSCredentialProviderChain can be pointed to credentials in many different ways: Working with AWS Credentials

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSKCredentialProvider.ProviderBuilder

Constructor Summary

Constructors

Constructor and Description
MSKCredentialProvider(java.util.Map<java.lang.String,?> options)

Method Summary

Modifier and Type	Method and Description
void	close()
com.amazonaws.auth.AWSCredentials	getCredentials()
protected com.amazonaws.auth.AWSCredentialsProviderChain	getDefaultProvider()
void	refresh()

Methods inherited from class java.lang.Object

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

Constructor Detail

MSKCredentialProvider

public MSKCredentialProvider(java.util.Map<java.lang.String,?> options)

Method Detail

getDefaultProvider

protected com.amazonaws.auth.AWSCredentialsProviderChain getDefaultProvider()

getCredentials

public com.amazonaws.auth.AWSCredentials getCredentials()

Specified by:

getCredentials in interface com.amazonaws.auth.AWSCredentialsProvider

refresh

public void refresh()

Specified by:

refresh in interface com.amazonaws.auth.AWSCredentialsProvider

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable