com.amazonaws.services.eks

Class AmazonEKSAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.eks.AmazonEKSClient

com.amazonaws.services.eks.AmazonEKSAsyncClient

All Implemented Interfaces:

AmazonEKS, AmazonEKSAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEKSAsyncClient
extends AmazonEKSClient
implements AmazonEKSAsync

Client for accessing Amazon EKS asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.eks.AmazonEKS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonEKSAsyncClientBuilder	asyncBuilder()
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request) Creates an Amazon EKS control plane.
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler) Creates an Amazon EKS control plane.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request) Deletes the Amazon EKS cluster control plane.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler) Deletes the Amazon EKS cluster control plane.
Future<DescribeClusterResult>	describeClusterAsync(DescribeClusterRequest request) Returns descriptive information about an Amazon EKS cluster.
Future<DescribeClusterResult>	describeClusterAsync(DescribeClusterRequest request, AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler) Returns descriptive information about an Amazon EKS cluster.
Future<DescribeUpdateResult>	describeUpdateAsync(DescribeUpdateRequest request) Returns descriptive information about an update against your Amazon EKS cluster.
Future<DescribeUpdateResult>	describeUpdateAsync(DescribeUpdateRequest request, AsyncHandler<DescribeUpdateRequest,DescribeUpdateResult> asyncHandler) Returns descriptive information about an update against your Amazon EKS cluster.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request) Lists the Amazon EKS clusters in your AWS account in the specified Region.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler) Lists the Amazon EKS clusters in your AWS account in the specified Region.
Future<ListUpdatesResult>	listUpdatesAsync(ListUpdatesRequest request) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
Future<ListUpdatesResult>	listUpdatesAsync(ListUpdatesRequest request, AsyncHandler<ListUpdatesRequest,ListUpdatesResult> asyncHandler) Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<UpdateClusterConfigResult>	updateClusterConfigAsync(UpdateClusterConfigRequest request) Updates an Amazon EKS cluster configuration.
Future<UpdateClusterConfigResult>	updateClusterConfigAsync(UpdateClusterConfigRequest request, AsyncHandler<UpdateClusterConfigRequest,UpdateClusterConfigResult> asyncHandler) Updates an Amazon EKS cluster configuration.
Future<UpdateClusterVersionResult>	updateClusterVersionAsync(UpdateClusterVersionRequest request) Updates an Amazon EKS cluster to the specified Kubernetes version.
Future<UpdateClusterVersionResult>	updateClusterVersionAsync(UpdateClusterVersionRequest request, AsyncHandler<UpdateClusterVersionRequest,UpdateClusterVersionResult> asyncHandler) Updates an Amazon EKS cluster to the specified Kubernetes version.

Methods inherited from class com.amazonaws.services.eks.AmazonEKSClient

builder, createCluster, deleteCluster, describeCluster, describeUpdate, getCachedResponseMetadata, listClusters, listUpdates, updateClusterConfig, updateClusterVersion, waiters

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.eks.AmazonEKS

createCluster, deleteCluster, describeCluster, describeUpdate, getCachedResponseMetadata, listClusters, listUpdates, updateClusterConfig, updateClusterVersion, waiters

Method Detail

asyncBuilder

public static AmazonEKSAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

createClusterAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.

See Also:

AWS API Documentation

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request,
                                                      AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

createClusterAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

deleteClusterAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request,
                                                      AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

deleteClusterAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

describeClusterAsync

public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

describeClusterAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.

See Also:

AWS API Documentation

describeClusterAsync

public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request,
                                                          AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

describeClusterAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.

See Also:

AWS API Documentation

describeUpdateAsync

public Future<DescribeUpdateResult> describeUpdateAsync(DescribeUpdateRequest request)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

describeUpdateAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the DescribeUpdate operation returned by the service.

See Also:

AWS API Documentation

describeUpdateAsync

public Future<DescribeUpdateResult> describeUpdateAsync(DescribeUpdateRequest request,
                                                        AsyncHandler<DescribeUpdateRequest,DescribeUpdateResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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.

Specified by:

describeUpdateAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeUpdate operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)

Description copied from interface: AmazonEKSAsync

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

Specified by:

listClustersAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request,
                                                    AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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

Specified by:

listClustersAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.

See Also:

AWS API Documentation

listUpdatesAsync

public Future<ListUpdatesResult> listUpdatesAsync(ListUpdatesRequest request)

Description copied from interface: AmazonEKSAsync

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

Specified by:

listUpdatesAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the ListUpdates operation returned by the service.

See Also:

AWS API Documentation

listUpdatesAsync

public Future<ListUpdatesResult> listUpdatesAsync(ListUpdatesRequest request,
                                                  AsyncHandler<ListUpdatesRequest,ListUpdatesResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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

Specified by:

listUpdatesAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUpdates operation returned by the service.

See Also:

AWS API Documentation

updateClusterConfigAsync

public Future<UpdateClusterConfigResult> updateClusterConfigAsync(UpdateClusterConfigRequest request)

Description copied from interface: AmazonEKSAsync

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 .

Specified by:

updateClusterConfigAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the UpdateClusterConfig operation returned by the service.

See Also:

AWS API Documentation

updateClusterConfigAsync

public Future<UpdateClusterConfigResult> updateClusterConfigAsync(UpdateClusterConfigRequest request,
                                                                  AsyncHandler<UpdateClusterConfigRequest,UpdateClusterConfigResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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 .

Specified by:

updateClusterConfigAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateClusterConfig operation returned by the service.

See Also:

AWS API Documentation

updateClusterVersionAsync

public Future<UpdateClusterVersionResult> updateClusterVersionAsync(UpdateClusterVersionRequest request)

Description copied from interface: AmazonEKSAsync

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 .

Specified by:

updateClusterVersionAsync in interface AmazonEKSAsync

Returns:

A Java Future containing the result of the UpdateClusterVersion operation returned by the service.

See Also:

AWS API Documentation

updateClusterVersionAsync

public Future<UpdateClusterVersionResult> updateClusterVersionAsync(UpdateClusterVersionRequest request,
                                                                    AsyncHandler<UpdateClusterVersionRequest,UpdateClusterVersionResult> asyncHandler)

Description copied from interface: AmazonEKSAsync

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 .

Specified by:

updateClusterVersionAsync in interface AmazonEKSAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateClusterVersion operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonEKS

Overrides:

shutdown in class AmazonEKSClient