com.amazonaws.auth

クラス STSSessionCredentialsProvider

java.lang.Object

com.amazonaws.auth.STSSessionCredentialsProvider

すべての実装されたインタフェース:

AWSCredentialsProvider

public class STSSessionCredentialsProvider
extends java.lang.Object
implements AWSCredentialsProvider

AWSCredentialsProvider implementation that uses the AWS Security Token Service to create temporary, short-lived sessions to use for authentication.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static int	DEFAULT_DURATION_SECONDS Default duration for started sessions

コンストラクタの概要

コンストラクタ

コンストラクタと説明
STSSessionCredentialsProvider(AWSCredentials longLivedCredentials) Constructs a new STSSessionCredentialsProvider, which will use the specified long lived AWS credentials to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.
STSSessionCredentialsProvider(AWSCredentials longLivedCredentials, ClientConfiguration clientConfiguration) Constructs a new STSSessionCredentialsProvider, which will use the specified long lived AWS credentials to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.
STSSessionCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider) Constructs a new STSSessionCredentialsProvider, which will use the specified credentials provider (which vends long lived AWS credentials) to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.
STSSessionCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new STSSessionCredentialsProvider, which will use the specified credentials provider (which vends long lived AWS credentials) to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
void	refresh() Forces this credentials provider to refresh its credentials.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_DURATION_SECONDS

public static final int DEFAULT_DURATION_SECONDS

Default duration for started sessions

関連項目:

定数フィールド値

コンストラクタの詳細

STSSessionCredentialsProvider

public STSSessionCredentialsProvider(AWSCredentials longLivedCredentials)

Constructs a new STSSessionCredentialsProvider, which will use the specified long lived AWS credentials to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.

パラメータ:

longLivedCredentials - The main AWS credentials for a user's account.

STSSessionCredentialsProvider

public STSSessionCredentialsProvider(AWSCredentials longLivedCredentials,
                             ClientConfiguration clientConfiguration)

Constructs a new STSSessionCredentialsProvider, which will use the specified long lived AWS credentials to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.

パラメータ:

longLivedCredentials - The main AWS credentials for a user's account.

clientConfiguration - Client configuration connection parameters.

STSSessionCredentialsProvider

public STSSessionCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)

Constructs a new STSSessionCredentialsProvider, which will use the specified credentials provider (which vends long lived AWS credentials) to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.

パラメータ:

longLivedCredentialsProvider - Credentials provider for the main AWS credentials for a user's account.

STSSessionCredentialsProvider

public STSSessionCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new STSSessionCredentialsProvider, which will use the specified credentials provider (which vends long lived AWS credentials) to make a request to the AWS Security Token Service (STS) to request short lived session credentials, which will then be returned by this class's getCredentials() method.

パラメータ:

longLivedCredentialsProvider - Credentials provider for the main AWS credentials for a user's account.

clientConfiguration - Client configuration connection parameters.

メソッドの詳細

getCredentials

public AWSCredentials getCredentials()

インタフェースからコピーされた説明: AWSCredentialsProvider

Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

定義:

getCredentials インタフェース内 AWSCredentialsProvider

戻り値:

AWSCredentials which the caller can use to authorize an AWS request.

refresh

public void refresh()

インタフェースからコピーされた説明: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

定義:

refresh インタフェース内 AWSCredentialsProvider