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.AssumeRoleWithWebIdentityCredentials

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

Syntax

C# 
public class AssumeRoleWithWebIdentityCredentials : RefreshingAWSCredentials
         IDisposable

The AssumeRoleWithWebIdentityCredentials type exposes the following members

Constructors

NameDescription
Public Method AssumeRoleWithWebIdentityCredentials(string, string, string)

Constructs an AssumeRoleWithWebIdentityCredentials object.

Public Method AssumeRoleWithWebIdentityCredentials(string, string, string, AssumeRoleWithWebIdentityCredentialsOptions)

Constructs an AssumeRoleWithWebIdentityCredentials object.

Properties

NameTypeDescription
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 WebIdentityTokenFile System.String

The absolute path to the file on disk containing an OIDC token

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 Static Method FromEnvironmentVariables()

Creates an instance of Amazon.Runtime.AssumeRoleWithWebIdentityCredentials from environment variables.

Public Method GetCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentialsAsync() Inherited from Amazon.Runtime.RefreshingAWSCredentials.

Fields

NameTypeDescription
Field Static Field RoleArnEnvVariable System.String
Field Static Field RoleSessionNameEnvVariable System.String
Field Static Field WebIdentityTokenFileEnvVariable System.String

As established by STS, the regex used to validate the role session names is a string of 2-64 characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

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