@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonEKSAsyncClient extends AmazonEKSClient implements AmazonEKSAsync
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
associateEncryptionConfig, associateIdentityProviderConfig, builder, createAddon, createCluster, createFargateProfile, createNodegroup, deleteAddon, deleteCluster, deleteFargateProfile, deleteNodegroup, describeAddon, describeAddonVersions, describeCluster, describeFargateProfile, describeIdentityProviderConfig, describeNodegroup, describeUpdate, disassociateIdentityProviderConfig, getCachedResponseMetadata, listAddons, listClusters, listFargateProfiles, listIdentityProviderConfigs, listNodegroups, listTagsForResource, listUpdates, tagResource, untagResource, updateAddon, updateClusterConfig, updateClusterVersion, updateNodegroupConfig, updateNodegroupVersion, waiters
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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
associateEncryptionConfig, associateIdentityProviderConfig, createAddon, createCluster, createFargateProfile, createNodegroup, deleteAddon, deleteCluster, deleteFargateProfile, deleteNodegroup, describeAddon, describeAddonVersions, describeCluster, describeFargateProfile, describeIdentityProviderConfig, describeNodegroup, describeUpdate, disassociateIdentityProviderConfig, getCachedResponseMetadata, listAddons, listClusters, listFargateProfiles, listIdentityProviderConfigs, listNodegroups, listTagsForResource, listUpdates, tagResource, untagResource, updateAddon, updateClusterConfig, updateClusterVersion, updateNodegroupConfig, updateNodegroupVersion, waiters
public static AmazonEKSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateEncryptionConfigResult> associateEncryptionConfigAsync(AssociateEncryptionConfigRequest request)
AmazonEKSAsync
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new EKS clusters.
associateEncryptionConfigAsync
in interface AmazonEKSAsync
public Future<AssociateEncryptionConfigResult> associateEncryptionConfigAsync(AssociateEncryptionConfigRequest request, AsyncHandler<AssociateEncryptionConfigRequest,AssociateEncryptionConfigResult> asyncHandler)
AmazonEKSAsync
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new EKS clusters.
associateEncryptionConfigAsync
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.public Future<AssociateIdentityProviderConfigResult> associateIdentityProviderConfigAsync(AssociateIdentityProviderConfigRequest request)
AmazonEKSAsync
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider
configuration and associate it to your cluster. After configuring authentication to your cluster you can create
Kubernetes roles
and clusterroles
to assign permissions to the roles, and then bind the
roles to the identities using Kubernetes rolebindings
and clusterrolebindings
. For more
information see Using RBAC
Authorization in the Kubernetes documentation.
associateIdentityProviderConfigAsync
in interface AmazonEKSAsync
public Future<AssociateIdentityProviderConfigResult> associateIdentityProviderConfigAsync(AssociateIdentityProviderConfigRequest request, AsyncHandler<AssociateIdentityProviderConfigRequest,AssociateIdentityProviderConfigResult> asyncHandler)
AmazonEKSAsync
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider
configuration and associate it to your cluster. After configuring authentication to your cluster you can create
Kubernetes roles
and clusterroles
to assign permissions to the roles, and then bind the
roles to the identities using Kubernetes rolebindings
and clusterrolebindings
. For more
information see Using RBAC
Authorization in the Kubernetes documentation.
associateIdentityProviderConfigAsync
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.public Future<CreateAddonResult> createAddonAsync(CreateAddonRequest request)
AmazonEKSAsync
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for
Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with
platform version eks.3
or later because add-ons rely on the Server-side Apply Kubernetes feature,
which is only available in Kubernetes 1.18 and later.
createAddonAsync
in interface AmazonEKSAsync
public Future<CreateAddonResult> createAddonAsync(CreateAddonRequest request, AsyncHandler<CreateAddonRequest,CreateAddonResult> asyncHandler)
AmazonEKSAsync
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for
Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with
platform version eks.3
or later because add-ons rely on the Server-side Apply Kubernetes feature,
which is only available in Kubernetes 1.18 and later.
createAddonAsync
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.public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)
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 nodes (for example, to support
kubectl exec
, logs
, and proxy
data flows).
Amazon EKS 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.
Cluster creation typically takes several minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
createClusterAsync
in interface AmazonEKSAsync
public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
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 nodes (for example, to support
kubectl exec
, logs
, and proxy
data flows).
Amazon EKS 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.
Cluster creation typically takes several minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
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.public Future<CreateFargateProfileResult> createFargateProfileAsync(CreateFargateProfileRequest request)
AmazonEKSAsync
Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled
with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet
that is running on the Fargate infrastructure can register with
your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
information, see Pod Execution
Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you must wait for that Fargate
profile to finish deleting before you can create any other profiles in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
createFargateProfileAsync
in interface AmazonEKSAsync
public Future<CreateFargateProfileResult> createFargateProfileAsync(CreateFargateProfileRequest request, AsyncHandler<CreateFargateProfileRequest,CreateFargateProfileResult> asyncHandler)
AmazonEKSAsync
Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled
with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet
that is running on the Fargate infrastructure can register with
your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
information, see Pod Execution
Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you must wait for that Fargate
profile to finish deleting before you can create any other profiles in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
createFargateProfileAsync
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.public Future<CreateNodegroupResult> createNodegroupAsync(CreateNodegroupRequest request)
AmazonEKSAsync
Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.
createNodegroupAsync
in interface AmazonEKSAsync
public Future<CreateNodegroupResult> createNodegroupAsync(CreateNodegroupRequest request, AsyncHandler<CreateNodegroupRequest,CreateNodegroupResult> asyncHandler)
AmazonEKSAsync
Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.
createNodegroupAsync
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.public Future<DeleteAddonResult> deleteAddonAsync(DeleteAddonRequest request)
AmazonEKSAsync
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
deleteAddonAsync
in interface AmazonEKSAsync
public Future<DeleteAddonResult> deleteAddonAsync(DeleteAddonRequest request, AsyncHandler<DeleteAddonRequest,DeleteAddonResult> asyncHandler)
AmazonEKSAsync
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
deleteAddonAsync
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.public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)
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.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
deleteClusterAsync
in interface AmazonEKSAsync
public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)
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.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
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.public Future<DeleteFargateProfileResult> deleteFargateProfileAsync(DeleteFargateProfileRequest request)
AmazonEKSAsync
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING
status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
deleteFargateProfileAsync
in interface AmazonEKSAsync
public Future<DeleteFargateProfileResult> deleteFargateProfileAsync(DeleteFargateProfileRequest request, AsyncHandler<DeleteFargateProfileRequest,DeleteFargateProfileResult> asyncHandler)
AmazonEKSAsync
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING
status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
deleteFargateProfileAsync
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.public Future<DeleteNodegroupResult> deleteNodegroupAsync(DeleteNodegroupRequest request)
AmazonEKSAsync
Deletes an Amazon EKS node group for a cluster.
deleteNodegroupAsync
in interface AmazonEKSAsync
public Future<DeleteNodegroupResult> deleteNodegroupAsync(DeleteNodegroupRequest request, AsyncHandler<DeleteNodegroupRequest,DeleteNodegroupResult> asyncHandler)
AmazonEKSAsync
Deletes an Amazon EKS node group for a cluster.
deleteNodegroupAsync
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.public Future<DescribeAddonResult> describeAddonAsync(DescribeAddonRequest request)
AmazonEKSAsync
Describes an Amazon EKS add-on.
describeAddonAsync
in interface AmazonEKSAsync
public Future<DescribeAddonResult> describeAddonAsync(DescribeAddonRequest request, AsyncHandler<DescribeAddonRequest,DescribeAddonResult> asyncHandler)
AmazonEKSAsync
Describes an Amazon EKS add-on.
describeAddonAsync
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.public Future<DescribeAddonVersionsResult> describeAddonVersionsAsync(DescribeAddonVersionsRequest request)
AmazonEKSAsync
Describes the Kubernetes versions that the add-on can be used with.
describeAddonVersionsAsync
in interface AmazonEKSAsync
public Future<DescribeAddonVersionsResult> describeAddonVersionsAsync(DescribeAddonVersionsRequest request, AsyncHandler<DescribeAddonVersionsRequest,DescribeAddonVersionsResult> asyncHandler)
AmazonEKSAsync
Describes the Kubernetes versions that the add-on can be used with.
describeAddonVersionsAsync
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.public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request)
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.
describeClusterAsync
in interface AmazonEKSAsync
public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request, AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)
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.
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.public Future<DescribeFargateProfileResult> describeFargateProfileAsync(DescribeFargateProfileRequest request)
AmazonEKSAsync
Returns descriptive information about an AWS Fargate profile.
describeFargateProfileAsync
in interface AmazonEKSAsync
public Future<DescribeFargateProfileResult> describeFargateProfileAsync(DescribeFargateProfileRequest request, AsyncHandler<DescribeFargateProfileRequest,DescribeFargateProfileResult> asyncHandler)
AmazonEKSAsync
Returns descriptive information about an AWS Fargate profile.
describeFargateProfileAsync
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.public Future<DescribeIdentityProviderConfigResult> describeIdentityProviderConfigAsync(DescribeIdentityProviderConfigRequest request)
AmazonEKSAsync
Returns descriptive information about an identity provider configuration.
describeIdentityProviderConfigAsync
in interface AmazonEKSAsync
public Future<DescribeIdentityProviderConfigResult> describeIdentityProviderConfigAsync(DescribeIdentityProviderConfigRequest request, AsyncHandler<DescribeIdentityProviderConfigRequest,DescribeIdentityProviderConfigResult> asyncHandler)
AmazonEKSAsync
Returns descriptive information about an identity provider configuration.
describeIdentityProviderConfigAsync
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.public Future<DescribeNodegroupResult> describeNodegroupAsync(DescribeNodegroupRequest request)
AmazonEKSAsync
Returns descriptive information about an Amazon EKS node group.
describeNodegroupAsync
in interface AmazonEKSAsync
public Future<DescribeNodegroupResult> describeNodegroupAsync(DescribeNodegroupRequest request, AsyncHandler<DescribeNodegroupRequest,DescribeNodegroupResult> asyncHandler)
AmazonEKSAsync
Returns descriptive information about an Amazon EKS node group.
describeNodegroupAsync
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.public Future<DescribeUpdateResult> describeUpdateAsync(DescribeUpdateRequest request)
AmazonEKSAsync
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
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.
describeUpdateAsync
in interface AmazonEKSAsync
public Future<DescribeUpdateResult> describeUpdateAsync(DescribeUpdateRequest request, AsyncHandler<DescribeUpdateRequest,DescribeUpdateResult> asyncHandler)
AmazonEKSAsync
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
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.
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.public Future<DisassociateIdentityProviderConfigResult> disassociateIdentityProviderConfigAsync(DisassociateIdentityProviderConfigRequest request)
AmazonEKSAsync
Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with AWS IAM users.
disassociateIdentityProviderConfigAsync
in interface AmazonEKSAsync
public Future<DisassociateIdentityProviderConfigResult> disassociateIdentityProviderConfigAsync(DisassociateIdentityProviderConfigRequest request, AsyncHandler<DisassociateIdentityProviderConfigRequest,DisassociateIdentityProviderConfigResult> asyncHandler)
AmazonEKSAsync
Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with AWS IAM users.
disassociateIdentityProviderConfigAsync
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.public Future<ListAddonsResult> listAddonsAsync(ListAddonsRequest request)
AmazonEKSAsync
Lists the available add-ons.
listAddonsAsync
in interface AmazonEKSAsync
public Future<ListAddonsResult> listAddonsAsync(ListAddonsRequest request, AsyncHandler<ListAddonsRequest,ListAddonsResult> asyncHandler)
AmazonEKSAsync
Lists the available add-ons.
listAddonsAsync
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.public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)
AmazonEKSAsync
Lists the Amazon EKS clusters in your AWS account in the specified Region.
listClustersAsync
in interface AmazonEKSAsync
public Future<ListClustersResult> listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
AmazonEKSAsync
Lists the Amazon EKS clusters in your AWS account in the specified Region.
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.public Future<ListFargateProfilesResult> listFargateProfilesAsync(ListFargateProfilesRequest request)
AmazonEKSAsync
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
listFargateProfilesAsync
in interface AmazonEKSAsync
public Future<ListFargateProfilesResult> listFargateProfilesAsync(ListFargateProfilesRequest request, AsyncHandler<ListFargateProfilesRequest,ListFargateProfilesResult> asyncHandler)
AmazonEKSAsync
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
listFargateProfilesAsync
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.public Future<ListIdentityProviderConfigsResult> listIdentityProviderConfigsAsync(ListIdentityProviderConfigsRequest request)
AmazonEKSAsync
A list of identity provider configurations.
listIdentityProviderConfigsAsync
in interface AmazonEKSAsync
public Future<ListIdentityProviderConfigsResult> listIdentityProviderConfigsAsync(ListIdentityProviderConfigsRequest request, AsyncHandler<ListIdentityProviderConfigsRequest,ListIdentityProviderConfigsResult> asyncHandler)
AmazonEKSAsync
A list of identity provider configurations.
listIdentityProviderConfigsAsync
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.public Future<ListNodegroupsResult> listNodegroupsAsync(ListNodegroupsRequest request)
AmazonEKSAsync
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
listNodegroupsAsync
in interface AmazonEKSAsync
public Future<ListNodegroupsResult> listNodegroupsAsync(ListNodegroupsRequest request, AsyncHandler<ListNodegroupsRequest,ListNodegroupsResult> asyncHandler)
AmazonEKSAsync
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
listNodegroupsAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonEKSAsync
List the tags for an Amazon EKS resource.
listTagsForResourceAsync
in interface AmazonEKSAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonEKSAsync
List the tags for an Amazon EKS resource.
listTagsForResourceAsync
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.public Future<ListUpdatesResult> listUpdatesAsync(ListUpdatesRequest request)
AmazonEKSAsync
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
listUpdatesAsync
in interface AmazonEKSAsync
public Future<ListUpdatesResult> listUpdatesAsync(ListUpdatesRequest request, AsyncHandler<ListUpdatesRequest,ListUpdatesResult> asyncHandler)
AmazonEKSAsync
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonEKSAsync
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate
to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that
tag does not automatically propagate to the subnets and nodes associated with the cluster.
tagResourceAsync
in interface AmazonEKSAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonEKSAsync
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate
to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that
tag does not automatically propagate to the subnets and nodes associated with the cluster.
tagResourceAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonEKSAsync
Deletes specified tags from a resource.
untagResourceAsync
in interface AmazonEKSAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonEKSAsync
Deletes specified tags from a resource.
untagResourceAsync
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.public Future<UpdateAddonResult> updateAddonAsync(UpdateAddonRequest request)
AmazonEKSAsync
Updates an Amazon EKS add-on.
updateAddonAsync
in interface AmazonEKSAsync
public Future<UpdateAddonResult> updateAddonAsync(UpdateAddonRequest request, AsyncHandler<UpdateAddonRequest,UpdateAddonResult> asyncHandler)
AmazonEKSAsync
Updates an Amazon EKS add-on.
updateAddonAsync
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.public Future<UpdateClusterConfigResult> updateClusterConfigAsync(UpdateClusterConfigRequest request)
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 .
You can't 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
.
updateClusterConfigAsync
in interface AmazonEKSAsync
public Future<UpdateClusterConfigResult> updateClusterConfigAsync(UpdateClusterConfigRequest request, AsyncHandler<UpdateClusterConfigRequest,UpdateClusterConfigResult> asyncHandler)
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 .
You can't 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
.
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.public Future<UpdateClusterVersionResult> updateClusterVersionAsync(UpdateClusterVersionRequest request)
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
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
updateClusterVersionAsync
in interface AmazonEKSAsync
public Future<UpdateClusterVersionResult> updateClusterVersionAsync(UpdateClusterVersionRequest request, AsyncHandler<UpdateClusterVersionRequest,UpdateClusterVersionResult> asyncHandler)
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
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
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.public Future<UpdateNodegroupConfigResult> updateNodegroupConfigAsync(UpdateNodegroupConfigRequest request)
AmazonEKSAsync
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
updateNodegroupConfigAsync
in interface AmazonEKSAsync
public Future<UpdateNodegroupConfigResult> updateNodegroupConfigAsync(UpdateNodegroupConfigRequest request, AsyncHandler<UpdateNodegroupConfigRequest,UpdateNodegroupConfigResult> asyncHandler)
AmazonEKSAsync
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
updateNodegroupConfigAsync
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.public Future<UpdateNodegroupVersionResult> updateNodegroupVersionAsync(UpdateNodegroupVersionRequest request)
AmazonEKSAsync
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are
drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force
the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget
issue.
updateNodegroupVersionAsync
in interface AmazonEKSAsync
public Future<UpdateNodegroupVersionResult> updateNodegroupVersionAsync(UpdateNodegroupVersionRequest request, AsyncHandler<UpdateNodegroupVersionRequest,UpdateNodegroupVersionResult> asyncHandler)
AmazonEKSAsync
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are
drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force
the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget
issue.
updateNodegroupVersionAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonEKS
shutdown
in class AmazonEKSClient