Package com.amazonaws.auth
Class WebIdentityFederationSessionCredentialsProvider
java.lang.Object
com.amazonaws.auth.WebIdentityFederationSessionCredentialsProvider
- All Implemented Interfaces:
AWSCredentialsProvider
,AWSSessionCredentialsProvider
public class WebIdentityFederationSessionCredentialsProvider
extends Object
implements AWSSessionCredentialsProvider
AWSCredentialsProvider implementation that uses the AWS Security Token
Service to create temporary, short-lived sessions to use for authentication.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Default duration for started sessionsstatic final int
Default threshold for refreshing session credentials -
Constructor Summary
ConstructorsConstructorDescriptionWebIdentityFederationSessionCredentialsProvider
(String wifToken, String wifProvider, String roleArn) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider 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'sgetCredentials()
method.WebIdentityFederationSessionCredentialsProvider
(String wifToken, String wifProvider, String roleArn, ClientConfiguration clientConfiguration) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider 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'sgetCredentials()
method.WebIdentityFederationSessionCredentialsProvider
(String wifToken, String wifProvider, String roleArn, AWSSecurityTokenService stsClient) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) using the provided client to request short lived session credentials, which will then be returned by this class'sgetCredentials()
method. -
Method Summary
Modifier and TypeMethodDescriptionReturns AWSCredentials which the caller can use to authorize an AWS request.int
Get the refresh threshold for the session credentials created by this client in seconds.int
Get the duration of the session credentials created by this client in seconds.Get the identifier returned from the Identity Provider for the authenticated user.void
refresh()
Forces this credentials provider to refresh its credentials.void
setRefreshThreshold
(int refreshThreshold) Set the refresh threshold for the session credentials created by this client in seconds.void
setSessionDuration
(int sessionDuration) Set the duration of the session credentials created by this client in seconds.withRefreshThreshold
(int refreshThreshold) Set the refresh threshold for the session credentials created by this client in seconds.withSessionDuration
(int sessionDuration) Set the duration of the session credentials created by this client in seconds.
-
Field Details
-
DEFAULT_DURATION_SECONDS
public static final int DEFAULT_DURATION_SECONDSDefault duration for started sessions- See Also:
-
DEFAULT_THRESHOLD_SECONDS
public static final int DEFAULT_THRESHOLD_SECONDSDefault threshold for refreshing session credentials- See Also:
-
-
Constructor Details
-
WebIdentityFederationSessionCredentialsProvider
public WebIdentityFederationSessionCredentialsProvider(String wifToken, String wifProvider, String roleArn) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider 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'sgetCredentials()
method.- Parameters:
wifToken
- The OAuth/OpenID token from the the Identity ProviderwifProvider
- The name of the Identity Provider (null for OpenID providers)roleArn
- The ARN of the IAM Role that will be assumed
-
WebIdentityFederationSessionCredentialsProvider
public WebIdentityFederationSessionCredentialsProvider(String wifToken, String wifProvider, String roleArn, ClientConfiguration clientConfiguration) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider 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'sgetCredentials()
method.- Parameters:
wifToken
- The OAuth/OpenID token from the the Identity ProviderwifProvider
- The name of the Identity Provider (null for OpenID providers)roleArn
- The ARN of the IAM Role that will be assumedclientConfiguation
- Configuration to apply to STS client created
-
WebIdentityFederationSessionCredentialsProvider
public WebIdentityFederationSessionCredentialsProvider(String wifToken, String wifProvider, String roleArn, AWSSecurityTokenService stsClient) Constructs a new WebIdentityFederationSessionCredentialsProvider, which will use the specified 3rd-party web identity provider to make a request to the AWS Security Token Service (STS) using the provided client to request short lived session credentials, which will then be returned by this class'sgetCredentials()
method.- Parameters:
wifToken
- The OAuth/OpenID token from the the Identity ProviderwifProvider
- The name of the Identity Provider (null for OpenID providers)roleArn
- The ARN of the IAM Role that will be assumedstsClient
- Preconfigured STS client to make requests with
-
-
Method Details
-
getCredentials
Description copied from interface: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.- Specified by:
getCredentials
in interfaceAWSCredentialsProvider
- Specified by:
getCredentials
in interfaceAWSSessionCredentialsProvider
- Returns:
- AWSCredentials which the caller can use to authorize an AWS request.
-
refresh
public void refresh()Description copied from interface: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.- Specified by:
refresh
in interfaceAWSCredentialsProvider
-
setSessionDuration
public void setSessionDuration(int sessionDuration) Set the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest.- Parameters:
sessionDuration
- The new duration for session credentials created by this provider- See Also:
-
withSessionDuration
Set the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest. Returns refreence to object so methods can be chained together.- Parameters:
sessionDuration
- The new duration for session credentials created by this provider- Returns:
- A reference to this updated object so that method calls can be chained together.
- See Also:
-
getSessionDuration
public int getSessionDuration()Get the duration of the session credentials created by this client in seconds. Values must be supported by AssumeRoleWithWebIdentityRequest.- Returns:
- The duration for session credentials created by this provider
- See Also:
-
setRefreshThreshold
public void setRefreshThreshold(int refreshThreshold) Set the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS.- Parameters:
refreshThreshold
- The new refresh threshold for session credentials created by this provider- See Also:
-
withRefreshThreshold
Set the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS. Returns a refrence to the object so methods can be chained.- Parameters:
refreshThreshold
- The new refresh threshold for session credentials created by this provider- Returns:
- A reference to this updated object so that method calls can be chained together.
- See Also:
-
getRefreshThreshold
public int getRefreshThreshold()Get the refresh threshold for the session credentials created by this client in seconds. This value will be used internally to determine if new credentials should be fetched from STS.- Returns:
- The refresh threshold for session credentials created by this provider
- See Also:
-
getSubjectFromWIF
Get the identifier returned from the Identity Provider for the authenticated user. This value is returned as part of the AssumeRoleWithIdentityResult- Returns:
- The identifier returned from Identity Provider
- See Also:
-