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

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.

Method Detail

createCluster

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
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. Each Amazon EKS cluster control plane is single-tenant and
unique and runs on its own set of Amazon EC2 instances.

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

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.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or
disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is
enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide.

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs
for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs.
For more information, see Amazon EKS Cluster Control Plane
Logs in the Amazon EKS User Guide.

Cluster creation typically takes between 10 and 15 minutes. 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 Nodes
in the Amazon EKS User Guide.

ClientException - These errors are usually caused by a client action. Actions can include 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.

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.

createFargateProfile

Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a
cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on
which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five
selectors that contain a namespace and labels. A namespace is required for every selector. The label field
consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a
to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled
with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet that is running on the Fargate infrastructure can register with
your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
information, see Pod Execution
Role in the Amazon EKS User Guide.

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and
then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate
profile to finish deleting before you can create any other profiles in that cluster.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated
operations.

ClientException - These errors are usually caused by a client action. Actions can include 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.

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.

createNodegroup

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster
that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI
release version for the respective minor Kubernetes version of the cluster.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are
managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS-optimized Amazon Linux
2 AMI. For more information, see Managed Node Groups in the
Amazon EKS User Guide.

ClientException - These errors are usually caused by a client action. Actions can include 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.

deleteCluster

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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

deleteFargateProfile

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If
those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer
match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.

Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

describeCluster

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 aren't available until the cluster reaches the
ACTIVE state.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

ClientException - These errors are usually caused by a client action. Actions can include 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.

tagResource

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate
to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that
tag does not automatically propagate to the subnets and worker nodes associated with the cluster.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the
API, and will be documented in the error message.

NotFoundException - A service resource associated with the request could not be found. Clients should not retry such
requests.

updateClusterConfig

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response
output includes an update ID that you can use to track the status of your cluster update with the
DescribeUpdate API operation.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster
to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more
information, see Amazon EKS
Cluster Control Plane Logs in the Amazon EKS User Guide.

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes
API server endpoint. By default, public access is enabled, and private access is disabled. For more information,
see Amazon EKS Cluster Endpoint
Access Control in the Amazon EKS User Guide.

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.

ClientException - These errors are usually caused by a client action. Actions can include 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.

updateClusterVersion

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the
update. The response output includes an update ID that you can use to track the status of your cluster update
with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match
the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

ClientException - These errors are usually caused by a client action. Actions can include 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.

updateNodegroupConfig

Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update.
The response output includes an update ID that you can use to track the status of your node group update with the
DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the
scaling configuration.

Parameters:

updateNodegroupConfigRequest -

Returns:

Result of the UpdateNodegroupConfig operation returned by the service.

ClientException - These errors are usually caused by a client action. Actions can include 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.

updateNodegroupVersion

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

You can update to the latest available AMI version of a node group's current Kubernetes version by not specifying
a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current
Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS-Optimized Linux
AMI Versions in the Amazon EKS User Guide.

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are
drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget
issue.

Parameters:

updateNodegroupVersionRequest -

Returns:

Result of the UpdateNodegroupVersion operation returned by the service.

ClientException - These errors are usually caused by a client action. Actions can include 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.

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

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.