software.amazon.awssdk.services.eks

Interface EksClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface EksClient
extends SdkClient

Service client for accessing Amazon EKS. This can be created using the static builder() method.

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	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static EksClientBuilder	builder() Create a builder that can be used to configure and create a EksClient.
static EksClient	create() Create a EksClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates an Amazon EKS control plane.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest) Creates an Amazon EKS control plane.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the Amazon EKS cluster control plane.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the Amazon EKS cluster control plane.
default DescribeClusterResponse	describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) Returns descriptive information about an Amazon EKS cluster.
default DescribeClusterResponse	describeCluster(DescribeClusterRequest describeClusterRequest) Returns descriptive information about an Amazon EKS cluster.
default ListClustersResponse	listClusters() Lists the Amazon EKS clusters in your AWS account in the specified Region.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) Lists the Amazon EKS clusters in your AWS account in the specified Region.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your AWS account in the specified Region.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static EksClient create()

Create a EksClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static EksClientBuilder builder()

Create a builder that can be used to configure and create a EksClient.

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ResourceInUseException,
                                            ResourceLimitExceededException,
                                            InvalidParameterException,
                                            ClientException,
                                            ServerException,
                                            ServiceUnavailableException,
                                            UnsupportedAvailabilityZoneException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ResourceInUseException,
                                            ResourceLimitExceededException,
                                            InvalidParameterException,
                                            ClientException,
                                            ServerException,
                                            ServiceUnavailableException,
                                            UnsupportedAvailabilityZoneException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

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.

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ResourceInUseException,
                                            ResourceNotFoundException,
                                            ClientException,
                                            ServerException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ResourceInUseException,
                                            ResourceNotFoundException,
                                            ClientException,
                                            ServerException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

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.

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest)
                                         throws ResourceNotFoundException,
                                                ClientException,
                                                ServerException,
                                                ServiceUnavailableException,
                                                AwsServiceException,
                                                SdkClientException,
                                                EksException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
                                         throws ResourceNotFoundException,
                                                ClientException,
                                                ServerException,
                                                ServiceUnavailableException,
                                                AwsServiceException,
                                                SdkClientException,
                                                EksException

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.

This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need to create one manually via DescribeClusterRequest.builder()

Parameters:

describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters()
                                   throws InvalidParameterException,
                                          ClientException,
                                          ServerException,
                                          ServiceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          EksException

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

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listClusters(ListClustersRequest), AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws InvalidParameterException,
                                          ClientException,
                                          ServerException,
                                          ServiceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          EksException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws InvalidParameterException,
                                          ClientException,
                                          ServerException,
                                          ServiceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          EksException

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

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

EksException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()