Package org.apache.pulsar.io.aws

Class STSAssumeRoleProviderPlugin

java.lang.Object

org.apache.pulsar.io.aws.STSAssumeRoleProviderPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, AwsCredentialProviderPlugin

public class STSAssumeRoleProviderPlugin
extends Object
implements AwsCredentialProviderPlugin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSUME_ROLE_ARN
static final String	ASSUME_ROLE_SESSION_NAME

Constructor Summary

Constructors

Constructor	Description
STSAssumeRoleProviderPlugin()

Method Summary

Modifier and Type	Method	Description
void	close()
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.
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 class java.lang.Object

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

Field Details

ASSUME_ROLE_ARN

public static final String ASSUME_ROLE_ARN

See Also:

• Constant Field Values

ASSUME_ROLE_SESSION_NAME

public static final String ASSUME_ROLE_SESSION_NAME

See Also:

• Constant Field Values

Constructor Details

STSAssumeRoleProviderPlugin

public STSAssumeRoleProviderPlugin()

Method Details

init

public void init(String param)

Description copied from interface: AwsCredentialProviderPlugin

accepts aws-account related param and initialize credential provider.

Specified by:

init in interface AwsCredentialProviderPlugin

getCredentialProvider

public com.amazonaws.auth.AWSCredentialsProvider getCredentialProvider()

Description copied from interface: AwsCredentialProviderPlugin

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.

Specified by:

getCredentialProvider in interface AwsCredentialProviderPlugin

Returns:

getV2CredentialsProvider

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

Description copied from interface: AwsCredentialProviderPlugin

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

Specified by:

getV2CredentialsProvider in interface AwsCredentialProviderPlugin

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException