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.

Factory to construct different types of AWSCredentials based on a profile.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.CredentialManagement.AWSCredentialsFactory

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

Syntax

C# 
public static class AWSCredentialsFactory

The AWSCredentialsFactory type exposes the following members

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 Static Method GetAWSCredentials(CredentialProfile, ICredentialProfileSource)

Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for a list of AWSCredentials returned by this method.

Public Method Static Method GetAWSCredentials(CredentialProfileOptions, ICredentialProfileSource)

Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for a list of AWSCredentials returned by this method.

Public Method Static Method GetAWSCredentials(CredentialProfile, ICredentialProfileSource, bool)

Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for a list of AWSCredentials returned by this method.

Public Method Static Method GetAWSCredentials(CredentialProfileOptions, ICredentialProfileSource, bool)

Gets the AWSCredentials for this profile if CanCreateAWSCredentials is true and AWSCredentials can be created. Throws an exception otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for a list of AWSCredentials returned by this method.

Public Method Static Method TryGetAWSCredentials(CredentialProfile, ICredentialProfileSource, out AWSCredentials)

Return the credentials for the profile if valid credentials can created.

Public Method Static Method TryGetAWSCredentials(CredentialProfileOptions, ICredentialProfileSource, out AWSCredentials)

Return the credentials for the profile if valid credentials can created.

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