AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class FederatedAWSCredentials : RefreshingAWSCredentials

The FederatedAWSCredentials type exposes the following members

Constructors

NameDescription
Public Method FederatedAWSCredentials(SAMLEndpoint, string)

Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials to authenticate the user/process and obtain temporary AWS credentials.

Public Method FederatedAWSCredentials(SAMLEndpoint, string, FederatedAWSCredentialsOptions)

Constructs an instance of FederatedAWSCredentials. After construction call GetCredentials to authenticate the user/process and obtain temporary AWS credentials.

Properties

NameTypeDescription
Public Property Options Amazon.Runtime.FederatedAWSCredentialsOptions

The options used for authentication. See Amazon.Runtime.FederatedAWSCredentialsOptions for details about available options.

Public Property PreemptExpiryTime System.TimeSpan Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Property RoleArn System.String

The role ARN used for authentication.

Public Property 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.

NameDescription
Public Method ClearCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method 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 Framework:
Supported in: 4.5, 4.0, 3.5