STSAssumeRoleAWSCredentials Class

Credentials that are retrieved by invoking AWS Security Token Service AssumeRole or AssumeRoleWithSAML action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AWSCredentials
    Amazon.Runtime.RefreshingAWSCredentials
      Amazon.SecurityToken.STSAssumeRoleAWSCredentials

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

Syntax

[Obsolete("This class has been replaced by Amazon.Runtime.AssumeRoleAWSCredentials and Amazon.Runtime.StoredProfileFederatedCredentials, and will be removed in a future version.", false)]
public class STSAssumeRoleAWSCredentials : RefreshingAWSCredentials
         IDisposable

The STSAssumeRoleAWSCredentials type exposes the following members

Constructors

	Name	Description
	STSAssumeRoleAWSCredentials(IAmazonSecurityTokenService, AssumeRoleRequest)	Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified role. The credentials are refreshed before expiration.
	STSAssumeRoleAWSCredentials(AssumeRoleWithSAMLRequest)	Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified SAML role. The credentials are refreshed before expiration.

Properties

	Name	Type	Description
	PreemptExpiryTime	System.TimeSpan	Inherited from Amazon.Runtime.RefreshingAWSCredentials.

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()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	Dispose()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	GetCredentials()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	GetCredentialsAsync()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.

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