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

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 DescribeUpdateResponse	describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest) Returns descriptive information about an update against your Amazon EKS cluster.
default DescribeUpdateResponse	describeUpdate(DescribeUpdateRequest describeUpdateRequest) Returns descriptive information about an update against your 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.
default ListClustersIterable	listClustersPaginator() Lists the Amazon EKS clusters in your AWS account in the specified Region.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) Lists the Amazon EKS clusters in your AWS account in the specified Region.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your AWS account in the specified Region.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon EKS resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon EKS resource.
default ListUpdatesResponse	listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
default ListUpdatesResponse	listUpdates(ListUpdatesRequest listUpdatesRequest) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
default ListUpdatesIterable	listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
default ListUpdatesIterable	listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.
default UpdateClusterConfigResponse	updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.
default UpdateClusterConfigResponse	updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.
default UpdateClusterVersionResponse	updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.
default UpdateClusterVersionResponse	updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.

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

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

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.

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

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

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

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.

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

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

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

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 aren't 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. 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.

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 aren't 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. 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.

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

describeUpdate

default DescribeUpdateResponse describeUpdate(DescribeUpdateRequest describeUpdateRequest)
                                       throws InvalidParameterException,
                                              ClientException,
                                              ServerException,
                                              ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              EksException

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Parameters:

describeUpdateRequest -

Returns:

Result of the DescribeUpdate 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. 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.

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

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

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

describeUpdate

default DescribeUpdateResponse describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest)
                                       throws InvalidParameterException,
                                              ClientException,
                                              ServerException,
                                              ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              EksException

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

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

Parameters:

describeUpdateRequest - A Consumer that will call methods on DescribeUpdateRequest.Builder to create a request.

Returns:

Result of the DescribeUpdate 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. 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.

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

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

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

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

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

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

listClustersPaginator

default ListClustersIterable listClustersPaginator()
                                            throws InvalidParameterException,
                                                   ClientException,
                                                   ServerException,
                                                   ServiceUnavailableException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   EksException

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

This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

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:

listClustersPaginator(ListClustersRequest), AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest 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 variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

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

listClustersPaginator

default ListClustersIterable listClustersPaginator(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 variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.

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:

A custom iterable that can be used to iterate through all the response pages.

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

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

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws BadRequestException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        EksException

List the tags for an Amazon EKS resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

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

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws BadRequestException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        EksException

List the tags for an Amazon EKS resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource 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.

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

listUpdates

default ListUpdatesResponse listUpdates(ListUpdatesRequest listUpdatesRequest)
                                 throws InvalidParameterException,
                                        ClientException,
                                        ServerException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        EksException

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

Parameters:

listUpdatesRequest -

Returns:

Result of the ListUpdates 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. 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.

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

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

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

listUpdates

default ListUpdatesResponse listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)
                                 throws InvalidParameterException,
                                        ClientException,
                                        ServerException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        EksException

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

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

Parameters:

listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.

Returns:

Result of the ListUpdates 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. 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.

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

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

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

listUpdatesPaginator

default ListUpdatesIterable listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest)
                                          throws InvalidParameterException,
                                                 ClientException,
                                                 ServerException,
                                                 ResourceNotFoundException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 EksException

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
     for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation.

Parameters:

listUpdatesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

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

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

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

listUpdatesPaginator

default ListUpdatesIterable listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)
                                          throws InvalidParameterException,
                                                 ClientException,
                                                 ServerException,
                                                 ResourceNotFoundException,
                                                 AwsServiceException,
                                                 SdkClientException,
                                                 EksException

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
     for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation.

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

Parameters:

listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

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

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

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

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws BadRequestException,
                                        NotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        EksException

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.

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.

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

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws BadRequestException,
                                        NotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        EksException

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.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

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.

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

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws BadRequestException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

Deletes specified tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.

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

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws BadRequestException,
                                            NotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            EksException

Deletes specified tags from a resource.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource 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.

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

updateClusterConfig

default UpdateClusterConfigResponse updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)
                                                 throws InvalidParameterException,
                                                        ClientException,
                                                        ServerException,
                                                        ResourceInUseException,
                                                        ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        EksException

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 .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

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 .

Parameters:

updateClusterConfigRequest -

Returns:

Result of the UpdateClusterConfig 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. 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.

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

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.

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

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

updateClusterConfig

default UpdateClusterConfigResponse updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest)
                                                 throws InvalidParameterException,
                                                        ClientException,
                                                        ServerException,
                                                        ResourceInUseException,
                                                        ResourceNotFoundException,
                                                        InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        EksException

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 .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

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 .

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

Parameters:

updateClusterConfigRequest - A Consumer that will call methods on UpdateClusterConfigRequest.Builder to create a request.

Returns:

Result of the UpdateClusterConfig 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. 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.

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

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.

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

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

updateClusterVersion

default UpdateClusterVersionResponse updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)
                                                   throws InvalidParameterException,
                                                          ClientException,
                                                          ServerException,
                                                          ResourceInUseException,
                                                          ResourceNotFoundException,
                                                          InvalidRequestException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          EksException

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 .

Parameters:

updateClusterVersionRequest -

Returns:

Result of the UpdateClusterVersion 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. 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.

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

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.

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

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

updateClusterVersion

default UpdateClusterVersionResponse updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest)
                                                   throws InvalidParameterException,
                                                          ClientException,
                                                          ServerException,
                                                          ResourceInUseException,
                                                          ResourceNotFoundException,
                                                          InvalidRequestException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          EksException

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 .

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

Parameters:

updateClusterVersionRequest - A Consumer that will call methods on UpdateClusterVersionRequest.Builder to create a request.

Returns:

Result of the UpdateClusterVersion 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. 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.

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

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.

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

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