org.apache.hadoop.fs.s3a.auth

Class STSClientFactory.STSClient

java.lang.Object

org.apache.hadoop.fs.s3a.auth.STSClientFactory.STSClient

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

STSClientFactory

public static final class STSClientFactory.STSClient
extends Object
implements Closeable

STS client connection with retries.

Method Summary

Modifier and Type	Method and Description
void	close()
software.amazon.awssdk.services.sts.model.Credentials	requestRole(String roleARN, String sessionName, String policy, long duration, TimeUnit timeUnit) Request a set of role credentials.
software.amazon.awssdk.services.sts.model.Credentials	requestSessionCredentials(long duration, TimeUnit timeUnit) Request a set of session credentials.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

requestSessionCredentials

@Retries.RetryTranslated
public software.amazon.awssdk.services.sts.model.Credentials requestSessionCredentials(long duration,
                                                                                                                TimeUnit timeUnit)
                                                                                                         throws IOException

Request a set of session credentials.

Parameters:

duration - duration of the credentials

timeUnit - time unit of duration

Returns:

the role result

Throws:

IOException - on a failure of the request

requestRole

@Retries.RetryTranslated
public software.amazon.awssdk.services.sts.model.Credentials requestRole(String roleARN,
                                                                                                  String sessionName,
                                                                                                  String policy,
                                                                                                  long duration,
                                                                                                  TimeUnit timeUnit)
                                                                                           throws IOException

Request a set of role credentials.

Parameters:

roleARN - ARN to request

sessionName - name of the session

policy - optional policy; "" is treated as "none"

duration - duration of the credentials

timeUnit - time unit of duration

Returns:

the role result

Throws:

IOException - on a failure of the request