com.amazonaws.services.eks

Interface AmazonEKS

All Known Subinterfaces:

AmazonEKSAsync

All Known Implementing Classes:

AbstractAmazonEKS, AbstractAmazonEKSAsync, AmazonEKSAsyncClient, AmazonEKSClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonEKS

Interface for accessing Amazon EKS.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonEKS instead.

Amazon Elastic Container Service for Kubernetes (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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates an Amazon EKS control plane.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the Amazon EKS cluster control plane.
DescribeClusterResult	describeCluster(DescribeClusterRequest describeClusterRequest) Returns descriptive information about an Amazon EKS cluster.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your AWS account in the specified Region.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint.

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodesin the Amazon EKS User Guide.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceLimitExceededException - You have encountered a service limit on the specified resource.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

UnsupportedAvailabilityZoneException - At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

See Also:

AWS API Documentation

deleteCluster

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. Amazon EKS clusters are Region-specific.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

describeCluster

DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data are not available until the cluster reaches the ACTIVE state.

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. Amazon EKS clusters are Region-specific.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

listClusters

ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Lists the Amazon EKS clusters in your AWS account in the specified Region.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.