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.

Implementation for accessing EKSAuth

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.EKSAuth.AmazonEKSAuthClient

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

Syntax

C# 
public class AmazonEKSAuthClient : AmazonServiceClient
         IAmazonEKSAuth, IAmazonService, IDisposable

The AmazonEKSAuthClient type exposes the following members

Constructors

NameDescription
Public Method AmazonEKSAuthClient()

Constructs AmazonEKSAuthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonEKSAuthClient(RegionEndpoint)

Constructs AmazonEKSAuthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonEKSAuthClient(AmazonEKSAuthConfig)

Constructs AmazonEKSAuthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonEKSAuthClient(AWSCredentials)

Constructs AmazonEKSAuthClient with AWS Credentials

Public Method AmazonEKSAuthClient(AWSCredentials, RegionEndpoint)

Constructs AmazonEKSAuthClient with AWS Credentials

Public Method AmazonEKSAuthClient(AWSCredentials, AmazonEKSAuthConfig)

Constructs AmazonEKSAuthClient with AWS Credentials and an AmazonEKSAuthClient Configuration object.

Public Method AmazonEKSAuthClient(string, string)

Constructs AmazonEKSAuthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonEKSAuthClient(string, string, RegionEndpoint)

Constructs AmazonEKSAuthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonEKSAuthClient(string, string, AmazonEKSAuthConfig)

Constructs AmazonEKSAuthClient with AWS Access Key ID, AWS Secret Key and an AmazonEKSAuthClient Configuration object.

Public Method AmazonEKSAuthClient(string, string, string)

Constructs AmazonEKSAuthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonEKSAuthClient(string, string, string, RegionEndpoint)

Constructs AmazonEKSAuthClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonEKSAuthClient(string, string, string, AmazonEKSAuthConfig)

Constructs AmazonEKSAuthClient with AWS Access Key ID, AWS Secret Key and an AmazonEKSAuthClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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 AssumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest)

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

Public Method AssumeRoleForPodIdentityAsync(AssumeRoleForPodIdentityRequest, CancellationToken)

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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