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.

This class allows profiles supporting AWSCredentials to be registered with the SDK so that they can later be reference by a profile name. The credential profiles will be available for use in the AWS Toolkit for Visual Studio and the AWS Tools for Windows PowerShell.

The credentials are stored under the current users AppData folder encrypted using Windows Data Protection API.

This class is not threadsafe.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.CredentialManagement.NetSDKCredentialsFile

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

Syntax

C#
public class NetSDKCredentialsFile
         ICredentialProfileSource, ICredentialProfileStore

The NetSDKCredentialsFile type exposes the following members

Constructors

NameDescription
Public Method NetSDKCredentialsFile()

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 CopyProfile(string, string)

Make a copy of the profile with fromProfileName called toProfileName.

Public Method CopyProfile(string, string, bool)

Make a copy of the profile with fromProfileName called toProfileName.

Public Method ListProfileNames()
Public Method ListProfiles()
Public Method RegisterProfile(CredentialProfile)

Add the profile to this store, if it's valid.

Public Method RenameProfile(string, string)

Rename the profile with oldProfileName to newProfileName.

Public Method RenameProfile(string, string, bool)

Rename the profile with oldProfileName to newProfileName.

Public Method TryGetProfile(string, out CredentialProfile)

Get the profile with the name given, if it exists in this store.

Public Method UnregisterProfile(string)

If there is a profile in the store with the given name, delete it.

Fields

NameTypeDescription
Field Static Field DefaultProfileName System.String

Version Information

.NET Standard:
Supported in: 1.3

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