FederatedAWSCredentials Class | AWS SDK for .NET V3

Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AWSCredentials
    Amazon.Runtime.RefreshingAWSCredentials
      Amazon.Runtime.FederatedAWSCredentials

Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

public class FederatedAWSCredentials : RefreshingAWSCredentials
         IDisposable

The FederatedAWSCredentials type exposes the following members

Constructors

	Name	Description
	FederatedAWSCredentials(SAMLEndpoint, string)	Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials to authenticate the user/process and obtain temporary AWS credentials.
	FederatedAWSCredentials(SAMLEndpoint, string, FederatedAWSCredentialsOptions)	Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials to authenticate the user/process and obtain temporary AWS credentials.

Properties

Name	Type	Description
Options	Amazon.Runtime.FederatedAWSCredentialsOptions	The options used for authentication. See Amazon.Runtime.FederatedAWSCredentialsOptions for details about available options.
PreemptExpiryTime	System.TimeSpan	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
RoleArn	System.String	The role ARN used for authentication.
SAMLEndpoint	Amazon.Runtime.CredentialManagement.SAMLEndpoint	The SAML Endpoint used for authentication.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	ClearCredentials()	Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials.
	Dispose()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	GetCredentials()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	GetCredentialsAsync()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.

Remarks

In order to use the FederatedAWSCredentials class the AWSSDK.SecurityToken assembly must be available to your application at runtime.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5