Class AssumeRoleAWSCredentials

Namespace

Amazon.Runtime

Assembly

AWSSDK.Core.dll

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

public class AssumeRoleAWSCredentials : RefreshingAWSCredentials, IDisposable

Inheritance

object

AWSCredentials

RefreshingAWSCredentials

AssumeRoleAWSCredentials

Implements

IDisposable

Inherited Members

RefreshingAWSCredentials.currentState

RefreshingAWSCredentials.GetCredentials()

RefreshingAWSCredentials.GetCredentialsAsync()

RefreshingAWSCredentials.GenerateNewCredentialsAsync()

RefreshingAWSCredentials.Dispose(bool)

RefreshingAWSCredentials.ClearCredentials()

RefreshingAWSCredentials.Dispose()

RefreshingAWSCredentials.PreemptExpiryTime

RefreshingAWSCredentials.ShouldUpdate

AWSCredentials.Validate()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AssumeRoleAWSCredentials(AWSCredentials, string, string)

Constructs an AssumeRoleAWSCredentials object.

public AssumeRoleAWSCredentials(AWSCredentials sourceCredentials, string roleArn, string roleSessionName)

Parameters

sourceCredentials AWSCredentials

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

roleArn string

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

roleSessionName string

An identifier for the assumed role session.

AssumeRoleAWSCredentials(AWSCredentials, string, string, AssumeRoleAWSCredentialsOptions)

Constructs an AssumeRoleAWSCredentials object.

public AssumeRoleAWSCredentials(AWSCredentials sourceCredentials, string roleArn, string roleSessionName, AssumeRoleAWSCredentialsOptions options)

Parameters

sourceCredentials AWSCredentials

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

roleArn string

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

roleSessionName string

An identifier for the assumed role session.

options AssumeRoleAWSCredentialsOptions

Options to be used in the call to AssumeRole.

Properties

Options

Options to be used in the call to AssumeRole.

public AssumeRoleAWSCredentialsOptions Options { get; }

Property Value

AssumeRoleAWSCredentialsOptions

RoleArn

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

public string RoleArn { get; }

Property Value

string

RoleSessionName

An identifier for the assumed role session.

public string RoleSessionName { get; }

Property Value

string

SourceCredentials

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

public AWSCredentials SourceCredentials { get; }

Property Value

AWSCredentials

Methods

GenerateNewCredentials()

protected override RefreshingAWSCredentials.CredentialsRefreshState GenerateNewCredentials()

Returns

RefreshingAWSCredentials.CredentialsRefreshState