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

Credentials that are retrieved from the Instance Profile service on an EC2 instance

Inheritance Hierarchy

System.Object
  Amazon.Runtime.Identity.BaseIdentity
    Amazon.Runtime.AWSCredentials
      Amazon.Runtime.RefreshingAWSCredentials
        Amazon.Runtime.URIBasedRefreshingCredentialHelper
          Amazon.Runtime.InstanceProfileAWSCredentials

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

Syntax

C#
public class InstanceProfileAWSCredentials : URIBasedRefreshingCredentialHelper
         IDisposable

The InstanceProfileAWSCredentials type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Expiration System.Nullable<System.DateTime> Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Property PreemptExpiryTime System.TimeSpan Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Property Role System.String

Role for which the credentials are retrieved

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method ClearCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method Dispose() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method Static Method GetAvailableRoles()

Retrieves a list of all roles available through current InstanceProfile service

Public Method Static Method GetAvailableRoles(IWebProxy)

Retrieves a list of all roles available through current InstanceProfile service

Public Method Static Method GetAvailableRolesAsync(IWebProxy)

Retrieves a list of all roles available through current InstanceProfile service

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

Remarks

This is meant to be used when building a Amazon.Runtime.AmazonServiceClient, as opposed to Amazon.Runtime.DefaultInstanceProfileAWSCredentials, which is part of the Amazon.Runtime.FallbackCredentialsFactory chain.

Version Information

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

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer