Interface ICredentialProfileStore

Namespace

Amazon.Runtime.CredentialManagement

Assembly

AWSSDK.Core.dll

Interface to define the necessary operations for a CredentialProfile storage mechanism.

public interface ICredentialProfileStore : ICredentialProfileSource

Inherited Members

ICredentialProfileSource.TryGetProfile(string, out CredentialProfile)

Methods

CopyProfile(string, string)

Make a copy of the profile with fromProfileName called toProfileName.

void CopyProfile(string fromProfileName, string toProfileName)

Parameters

fromProfileName string

The name of the profile to copy from.

toProfileName string

The name of the new profile.

CopyProfile(string, string, bool)

Make a copy of the profile with fromProfileName called toProfileName.

void CopyProfile(string fromProfileName, string toProfileName, bool force)

Parameters

fromProfileName string

The name of the profile to copy from.

toProfileName string

The name of the new profile.

force bool

If true and the destination profile exists it will be overwritten.

ListProfileNames()

Get a list of valid profile names from this store. Invalid profiles are ignored. See CredentialProfileOptions for more information about valid profiles.

List<string> ListProfileNames()

Returns

List<string>

ListProfiles()

Get a list of valid profiles from this store. Invalid profiles are ignored. See CredentialProfileOptions for more information about valid profiles.

List<CredentialProfile> ListProfiles()

Returns

List<CredentialProfile>

RegisterProfile(CredentialProfile)

Add the given profile to the store, or update it if one with the same name already exists.

void RegisterProfile(CredentialProfile profile)

Parameters

profile CredentialProfile

RenameProfile(string, string)

Rename the profile with oldProfileName to newProfileName.

void RenameProfile(string oldProfileName, string newProfileName)

Parameters

oldProfileName string

The profile to rename.

newProfileName string

The new name for the profile.

RenameProfile(string, string, bool)

Rename the profile with oldProfileName to newProfileName.

void RenameProfile(string oldProfileName, string newProfileName, bool force)

Parameters

oldProfileName string

The profile to rename.

newProfileName string

The new name for the profile.

force bool

If true and the destination profile exists it will be overwritten.

UnregisterProfile(string)

Delete the profile with profileName if it exists.

void UnregisterProfile(string profileName)

Parameters

profileName string

The name of the profile to delete.