This package has been deprecated

Author message:

The package @aws-sdk/client-eks-node has been renamed to @aws-sdk/client-eks. Please install the renamed package.

@aws-sdk/client-eks-node

Description

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up 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 the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-eks-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(EKSClient) and the commands you need, for example CreateClusterCommand:

//JavaScript
const { EKSClient } = require("@aws-sdk/client-eks-node/EKSClient");
const {
  CreateClusterCommand
} = require("@aws-sdk/client-eks-node/commands/CreateClusterCommand");

//TypeScript
import { EKSClient } from "@aws-sdk/client-eks-node/EKSClient";
import { CreateClusterCommand } from "@aws-sdk/client-eks-node/commands/CreateClusterCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const eKS = new EKSClient({region: 'region'});
//clients can be shared by different commands
const params = {
  name: /**a string value*/,
  roleArn: /**a string value*/,
  resourcesVpcConfig: { /**an object specifying resourcesVpcConfig*/ },
};
const createClusterCommand = new CreateClusterCommand(params);
eKS.send(createClusterCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await eKS.send(createClusterCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
eKS.send(createClusterCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-eks-node/EKS";
const eKS = new AWS.EKS({ region: "region" });
eKS.createCluster(params, (err, data) => {
  //do something
});

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 eKS.send(createClusterCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-eks-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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