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.

A named group of options that are persisted and used to obtain AWSCredentials.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.CredentialManagement.CredentialProfile

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

Syntax

C#
public class CredentialProfile

The CredentialProfile type exposes the following members

Constructors

NameDescription
Public Method CredentialProfile(string, CredentialProfileOptions)

Construct a new CredentialProfile.

Properties

NameTypeDescription
Public Property CanCreateAWSCredentials System.Boolean

True if the properties of the Options object can be converted into AWSCredentials, false otherwise. See Amazon.Runtime.CredentialManagement.CredentialProfileOptions for more details about which options are available.

Public Property CredentialDescription System.String

If CanCreateAWSCredentials is true, returns a short description of the type of credentials that would be created. If CanCreateAWSCredentials is false, return null.

Public Property CredentialProfileStore Amazon.Runtime.CredentialManagement.ICredentialProfileStore

The Amazon.Runtime.CredentialManagement.ICredentialProfileStore that this Amazon.Runtime.CredentialManagement.CredentialProfile is associated with. Null if this Amazon.Runtime.CredentialManagement.CredentialProfile is not associated with a Amazon.Runtime.CredentialManagement.ICredentialProfileStore.

Public Property Name System.String

The name of the CredentialProfile

Public Property Options Amazon.Runtime.CredentialManagement.CredentialProfileOptions

The options to be used to create AWSCredentials.

Public Property Region Amazon.RegionEndpoint

The region to be used with this CredentialProfile

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 GetAWSCredentials(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.

Version Information

.NET Standard:
Supported in: 1.3

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