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.

Uses aws credentials stored in environment variables to construct the credentials object. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used for the access key id and secret key. If the variable AWS_SESSION_TOKEN exists then it will be used to create temporary session credentials.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AWSCredentials
    Amazon.Runtime.EnvironmentVariablesAWSCredentials

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

Syntax

C#
public class EnvironmentVariablesAWSCredentials : AWSCredentials

The EnvironmentVariablesAWSCredentials type exposes the following members

Constructors

NameDescription
Public Method EnvironmentVariablesAWSCredentials()

Constructs an instance of EnvironmentVariablesAWSCredentials. If no credentials are found in the environment variables then an InvalidOperationException is thrown.

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 FetchCredentials()

Creates immutable credentials from environment variables.

Public Method GetCredentials()

Returns an instance of ImmutableCredentials for this instance

Public Method GetCredentialsAsync() Inherited from Amazon.Runtime.AWSCredentials.

Fields

NameTypeDescription
Field Static Field ENVIRONMENT_VARIABLE_ACCESSKEY System.String
Field Static Field ENVIRONMENT_VARIABLE_SECRETKEY System.String
Field Static Field ENVIRONMENT_VARIABLE_SESSION_TOKEN System.String
Field Static Field LEGACY_ENVIRONMENT_VARIABLE_SECRETKEY System.String

Remarks

For backwards compatibility the class will also attempt to discover the secret key from the AWS_SECRET_KEY variable, if a value cannot be obtained using the standard AWS_SECRET_ACCESS_KEY variable.

Version Information

.NET Standard:
Supported in: 1.3

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