Accessing credentials and profiles in an application - Amazon SDK for .NET
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Accessing credentials and profiles in an application

The preferred method for using credentials is to allow the Amazon SDK for .NET to find and retrieve them for you, as described in Credential and profile resolution.

However, you can also configure your application to actively retrieve profiles and credentials, and then explicitly use those credentials when creating an Amazon service client.

To actively retrieve profiles and credentials, use classes from the Amazon.Runtime.CredentialManagement namespace.

  • To find a profile in a file that uses the Amazon credentials file format (either the shared Amazon credentials file in its default location or a custom credentials file), use the SharedCredentialsFile class. Files in this format are sometimes simply called credentials files in this text for brevity.

  • To find a profile in the SDK Store, use the NetSDKCredentialsFile class.

  • To search in both a credentials file and the SDK Store, depending on the configuration of a class property, use the CredentialProfileStoreChain class.

    You can use this class to find profiles. You can also use this class to request Amazon credentials directly instead of using the AWSCredentialsFactory class (described next).

  • To retrieve or create various types of credentials from a profile, use the AWSCredentialsFactory class.

The following sections provide examples for these classes.

Examples for class CredentialProfileStoreChain

You can get credentials or profiles from the CredentialProfileStoreChain class by using the TryGetAWSCredentials or TryGetProfile methods. The ProfilesLocation property of the class determines the behavior of the methods, as follows:

  • If ProfilesLocation is null or empty, search the SDK Store if the platform supports it, and then search the shared Amazon credentials file in the default location.

  • If the ProfilesLocation property contains a value, search the credentials file specified in the property.

Get credentials from the SDK Store or the shared Amazon credentials file

This example shows you how to get credentials by using the CredentialProfileStoreChain class and then use the credentials to create an AmazonS3Client object. The credentials can come from the SDK Store or from the shared Amazon credentials file at the default location.

This example also uses the Amazon.Runtime.AWSCredentials class.

var chain = new CredentialProfileStoreChain(); AWSCredentials awsCredentials; if (chain.TryGetAWSCredentials("some_profile", out awsCredentials)) { // Use awsCredentials to create an Amazon S3 service client using (var client = new AmazonS3Client(awsCredentials)) { var response = await client.ListBucketsAsync(); Console.WriteLine($"Number of buckets: {response.Buckets.Count}"); } }

Get a profile from the SDK Store or the shared Amazon credentials file

This example shows you how to get a profile by using the CredentialProfileStoreChain class. The credentials can come from the SDK Store or from the shared Amazon credentials file at the default location.

This example also uses the CredentialProfile class.

var chain = new CredentialProfileStoreChain(); CredentialProfile basicProfile; if (chain.TryGetProfile("basic_profile", out basicProfile)) { // Use basicProfile }

Get credentials from a custom credentials file

This example shows you how to get credentials by using the CredentialProfileStoreChain class. The credentials come from a file that uses the Amazon credentials file format but is at an alternate location.

This example also uses the Amazon.Runtime.AWSCredentials class.

var chain = new CredentialProfileStoreChain("c:\\Users\\sdkuser\\customCredentialsFile.ini"); AWSCredentials awsCredentials; if (chain.TryGetAWSCredentials("basic_profile", out awsCredentials)) { // Use awsCredentials to create an AWS service client }

Examples for classes SharedCredentialsFile and AWSCredentialsFactory

Create an AmazonS3Client by using the SharedCredentialsFile class

This examples shows you how to find a profile in the shared Amazon credentials file, create Amazon credentials from the profile, and then use the credentials to create an AmazonS3Client object. The example uses the SharedCredentialsFile class.

This example also uses the CredentialProfile class and the Amazon.Runtime.AWSCredentials class.

CredentialProfile basicProfile; AWSCredentials awsCredentials; var sharedFile = new SharedCredentialsFile(); if (sharedFile.TryGetProfile("basic_profile", out basicProfile) && AWSCredentialsFactory.TryGetAWSCredentials(basicProfile, sharedFile, out awsCredentials)) { // use awsCredentials to create an Amazon S3 service client using (var client = new AmazonS3Client(awsCredentials, basicProfile.Region)) { var response = await client.ListBucketsAsync(); Console.WriteLine($"Number of buckets: {response.Buckets.Count}"); } }
Note

The NetSDKCredentialsFile class can be used in exactly the same way, except you would instantiate a new NetSDKCredentialsFile object instead of a SharedCredentialsFile object.