AWS SDK Version 2 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.

.NET Framework 4.5
 
 
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
        Amazon.Runtime.AssumeRoleAWSCredentials

Namespace: Amazon.Runtime
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class AssumeRoleAWSCredentials : STSAssumeRoleAWSCredentials
         IDisposable

The AssumeRoleAWSCredentials type exposes the following members

Constructors

NameDescription
Public Method AssumeRoleAWSCredentials(IAmazonSecurityTokenService, AssumeRoleRequest) Instantiates AssumeRoleAWSCredentials which automatically assumes a specified role. The credentials are refreshed before expiration.
Public Method AssumeRoleAWSCredentials(AssumeRoleWithSAMLRequest) Instantiates AssumeRoleAWSCredentials which automatically assumes a specified SAML role. The credentials are refreshed before expiration.

Properties

NameTypeDescription
Public Property PreemptExpiryTime System.TimeSpan The time before actual expiration to expire the credentials. Property cannot be set to a negative TimeSpan.

Methods

NameDescription
Public Method Dispose() Inherited from Amazon.SecurityToken.STSAssumeRoleAWSCredentials.
Public Method GetCredentials() Returns an instance of ImmutableCredentials for this instance
Public Method GetCredentialsAsync()

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8