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.

AWS Credentials that automatically refresh by calling AssumeRole on the Amazon Security Token Service.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AWSCredentials
    Amazon.Runtime.RefreshingAWSCredentials
      Amazon.Runtime.AssumeRoleAWSCredentials

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

Syntax

C# 
public class AssumeRoleAWSCredentials : RefreshingAWSCredentials
         IDisposable

The AssumeRoleAWSCredentials type exposes the following members

Constructors

NameDescription
Public Method AssumeRoleAWSCredentials(AWSCredentials, string, string)

Constructs an AssumeRoleAWSCredentials object.

Public Method AssumeRoleAWSCredentials(AWSCredentials, string, string, AssumeRoleAWSCredentialsOptions)

Constructs an AssumeRoleAWSCredentials object.

Properties

NameTypeDescription
Public Property Options Amazon.Runtime.AssumeRoleAWSCredentialsOptions

Options to be used in the call to AssumeRole.

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

The Amazon Resource Name (ARN) of the role to assume.

Public Property RoleSessionName System.String

An identifier for the assumed role session.

Public Property SourceCredentials Amazon.Runtime.AWSCredentials

The credentials of the user that will be used to call AssumeRole.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5