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.

When running in an ECS container and AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set, use the given end point to retrieve the credentials.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AWSCredentials
    Amazon.Runtime.RefreshingAWSCredentials
      Amazon.Runtime.URIBasedRefreshingCredentialHelper
        Amazon.Runtime.ECSTaskCredentials

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

Syntax

C# 
[Obsolete("ECSTaskCredentials only supports Amazon ECS, newer versions of the SDK use the GenericContainerCredentials provider (which also supports EKS Pod Identities)")]
public class ECSTaskCredentials : URIBasedRefreshingCredentialHelper
         IDisposable

The ECSTaskCredentials type exposes the following members

Constructors

NameDescription
Public Method ECSTaskCredentials()
Public Method ECSTaskCredentials(IWebProxy)

Properties

NameTypeDescription
Public Property PreemptExpiryTime System.TimeSpan Inherited from Amazon.Runtime.RefreshingAWSCredentials.

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 ClearCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method Dispose() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentials() Inherited from Amazon.Runtime.RefreshingAWSCredentials.
Public Method GetCredentialsAsync() Inherited from Amazon.Runtime.RefreshingAWSCredentials.

Fields

NameTypeDescription
Field Static Field ContainerCredentialsAuthorizationTokenEnvVariable System.String
Field Static Field ContainerCredentialsFullURIEnvVariable System.String
Field Static Field ContainerCredentialsURIEnvVariable System.String

These constants should not be consumed by client code. They are only relevant in the context of ECS container and, especially, AWS_CONTAINER_CREDENTIALS_RELATIVE_URI, AWS_CONTAINER_CREDENTIALS_FULL_URI & AWS_CONTAINER_AUTHORIZATION_TOKEN environment variable should not be overriden by the client code.

Field Static Field EndpointAddress System.String

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5