3.1093.0 • Published 23m ago

@aws-sdk/client-eks

Licence

Apache-2.0

Version

3.1093.0

Deps

Size

1.5 MB

Vulns

Weekly

Stars

3.6K

Summary Dependency Versions

@aws-sdk/client-eks

Description

AWS SDK for JavaScript EKS Client for Node.js, Browser and React Native.

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-eks
yarn add @aws-sdk/client-eks
pnpm add @aws-sdk/client-eks

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the EKSClient and the commands you need, for example ListAddonsCommand:

// ES5 example
const { EKSClient, ListAddonsCommand } = require("@aws-sdk/client-eks");

// ES6+ example
import { EKSClient, ListAddonsCommand } from "@aws-sdk/client-eks";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new EKSClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListAddonsCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

EKS extends EKSClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (EKSClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { EKS } from "@aws-sdk/client-eks";

const client = new EKS({ region: "REGION" });

// async/await.
try {
  const data = await client.listAddons(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAddons(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listAddons(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

AssociateEncryptionConfig