Package org.apache.beam.sdk.io.aws2.auth

Class StsAssumeRoleForFederatedCredentialsProvider

java.lang.Object

org.apache.beam.sdk.io.aws2.auth.StsAssumeRoleForFederatedCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

public abstract class StsAssumeRoleForFederatedCredentialsProvider
extends Object
implements AwsCredentialsProvider, SdkAutoCloseable

An implementation of AwsCredentialsProvider that periodically sends an AssumeRoleWithWebIdentityRequest to the AWS Security Token Service to maintain short-lived sessions to use for authentication. In particular this class will use a StsAssumeRoleWithWebIdentityCredentialsProvider instance as a delegate for the actual implementation but it takes care of retrieving a refreshed web id token with every credential's resolution request. This is created using builder().

See Also:

• API reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StsAssumeRoleForFederatedCredentialsProvider.Builder	Builder class for StsAssumeRoleForFederatedCredentialsProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_SESSION_DURATION_SECS

Constructor Summary

Constructors

Constructor	Description
StsAssumeRoleForFederatedCredentialsProvider()

Method Summary

Modifier and Type	Method	Description
abstract String	assumedRoleArn()
abstract String	audience()
static StsAssumeRoleForFederatedCredentialsProvider.Builder	builder()	Creates a builder for the type StsAssumeRoleForFederatedCredentialsProvider.
void	close()
AwsCredentials	resolveCredentials()
abstract Integer	sessionDurationSecs()
abstract String	webIdTokenProviderFQCN()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SESSION_DURATION_SECS

public static final Integer DEFAULT_SESSION_DURATION_SECS

Constructor Details

StsAssumeRoleForFederatedCredentialsProvider

public StsAssumeRoleForFederatedCredentialsProvider()

Method Details

audience

public abstract String audience()

assumedRoleArn

public abstract String assumedRoleArn()

webIdTokenProviderFQCN

public abstract String webIdTokenProviderFQCN()

sessionDurationSecs

@Nullable
public abstract Integer sessionDurationSecs()

resolveCredentials

public AwsCredentials resolveCredentials()

Specified by:

resolveCredentials in interface AwsCredentialsProvider

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

builder

public static StsAssumeRoleForFederatedCredentialsProvider.Builder builder()

Creates a builder for the type StsAssumeRoleForFederatedCredentialsProvider.

Returns:

an initialized builder instance.