JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.eks

Class 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 Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

    Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

    • Method Detail

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

        public Future<AssociateIdentityProviderConfigResult> associateIdentityProviderConfigAsync(AssociateIdentityProviderConfigRequest request)
        Description copied from interface: AmazonEKSAsync

        Associates 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 Role and ClusterRole objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see Using RBAC Authorization in the Kubernetes documentation.

        Specified by:
        associateIdentityProviderConfigAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the AssociateIdentityProviderConfig operation returned by the service.
        See Also:
        AWS API Documentation
      • createAccessEntryAsync

        public Future<CreateAccessEntryResult> createAccessEntryAsync(CreateAccessEntryRequest request)
        Description copied from interface: AmazonEKSAsync

        Creates an access entry.

        An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth ConfigMap for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects.

        For more information about access entries, see Access entries in the Amazon EKS User Guide.

        Specified by:
        createAccessEntryAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the CreateAccessEntry operation returned by the service.
        See Also:
        AWS API Documentation
      • createAccessEntryAsync

        public Future<CreateAccessEntryResult> createAccessEntryAsync(CreateAccessEntryRequest request,
         AsyncHandler<CreateAccessEntryRequest,CreateAccessEntryResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Creates an access entry.

        An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth ConfigMap for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects.

        For more information about access entries, see Access entries in the Amazon EKS User Guide.

        Specified by:
        createAccessEntryAsync 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 CreateAccessEntry operation returned by the service.
        See Also:
        AWS API Documentation
      • createAddonAsync

        public Future<CreateAddonResult> createAddonAsync(CreateAddonRequest request,
         AsyncHandler<CreateAddonRequest,CreateAddonResult> asyncHandler)
        Description copied from interface: 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. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the CreateAddon operation returned by the service.
        See Also:
        AWS API Documentation
      • 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 Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It 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 Amazon Web Services account and connect to your cluster's control plane over 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 CloudWatch Pricing.

        In most cases, it takes several minutes to create a cluster. 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 Allowing users to access your cluster and Launching Amazon EKS 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 Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It 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 Amazon Web Services account and connect to your cluster's control plane over 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 CloudWatch Pricing.

        In most cases, it takes several minutes to create a cluster. 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 Allowing users to access your cluster and Launching Amazon EKS 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
      • createFargateProfileAsync

        public Future<CreateFargateProfileResult> createFargateProfileAsync(CreateFargateProfileRequest request)
        Description copied from interface: AmazonEKSAsync

        Creates an 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 Fargate profile in the Amazon EKS User Guide.

        Specified by:
        createFargateProfileAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the CreateFargateProfile operation returned by the service.
        See Also:
        AWS API Documentation
      • createFargateProfileAsync

        public Future<CreateFargateProfileResult> createFargateProfileAsync(CreateFargateProfileRequest request,
         AsyncHandler<CreateFargateProfileRequest,CreateFargateProfileResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Creates an 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 Fargate profile in the Amazon EKS User Guide.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the CreateFargateProfile operation returned by the service.
        See Also:
        AWS API Documentation
      • createNodegroupAsync

        public Future<CreateNodegroupResult> createNodegroupAsync(CreateNodegroupRequest request)
        Description copied from interface: 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 Customizing managed nodes with launch templates.

        An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.

        Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.

        Specified by:
        createNodegroupAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the CreateNodegroup operation returned by the service.
        See Also:
        AWS API Documentation
      • createNodegroupAsync

        public Future<CreateNodegroupResult> createNodegroupAsync(CreateNodegroupRequest request,
         AsyncHandler<CreateNodegroupRequest,CreateNodegroupResult> asyncHandler)
        Description copied from interface: 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 Customizing managed nodes with launch templates.

        An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.

        Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the CreateNodegroup operation returned by the service.
        See Also:
        AWS API Documentation
      • createPodIdentityAssociationAsync

        public Future<CreatePodIdentityAssociationResult> createPodIdentityAssociationAsync(CreatePodIdentityAssociationRequest request)
        Description copied from interface: AmazonEKSAsync

        Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.

        Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

        If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.

        Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.

        Specified by:
        createPodIdentityAssociationAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the CreatePodIdentityAssociation operation returned by the service.
        See Also:
        AWS API Documentation
      • createPodIdentityAssociationAsync

        public Future<CreatePodIdentityAssociationResult> createPodIdentityAssociationAsync(CreatePodIdentityAssociationRequest request,
         AsyncHandler<CreatePodIdentityAssociationRequest,CreatePodIdentityAssociationResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.

        Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

        If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.

        Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.

        Specified by:
        createPodIdentityAssociationAsync 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 CreatePodIdentityAssociation operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteAddonAsync

        public Future<DeleteAddonResult> deleteAddonAsync(DeleteAddonRequest request,
         AsyncHandler<DeleteAddonRequest,DeleteAddonResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Deletes an Amazon EKS add-on.

        When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the DeleteAddon operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteClusterAsync

        public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)
        Description copied from interface: AmazonEKSAsync

        Deletes an 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 DeleteNodgroup and DeleteFargateProfile.

        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 an 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 DeleteNodgroup and DeleteFargateProfile.

        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
      • deleteFargateProfileAsync

        public Future<DeleteFargateProfileResult> deleteFargateProfileAsync(DeleteFargateProfileRequest request)
        Description copied from interface: AmazonEKSAsync

        Deletes an Fargate profile.

        When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and 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.

        Specified by:
        deleteFargateProfileAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the DeleteFargateProfile operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteFargateProfileAsync

        public Future<DeleteFargateProfileResult> deleteFargateProfileAsync(DeleteFargateProfileRequest request,
         AsyncHandler<DeleteFargateProfileRequest,DeleteFargateProfileResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Deletes an Fargate profile.

        When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and 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.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the DeleteFargateProfile operation returned by the service.
        See Also:
        AWS API Documentation
      • describeUpdateAsync

        public Future<DescribeUpdateResult> describeUpdateAsync(DescribeUpdateRequest request)
        Description copied from interface: AmazonEKSAsync

        Describes an update to an Amazon EKS resource.

        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
        Parameters:
        request - Describes an update request.
        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

        Describes an update to an Amazon EKS resource.

        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
        Parameters:
        request - Describes an update request.
        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
      • listInsightsAsync

        public Future<ListInsightsResult> listInsightsAsync(ListInsightsRequest request,
         AsyncHandler<ListInsightsRequest,ListInsightsResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.

        Specified by:
        listInsightsAsync 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 ListInsights operation returned by the service.
        See Also:
        AWS API Documentation
      • listNodegroupsAsync

        public Future<ListNodegroupsResult> listNodegroupsAsync(ListNodegroupsRequest request,
         AsyncHandler<ListNodegroupsRequest,ListNodegroupsResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the ListNodegroups 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 resource in your Amazon Web Services account, in the specified Amazon Web Services 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
      • registerClusterAsync

        public Future<RegisterClusterResult> registerClusterAsync(RegisterClusterRequest request)
        Description copied from interface: AmazonEKSAsync

        Connects a Kubernetes cluster to the Amazon EKS control plane.

        Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.

        Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane.

        Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

        After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.

        Specified by:
        registerClusterAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the RegisterCluster operation returned by the service.
        See Also:
        AWS API Documentation
      • registerClusterAsync

        public Future<RegisterClusterResult> registerClusterAsync(RegisterClusterRequest request,
         AsyncHandler<RegisterClusterRequest,RegisterClusterResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Connects a Kubernetes cluster to the Amazon EKS control plane.

        Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.

        Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane.

        Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

        After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.

        Specified by:
        registerClusterAsync 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 RegisterCluster operation returned by the service.
        See Also:
        AWS API Documentation
      • tagResourceAsync

        public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
        Description copied from interface: AmazonEKSAsync

        Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.

        Specified by:
        tagResourceAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        See Also:
        AWS API Documentation
      • tagResourceAsync

        public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
         AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
        Description copied from interface: AmazonEKSAsync

        Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the TagResource 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 DescribeUpdate"/>.

        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 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 also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https ://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .

        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 DescribeUpdate"/>.

        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 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 also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https ://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .

        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 .

        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.

        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 .

        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.

        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
      • updateNodegroupVersionAsync

        public Future<UpdateNodegroupVersionResult> updateNodegroupVersionAsync(UpdateNodegroupVersionRequest request)
        Description copied from interface: 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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows 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, every Pod on that node is 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.

        Specified by:
        updateNodegroupVersionAsync in interface AmazonEKSAsync
        Returns:
        A Java Future containing the result of the UpdateNodegroupVersion operation returned by the service.
        See Also:
        AWS API Documentation
      • updateNodegroupVersionAsync

        public Future<UpdateNodegroupVersionResult> updateNodegroupVersionAsync(UpdateNodegroupVersionRequest request,
         AsyncHandler<UpdateNodegroupVersionRequest,UpdateNodegroupVersionResult> asyncHandler)
        Description copied from interface: 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 information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows 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, every Pod on that node is 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.

        Specified by:
        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.
        Returns:
        A Java Future containing the result of the UpdateNodegroupVersion 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
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /