AssumeRoleWithWebIdentityCredentials Class

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

public class AssumeRoleWithWebIdentityCredentials : RefreshingAWSCredentials
         IDisposable

The AssumeRoleWithWebIdentityCredentials type exposes the following members

Constructors

	Name	Description
	AssumeRoleWithWebIdentityCredentials(string, string, string)	Constructs an AssumeRoleWithWebIdentityCredentials object.
	AssumeRoleWithWebIdentityCredentials(string, string, string, AssumeRoleWithWebIdentityCredentialsOptions)	Constructs an AssumeRoleWithWebIdentityCredentials object.

Properties

Name	Type	Description
PreemptExpiryTime	System.TimeSpan	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
RoleArn	System.String	The Amazon Resource Name (ARN) of the role to assume.
RoleSessionName	System.String	An identifier for the assumed role session.
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.

	Name	Description
	ClearCredentials()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	Dispose()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	FromEnvironmentVariables()	Creates an instance of Amazon.Runtime.AssumeRoleWithWebIdentityCredentials from environment variables.
	GetCredentials()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.
	GetCredentialsAsync()	Inherited from Amazon.Runtime.RefreshingAWSCredentials.

Fields

Name	Type	Description
RoleArnEnvVariable	System.String
RoleSessionNameEnvVariable	System.String
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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