EnvironmentVariablesAWSCredentials Class | AWS SDK for .NET Version 4

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.Identity.BaseIdentity
    Amazon.Runtime.AWSCredentials
      Amazon.Runtime.EnvironmentVariablesAWSCredentials

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

Syntax

public class EnvironmentVariablesAWSCredentials : AWSCredentials

The EnvironmentVariablesAWSCredentials type exposes the following members

Constructors

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

Properties

	Name	Type	Description
	Expiration	System.Nullable<System.DateTime>	Inherited from Amazon.Runtime.Identity.BaseIdentity.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

	Name	Description
	FetchCredentials()	Creates immutable credentials from environment variables.
	GetCredentials()	Returns an instance of ImmutableCredentials for this instance
	GetCredentialsAsync()	Inherited from Amazon.Runtime.AWSCredentials.

Fields

	Name	Type	Description
	ENVIRONMENT_VARIABLE_ACCESSKEY	System.String
	ENVIRONMENT_VARIABLE_ACCOUNT_ID	System.String
	ENVIRONMENT_VARIABLE_SECRETKEY	System.String
	ENVIRONMENT_VARIABLE_SESSION_TOKEN	System.String
	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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer