Interface EksAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EksAsyncClient extends AwsClient
Service client for accessing Amazon EKS asynchronously. This can be created using the static builder() method.

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

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

  • Field Details

  • Method Details

    • associateEncryptionConfig

      default CompletableFuture<AssociateEncryptionConfigResponse> associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest)

      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 Amazon EKS clusters.

      Parameters:
      associateEncryptionConfigRequest -
      Returns:
      A Java Future containing the result of the AssociateEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateEncryptionConfig

      default CompletableFuture<AssociateEncryptionConfigResponse> associateEncryptionConfig(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest)

      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 Amazon EKS clusters.


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

      Parameters:
      associateEncryptionConfigRequest - A Consumer that will call methods on AssociateEncryptionConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateIdentityProviderConfig

      default CompletableFuture<AssociateIdentityProviderConfigResponse> associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest)

      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.

      Parameters:
      associateIdentityProviderConfigRequest -
      Returns:
      A Java Future containing the result of the AssociateIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • associateIdentityProviderConfig

      default CompletableFuture<AssociateIdentityProviderConfigResponse> associateIdentityProviderConfig(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest)

      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.


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

      Parameters:
      associateIdentityProviderConfigRequest - A Consumer that will call methods on AssociateIdentityProviderConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createAddon

      default CompletableFuture<CreateAddonResponse> createAddon(CreateAddonRequest createAddonRequest)

      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.

      Parameters:
      createAddonRequest -
      Returns:
      A Java Future containing the result of the CreateAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ResourceInUseException The specified resource is in use.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createAddon

      default CompletableFuture<CreateAddonResponse> createAddon(Consumer<CreateAddonRequest.Builder> createAddonRequest)

      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.


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

      Parameters:
      createAddonRequest - A Consumer that will call methods on CreateAddonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ResourceInUseException The specified resource is in use.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

      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.

      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 Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • UnsupportedAvailabilityZoneException At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

      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.

      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 Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.


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

      Parameters:
      createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • UnsupportedAvailabilityZoneException At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createEksAnywhereSubscription

      default CompletableFuture<CreateEksAnywhereSubscriptionResponse> createEksAnywhereSubscription(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest)

      Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.

      Parameters:
      createEksAnywhereSubscriptionRequest -
      Returns:
      A Java Future containing the result of the CreateEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createEksAnywhereSubscription

      default CompletableFuture<CreateEksAnywhereSubscriptionResponse> createEksAnywhereSubscription(Consumer<CreateEksAnywhereSubscriptionRequest.Builder> createEksAnywhereSubscriptionRequest)

      Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.


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

      Parameters:
      createEksAnywhereSubscriptionRequest - A Consumer that will call methods on CreateEksAnywhereSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFargateProfile

      default CompletableFuture<CreateFargateProfileResponse> createFargateProfile(CreateFargateProfileRequest createFargateProfileRequest)

      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.

      Parameters:
      createFargateProfileRequest -
      Returns:
      A Java Future containing the result of the CreateFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • UnsupportedAvailabilityZoneException At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createFargateProfile

      default CompletableFuture<CreateFargateProfileResponse> createFargateProfile(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest)

      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.


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

      Parameters:
      createFargateProfileRequest - A Consumer that will call methods on CreateFargateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • UnsupportedAvailabilityZoneException At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNodegroup

      default CompletableFuture<CreateNodegroupResponse> createNodegroup(CreateNodegroupRequest createNodegroupRequest)

      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.

      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 Regions that support Windows Amazon EKS.

      Parameters:
      createNodegroupRequest -
      Returns:
      A Java Future containing the result of the CreateNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createNodegroup

      default CompletableFuture<CreateNodegroupResponse> createNodegroup(Consumer<CreateNodegroupRequest.Builder> createNodegroupRequest)

      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.

      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 Regions that support Windows Amazon EKS.


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

      Parameters:
      createNodegroupRequest - A Consumer that will call methods on CreateNodegroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteAddon

      default CompletableFuture<DeleteAddonResponse> deleteAddon(DeleteAddonRequest deleteAddonRequest)

      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.

      Parameters:
      deleteAddonRequest -
      Returns:
      A Java Future containing the result of the DeleteAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteAddon

      default CompletableFuture<DeleteAddonResponse> deleteAddon(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest)

      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.


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

      Parameters:
      deleteAddonRequest - A Consumer that will call methods on DeleteAddonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

      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.

      Parameters:
      deleteClusterRequest -
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

      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.


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

      Parameters:
      deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteEksAnywhereSubscription

      default CompletableFuture<DeleteEksAnywhereSubscriptionResponse> deleteEksAnywhereSubscription(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest)

      Deletes an expired / inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation, and are cancelled by creating a ticket in the Amazon Web Services Support Center.

      Parameters:
      deleteEksAnywhereSubscriptionRequest -
      Returns:
      A Java Future containing the result of the DeleteEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteEksAnywhereSubscription

      default CompletableFuture<DeleteEksAnywhereSubscriptionResponse> deleteEksAnywhereSubscription(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest)

      Deletes an expired / inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation, and are cancelled by creating a ticket in the Amazon Web Services Support Center.


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

      Parameters:
      deleteEksAnywhereSubscriptionRequest - A Consumer that will call methods on DeleteEksAnywhereSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFargateProfile

      default CompletableFuture<DeleteFargateProfileResponse> deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest)

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

      Parameters:
      deleteFargateProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteFargateProfile

      default CompletableFuture<DeleteFargateProfileResponse> deleteFargateProfile(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest)

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


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

      Parameters:
      deleteFargateProfileRequest - A Consumer that will call methods on DeleteFargateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNodegroup

      default CompletableFuture<DeleteNodegroupResponse> deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest)

      Deletes an Amazon EKS node group for a cluster.

      Parameters:
      deleteNodegroupRequest -
      Returns:
      A Java Future containing the result of the DeleteNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteNodegroup

      default CompletableFuture<DeleteNodegroupResponse> deleteNodegroup(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest)

      Deletes an Amazon EKS node group for a cluster.


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

      Parameters:
      deleteNodegroupRequest - A Consumer that will call methods on DeleteNodegroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deregisterCluster

      default CompletableFuture<DeregisterClusterResponse> deregisterCluster(DeregisterClusterRequest deregisterClusterRequest)

      Deregisters a connected cluster to remove it from the Amazon EKS control plane.

      Parameters:
      deregisterClusterRequest -
      Returns:
      A Java Future containing the result of the DeregisterCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deregisterCluster

      default CompletableFuture<DeregisterClusterResponse> deregisterCluster(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest)

      Deregisters a connected cluster to remove it from the Amazon EKS control plane.


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

      Parameters:
      deregisterClusterRequest - A Consumer that will call methods on DeregisterClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddon

      default CompletableFuture<DescribeAddonResponse> describeAddon(DescribeAddonRequest describeAddonRequest)

      Describes an Amazon EKS add-on.

      Parameters:
      describeAddonRequest -
      Returns:
      A Java Future containing the result of the DescribeAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddon

      default CompletableFuture<DescribeAddonResponse> describeAddon(Consumer<DescribeAddonRequest.Builder> describeAddonRequest)

      Describes an Amazon EKS add-on.


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

      Parameters:
      describeAddonRequest - A Consumer that will call methods on DescribeAddonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonConfiguration

      default CompletableFuture<DescribeAddonConfigurationResponse> describeAddonConfiguration(DescribeAddonConfigurationRequest describeAddonConfigurationRequest)

      Returns configuration options.

      Parameters:
      describeAddonConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeAddonConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonConfiguration

      default CompletableFuture<DescribeAddonConfigurationResponse> describeAddonConfiguration(Consumer<DescribeAddonConfigurationRequest.Builder> describeAddonConfigurationRequest)

      Returns configuration options.


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

      Parameters:
      describeAddonConfigurationRequest - A Consumer that will call methods on DescribeAddonConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAddonConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonVersions

      default CompletableFuture<DescribeAddonVersionsResponse> describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest)

      Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.

      Parameters:
      describeAddonVersionsRequest -
      Returns:
      A Java Future containing the result of the DescribeAddonVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonVersions

      default CompletableFuture<DescribeAddonVersionsResponse> describeAddonVersions(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)

      Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.


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

      Parameters:
      describeAddonVersionsRequest - A Consumer that will call methods on DescribeAddonVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAddonVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonVersionsPaginator

      default DescribeAddonVersionsPublisher describeAddonVersionsPaginator(DescribeAddonVersionsRequest describeAddonVersionsRequest)

      Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.


      This is a variant of describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      describeAddonVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeAddonVersionsPaginator

      default DescribeAddonVersionsPublisher describeAddonVersionsPaginator(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)

      Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.


      This is a variant of describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      describeAddonVersionsRequest - A Consumer that will call methods on DescribeAddonVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

      Returns descriptive information about an Amazon EKS cluster.

      The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

      The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

      Parameters:
      describeClusterRequest -
      Returns:
      A Java Future containing the result of the DescribeCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

      Returns descriptive information about an Amazon EKS cluster.

      The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

      The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.


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

      Parameters:
      describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeEksAnywhereSubscription

      default CompletableFuture<DescribeEksAnywhereSubscriptionResponse> describeEksAnywhereSubscription(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest)

      Returns descriptive information about a subscription.

      Parameters:
      describeEksAnywhereSubscriptionRequest -
      Returns:
      A Java Future containing the result of the DescribeEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeEksAnywhereSubscription

      default CompletableFuture<DescribeEksAnywhereSubscriptionResponse> describeEksAnywhereSubscription(Consumer<DescribeEksAnywhereSubscriptionRequest.Builder> describeEksAnywhereSubscriptionRequest)

      Returns descriptive information about a subscription.


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

      Parameters:
      describeEksAnywhereSubscriptionRequest - A Consumer that will call methods on DescribeEksAnywhereSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFargateProfile

      default CompletableFuture<DescribeFargateProfileResponse> describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest)

      Returns descriptive information about an Fargate profile.

      Parameters:
      describeFargateProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeFargateProfile

      default CompletableFuture<DescribeFargateProfileResponse> describeFargateProfile(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest)

      Returns descriptive information about an Fargate profile.


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

      Parameters:
      describeFargateProfileRequest - A Consumer that will call methods on DescribeFargateProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFargateProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeIdentityProviderConfig

      default CompletableFuture<DescribeIdentityProviderConfigResponse> describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest)

      Returns descriptive information about an identity provider configuration.

      Parameters:
      describeIdentityProviderConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeIdentityProviderConfig

      default CompletableFuture<DescribeIdentityProviderConfigResponse> describeIdentityProviderConfig(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest)

      Returns descriptive information about an identity provider configuration.


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

      Parameters:
      describeIdentityProviderConfigRequest - A Consumer that will call methods on DescribeIdentityProviderConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNodegroup

      default CompletableFuture<DescribeNodegroupResponse> describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest)

      Returns descriptive information about an Amazon EKS node group.

      Parameters:
      describeNodegroupRequest -
      Returns:
      A Java Future containing the result of the DescribeNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeNodegroup

      default CompletableFuture<DescribeNodegroupResponse> describeNodegroup(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest)

      Returns descriptive information about an Amazon EKS node group.


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

      Parameters:
      describeNodegroupRequest - A Consumer that will call methods on DescribeNodegroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNodegroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUpdate

      default CompletableFuture<DescribeUpdateResponse> describeUpdate(DescribeUpdateRequest describeUpdateRequest)

      Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.

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

      Parameters:
      describeUpdateRequest -
      Returns:
      A Java Future containing the result of the DescribeUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • describeUpdate

      default CompletableFuture<DescribeUpdateResponse> describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest)

      Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.

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


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

      Parameters:
      describeUpdateRequest - A Consumer that will call methods on DescribeUpdateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateIdentityProviderConfig

      default CompletableFuture<DisassociateIdentityProviderConfigResponse> disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest)

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

      Parameters:
      disassociateIdentityProviderConfigRequest -
      Returns:
      A Java Future containing the result of the DisassociateIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • disassociateIdentityProviderConfig

      default CompletableFuture<DisassociateIdentityProviderConfigResponse> disassociateIdentityProviderConfig(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest)

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


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

      Parameters:
      disassociateIdentityProviderConfigRequest - A Consumer that will call methods on DisassociateIdentityProviderConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateIdentityProviderConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAddons

      default CompletableFuture<ListAddonsResponse> listAddons(ListAddonsRequest listAddonsRequest)

      Lists the installed add-ons.

      Parameters:
      listAddonsRequest -
      Returns:
      A Java Future containing the result of the ListAddons operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAddons

      default CompletableFuture<ListAddonsResponse> listAddons(Consumer<ListAddonsRequest.Builder> listAddonsRequest)

      Lists the installed add-ons.


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

      Parameters:
      listAddonsRequest - A Consumer that will call methods on ListAddonsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAddons operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAddonsPaginator

      default ListAddonsPublisher listAddonsPaginator(ListAddonsRequest listAddonsRequest)

      Lists the installed add-ons.


      This is a variant of listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAddonsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListAddonsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listAddonsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAddonsPaginator

      default ListAddonsPublisher listAddonsPaginator(Consumer<ListAddonsRequest.Builder> listAddonsRequest)

      Lists the installed add-ons.


      This is a variant of listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAddonsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListAddonsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listAddonsRequest - A Consumer that will call methods on ListAddonsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.

      Parameters:
      listClustersRequest -
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.


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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters()

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.

      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator()

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.


      This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.


      This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listClustersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.


      This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEksAnywhereSubscriptions

      default CompletableFuture<ListEksAnywhereSubscriptionsResponse> listEksAnywhereSubscriptions(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest)

      Displays the full description of the subscription.

      Parameters:
      listEksAnywhereSubscriptionsRequest -
      Returns:
      A Java Future containing the result of the ListEksAnywhereSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEksAnywhereSubscriptions

      default CompletableFuture<ListEksAnywhereSubscriptionsResponse> listEksAnywhereSubscriptions(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest)

      Displays the full description of the subscription.


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

      Parameters:
      listEksAnywhereSubscriptionsRequest - A Consumer that will call methods on ListEksAnywhereSubscriptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEksAnywhereSubscriptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFargateProfiles

      default CompletableFuture<ListFargateProfilesResponse> listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest)

      Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.

      Parameters:
      listFargateProfilesRequest -
      Returns:
      A Java Future containing the result of the ListFargateProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFargateProfiles

      default CompletableFuture<ListFargateProfilesResponse> listFargateProfiles(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)

      Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.


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

      Parameters:
      listFargateProfilesRequest - A Consumer that will call methods on ListFargateProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFargateProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFargateProfilesPaginator

      default ListFargateProfilesPublisher listFargateProfilesPaginator(ListFargateProfilesRequest listFargateProfilesRequest)

      Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.


      This is a variant of listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listFargateProfilesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listFargateProfilesPaginator

      default ListFargateProfilesPublisher listFargateProfilesPaginator(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)

      Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.


      This is a variant of listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listFargateProfilesRequest - A Consumer that will call methods on ListFargateProfilesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviderConfigs

      default CompletableFuture<ListIdentityProviderConfigsResponse> listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)

      A list of identity provider configurations.

      Parameters:
      listIdentityProviderConfigsRequest -
      Returns:
      A Java Future containing the result of the ListIdentityProviderConfigs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviderConfigs

      default CompletableFuture<ListIdentityProviderConfigsResponse> listIdentityProviderConfigs(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)

      A list of identity provider configurations.


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

      Parameters:
      listIdentityProviderConfigsRequest - A Consumer that will call methods on ListIdentityProviderConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIdentityProviderConfigs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviderConfigsPaginator

      default ListIdentityProviderConfigsPublisher listIdentityProviderConfigsPaginator(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)

      A list of identity provider configurations.


      This is a variant of listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listIdentityProviderConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listIdentityProviderConfigsPaginator

      default ListIdentityProviderConfigsPublisher listIdentityProviderConfigsPaginator(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)

      A list of identity provider configurations.


      This is a variant of listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listIdentityProviderConfigsRequest - A Consumer that will call methods on ListIdentityProviderConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNodegroups

      default CompletableFuture<ListNodegroupsResponse> listNodegroups(ListNodegroupsRequest listNodegroupsRequest)

      Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.

      Parameters:
      listNodegroupsRequest -
      Returns:
      A Java Future containing the result of the ListNodegroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNodegroups

      default CompletableFuture<ListNodegroupsResponse> listNodegroups(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)

      Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.


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

      Parameters:
      listNodegroupsRequest - A Consumer that will call methods on ListNodegroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNodegroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNodegroupsPaginator

      default ListNodegroupsPublisher listNodegroupsPaginator(ListNodegroupsRequest listNodegroupsRequest)

      Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.


      This is a variant of listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListNodegroupsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listNodegroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listNodegroupsPaginator

      default ListNodegroupsPublisher listNodegroupsPaginator(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)

      Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.


      This is a variant of listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListNodegroupsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listNodegroupsRequest - A Consumer that will call methods on ListNodegroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      List the tags for an Amazon EKS resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      List the tags for an Amazon EKS resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUpdates

      default CompletableFuture<ListUpdatesResponse> listUpdates(ListUpdatesRequest listUpdatesRequest)

      Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.

      Parameters:
      listUpdatesRequest -
      Returns:
      A Java Future containing the result of the ListUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUpdates

      default CompletableFuture<ListUpdatesResponse> listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)

      Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.


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

      Parameters:
      listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUpdatesPaginator

      default ListUpdatesPublisher listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest)

      Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.


      This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListUpdatesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListUpdatesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listUpdatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listUpdatesPaginator

      default ListUpdatesPublisher listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)

      Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.


      This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListUpdatesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.eks.model.ListUpdatesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

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

      Parameters:
      listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • registerCluster

      default CompletableFuture<RegisterClusterResponse> registerCluster(RegisterClusterRequest registerClusterRequest)

      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, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

      Parameters:
      registerClusterRequest -
      Returns:
      A Java Future containing the result of the RegisterCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
      • ResourceInUseException The specified resource is in use.
      • ResourcePropagationDelayException Required resources (such as service-linked roles) were created and are still propagating. Retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • registerCluster

      default CompletableFuture<RegisterClusterResponse> registerCluster(Consumer<RegisterClusterRequest.Builder> registerClusterRequest)

      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, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.


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

      Parameters:
      registerClusterRequest - A Consumer that will call methods on RegisterClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceLimitExceededException You have encountered a service limit on the specified resource.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ServiceUnavailableException The service is unavailable. Back off and retry the operation.
      • AccessDeniedException You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
      • ResourceInUseException The specified resource is in use.
      • ResourcePropagationDelayException Required resources (such as service-linked roles) were created and are still propagating. Retry later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Deletes specified tags from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Deletes specified tags from a resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • BadRequestException This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.
      • NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateAddon

      default CompletableFuture<UpdateAddonResponse> updateAddon(UpdateAddonRequest updateAddonRequest)

      Updates an Amazon EKS add-on.

      Parameters:
      updateAddonRequest -
      Returns:
      A Java Future containing the result of the UpdateAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ResourceInUseException The specified resource is in use.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateAddon

      default CompletableFuture<UpdateAddonResponse> updateAddon(Consumer<UpdateAddonRequest.Builder> updateAddonRequest)

      Updates an Amazon EKS add-on.


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

      Parameters:
      updateAddonRequest - A Consumer that will call methods on UpdateAddonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAddon operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • ResourceInUseException The specified resource is in use.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateClusterConfig

      default CompletableFuture<UpdateClusterConfigResponse> updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)

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

      Parameters:
      updateClusterConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateClusterConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateClusterConfig

      default CompletableFuture<UpdateClusterConfigResponse> updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest)

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


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

      Parameters:
      updateClusterConfigRequest - A Consumer that will call methods on UpdateClusterConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateClusterConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateClusterVersion

      default CompletableFuture<UpdateClusterVersionResponse> updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)

      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.

      Parameters:
      updateClusterVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateClusterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateClusterVersion

      default CompletableFuture<UpdateClusterVersionResponse> updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest)

      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.


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

      Parameters:
      updateClusterVersionRequest - A Consumer that will call methods on UpdateClusterVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateClusterVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateEksAnywhereSubscription

      default CompletableFuture<UpdateEksAnywhereSubscriptionResponse> updateEksAnywhereSubscription(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest)

      Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

      Parameters:
      updateEksAnywhereSubscriptionRequest -
      Returns:
      A Java Future containing the result of the UpdateEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateEksAnywhereSubscription

      default CompletableFuture<UpdateEksAnywhereSubscriptionResponse> updateEksAnywhereSubscription(Consumer<UpdateEksAnywhereSubscriptionRequest.Builder> updateEksAnywhereSubscriptionRequest)

      Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.


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

      Parameters:
      updateEksAnywhereSubscriptionRequest - A Consumer that will call methods on UpdateEksAnywhereSubscriptionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEksAnywhereSubscription operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNodegroupConfig

      default CompletableFuture<UpdateNodegroupConfigResponse> updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest)

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

      Parameters:
      updateNodegroupConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateNodegroupConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNodegroupConfig

      default CompletableFuture<UpdateNodegroupConfigResponse> updateNodegroupConfig(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest)

      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.


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

      Parameters:
      updateNodegroupConfigRequest - A Consumer that will call methods on UpdateNodegroupConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNodegroupConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNodegroupVersion

      default CompletableFuture<UpdateNodegroupVersionResponse> updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest)

      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, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.

      Parameters:
      updateNodegroupVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateNodegroupVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • updateNodegroupVersion

      default CompletableFuture<UpdateNodegroupVersionResponse> updateNodegroupVersion(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest)

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


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

      Parameters:
      updateNodegroupVersionRequest - A Consumer that will call methods on UpdateNodegroupVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNodegroupVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
      • ClientException These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
      • ServerException These errors are usually caused by a server-side issue.
      • ResourceInUseException The specified resource is in use.
      • ResourceNotFoundException The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.
      • InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • EksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • waiter

      default EksAsyncWaiter waiter()
      Create an instance of EksAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of EksAsyncWaiter
    • serviceClientConfiguration

      default EksServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      static EksAsyncClient create()
      Create a EksAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      static EksAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EksAsyncClient.