@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, simply type add or install @aws-sdk/client-eks
using your favorite package manager:
- npm install @aws-sdk/client-eks
- yarn add @aws-sdk/client-eks
- pnpm add @aws-sdk/client-eks

Getting Started

$3

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:

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

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

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new EKSClient({ region: "REGION" });

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

#### Async/await

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

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

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

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

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-eks";
const client = new AWS.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.
client.listAddons(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
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 the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit 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.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-eks` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateAccessPolicy

Command API Reference / Input / Output

AssociateEncryptionConfig

Command API Reference / Input / Output

AssociateIdentityProviderConfig

Command API Reference / Input / Output

CreateAccessEntry

Command API Reference / Input / Output

CreateAddon

Command API Reference / Input / Output

CreateCapability

Command API Reference / Input / Output

CreateCluster

Command API Reference / Input / Output

CreateEksAnywhereSubscription

Command API Reference / Input / Output

CreateFargateProfile

Command API Reference / Input / Output

CreateNodegroup

Command API Reference / Input / Output

CreatePodIdentityAssociation

Command API Reference / Input / Output

DeleteAccessEntry

Command API Reference / Input / Output

DeleteAddon

Command API Reference / Input / Output

DeleteCapability

Command API Reference / Input / Output

DeleteCluster

Command API Reference / Input / Output

DeleteEksAnywhereSubscription

Command API Reference / Input / Output

DeleteFargateProfile

Command API Reference / Input / Output

DeleteNodegroup

Command API Reference / Input / Output

DeletePodIdentityAssociation

Command API Reference / Input / Output

DeregisterCluster

Command API Reference / Input / Output

DescribeAccessEntry

Command API Reference / Input / Output

DescribeAddon

Command API Reference / Input / Output

DescribeAddonConfiguration

Command API Reference / Input / Output

DescribeAddonVersions

Command API Reference / Input / Output

DescribeCapability

Command API Reference / Input / Output

DescribeCluster

Command API Reference / Input / Output

DescribeClusterVersions

Command API Reference / Input / Output

DescribeEksAnywhereSubscription

Command API Reference / Input / Output

DescribeFargateProfile

Command API Reference / Input / Output

DescribeIdentityProviderConfig

Command API Reference / Input / Output

DescribeInsight

Command API Reference / Input / Output

DescribeInsightsRefresh

Command API Reference / Input / Output

DescribeNodegroup

Command API Reference / Input / Output

DescribePodIdentityAssociation

Command API Reference / Input / Output

DescribeUpdate

Command API Reference / Input / Output

DisassociateAccessPolicy

Command API Reference / Input / Output

DisassociateIdentityProviderConfig

Command API Reference / Input / Output

ListAccessEntries

Command API Reference / Input / Output

ListAccessPolicies

Command API Reference / Input / Output

ListAddons

Command API Reference / Input / Output

ListAssociatedAccessPolicies

Command API Reference / Input / Output

ListCapabilities

Command API Reference / Input / Output

ListClusters

Command API Reference / Input / Output

ListEksAnywhereSubscriptions

Command API Reference / Input / Output

ListFargateProfiles

Command API Reference / Input / Output

ListIdentityProviderConfigs

Command API Reference / Input / Output

ListInsights

Command API Reference / Input / Output

ListNodegroups

Command API Reference / Input / Output

ListPodIdentityAssociations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListUpdates

Command API Reference / Input / Output

RegisterCluster

Command API Reference / Input / Output

StartInsightsRefresh

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccessEntry

Command API Reference / Input / Output

UpdateAddon

Command API Reference / Input / Output

UpdateCapability

Command API Reference / Input / Output

UpdateClusterConfig

Command API Reference / Input / Output

UpdateClusterVersion

Command API Reference / Input / Output

UpdateEksAnywhereSubscription

Command API Reference / Input / Output

UpdateNodegroupConfig

Command API Reference / Input / Output

UpdateNodegroupVersion

Command API Reference / Input / Output

UpdatePodIdentityAssociation

Command API Reference / Input / Output