AWS.EKSAuth — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.EKSAuth

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using EKSAuth

var eksauth = new AWS.EKSAuth();
eksauth.assumeRoleForPodIdentity(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EKSAuth object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var eksauth = new AWS.EKSAuth({apiVersion: '2023-11-26'});

You can also set the API version globally in AWS.config.apiVersions using the eksauth service identifier:

AWS.config.apiVersions = {
  eksauth: '2023-11-26',
  // other service API versions
};

var eksauth = new AWS.EKSAuth();

Constructor Summarycollapse

• new AWS.EKSAuth(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• assumeRoleForPodIdentity(params = {}, callback) ⇒ AWS.Request
  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.
  .
• waitFor(state, params = {}, callback) ⇒ AWS.Request
  Waits for a given EKSAuth resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.EKSAuth(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

assumeRoleForPodIdentity(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given EKSAuth resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.