org.apache.pulsar.io.aws

Interface AwsCredentialProviderPlugin

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AwsDefaultProviderChainPlugin, STSAssumeRoleProviderPlugin

public interface AwsCredentialProviderPlugin
extends Closeable

Kinesis source/sink calls credential-provider while refreshing aws accessKey and secreKey. So, implementation AwsCredentialProviderPlugin needs to makes sure to return non-expired keys when it requires.

Method Summary

Modifier and Type	Method and Description
com.amazonaws.auth.AWSCredentialsProvider	getCredentialProvider() Returned AWSCredentialsProvider can give AWSCredentials in case credential belongs to IAM user or it can return BasicSessionCredentials if user wants to generate temporary credential for a given IAM role.
default software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getV2CredentialsProvider() Returns a V2 credential provider for use with the v2 SDK.
void	init(String param) accepts aws-account related param and initialize credential provider.

Methods inherited from interface java.io.Closeable

close

Method Detail

init

void init(String param)

accepts aws-account related param and initialize credential provider.

Parameters:

param -

getCredentialProvider

com.amazonaws.auth.AWSCredentialsProvider getCredentialProvider()

Returned AWSCredentialsProvider can give AWSCredentials in case credential belongs to IAM user or it can return BasicSessionCredentials if user wants to generate temporary credential for a given IAM role.

Returns:

getV2CredentialsProvider

default software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getV2CredentialsProvider()

Returns a V2 credential provider for use with the v2 SDK. Defaults to an implementation that pulls credentials from a v1 provider