Interface EksAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateAccessPolicy
(Consumer<AssociateAccessPolicyRequest.Builder> associateAccessPolicyRequest) Associates an access policy and its scope to an access entry.associateAccessPolicy
(AssociateAccessPolicyRequest associateAccessPolicyRequest) Associates an access policy and its scope to an access entry.associateEncryptionConfig
(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest) Associates an encryption configuration to an existing cluster.associateEncryptionConfig
(AssociateEncryptionConfigRequest associateEncryptionConfigRequest) Associates an encryption configuration to an existing cluster.associateIdentityProviderConfig
(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest) Associates an identity provider configuration to a cluster.associateIdentityProviderConfig
(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest) Associates an identity provider configuration to a cluster.static EksAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aEksAsyncClient
.static EksAsyncClient
create()
Create aEksAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccessEntry
(Consumer<CreateAccessEntryRequest.Builder> createAccessEntryRequest) Creates an access entry.createAccessEntry
(CreateAccessEntryRequest createAccessEntryRequest) Creates an access entry.default CompletableFuture
<CreateAddonResponse> createAddon
(Consumer<CreateAddonRequest.Builder> createAddonRequest) Creates an Amazon EKS add-on.default CompletableFuture
<CreateAddonResponse> createAddon
(CreateAddonRequest createAddonRequest) Creates an Amazon EKS add-on.default CompletableFuture
<CreateClusterResponse> createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates an Amazon EKS control plane.default CompletableFuture
<CreateClusterResponse> createCluster
(CreateClusterRequest createClusterRequest) Creates an Amazon EKS control plane.createEksAnywhereSubscription
(Consumer<CreateEksAnywhereSubscriptionRequest.Builder> createEksAnywhereSubscriptionRequest) Creates an EKS Anywhere subscription.createEksAnywhereSubscription
(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest) Creates an EKS Anywhere subscription.createFargateProfile
(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest) Creates an Fargate profile for your Amazon EKS cluster.createFargateProfile
(CreateFargateProfileRequest createFargateProfileRequest) Creates an Fargate profile for your Amazon EKS cluster.default CompletableFuture
<CreateNodegroupResponse> createNodegroup
(Consumer<CreateNodegroupRequest.Builder> createNodegroupRequest) Creates a managed node group for an Amazon EKS cluster.default CompletableFuture
<CreateNodegroupResponse> createNodegroup
(CreateNodegroupRequest createNodegroupRequest) Creates a managed node group for an Amazon EKS cluster.createPodIdentityAssociation
(Consumer<CreatePodIdentityAssociationRequest.Builder> createPodIdentityAssociationRequest) Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity.createPodIdentityAssociation
(CreatePodIdentityAssociationRequest createPodIdentityAssociationRequest) Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity.deleteAccessEntry
(Consumer<DeleteAccessEntryRequest.Builder> deleteAccessEntryRequest) Deletes an access entry.deleteAccessEntry
(DeleteAccessEntryRequest deleteAccessEntryRequest) Deletes an access entry.default CompletableFuture
<DeleteAddonResponse> deleteAddon
(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest) Deletes an Amazon EKS add-on.default CompletableFuture
<DeleteAddonResponse> deleteAddon
(DeleteAddonRequest deleteAddonRequest) Deletes an Amazon EKS add-on.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes an Amazon EKS cluster control plane.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes an Amazon EKS cluster control plane.deleteEksAnywhereSubscription
(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest) Deletes an expired or inactive subscription.deleteEksAnywhereSubscription
(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest) Deletes an expired or inactive subscription.deleteFargateProfile
(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest) Deletes an Fargate profile.deleteFargateProfile
(DeleteFargateProfileRequest deleteFargateProfileRequest) Deletes an Fargate profile.default CompletableFuture
<DeleteNodegroupResponse> deleteNodegroup
(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest) Deletes a managed node group.default CompletableFuture
<DeleteNodegroupResponse> deleteNodegroup
(DeleteNodegroupRequest deleteNodegroupRequest) Deletes a managed node group.deletePodIdentityAssociation
(Consumer<DeletePodIdentityAssociationRequest.Builder> deletePodIdentityAssociationRequest) Deletes a EKS Pod Identity association.deletePodIdentityAssociation
(DeletePodIdentityAssociationRequest deletePodIdentityAssociationRequest) Deletes a EKS Pod Identity association.deregisterCluster
(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest) Deregisters a connected cluster to remove it from the Amazon EKS control plane.deregisterCluster
(DeregisterClusterRequest deregisterClusterRequest) Deregisters a connected cluster to remove it from the Amazon EKS control plane.describeAccessEntry
(Consumer<DescribeAccessEntryRequest.Builder> describeAccessEntryRequest) Describes an access entry.describeAccessEntry
(DescribeAccessEntryRequest describeAccessEntryRequest) Describes an access entry.default CompletableFuture
<DescribeAddonResponse> describeAddon
(Consumer<DescribeAddonRequest.Builder> describeAddonRequest) Describes an Amazon EKS add-on.default CompletableFuture
<DescribeAddonResponse> describeAddon
(DescribeAddonRequest describeAddonRequest) Describes an Amazon EKS add-on.describeAddonConfiguration
(Consumer<DescribeAddonConfigurationRequest.Builder> describeAddonConfigurationRequest) Returns configuration options.describeAddonConfiguration
(DescribeAddonConfigurationRequest describeAddonConfigurationRequest) Returns configuration options.describeAddonVersions
(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) Describes the versions for an add-on.describeAddonVersions
(DescribeAddonVersionsRequest describeAddonVersionsRequest) Describes the versions for an add-on.default DescribeAddonVersionsPublisher
describeAddonVersionsPaginator
(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) This is a variant ofdescribeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.default DescribeAddonVersionsPublisher
describeAddonVersionsPaginator
(DescribeAddonVersionsRequest describeAddonVersionsRequest) This is a variant ofdescribeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.default CompletableFuture
<DescribeClusterResponse> describeCluster
(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) Describes an Amazon EKS cluster.default CompletableFuture
<DescribeClusterResponse> describeCluster
(DescribeClusterRequest describeClusterRequest) Describes an Amazon EKS cluster.describeEksAnywhereSubscription
(Consumer<DescribeEksAnywhereSubscriptionRequest.Builder> describeEksAnywhereSubscriptionRequest) Returns descriptive information about a subscription.describeEksAnywhereSubscription
(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest) Returns descriptive information about a subscription.describeFargateProfile
(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest) Describes an Fargate profile.describeFargateProfile
(DescribeFargateProfileRequest describeFargateProfileRequest) Describes an Fargate profile.describeIdentityProviderConfig
(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest) Describes an identity provider configuration.describeIdentityProviderConfig
(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest) Describes an identity provider configuration.default CompletableFuture
<DescribeInsightResponse> describeInsight
(Consumer<DescribeInsightRequest.Builder> describeInsightRequest) Returns details about an insight that you specify using its ID.default CompletableFuture
<DescribeInsightResponse> describeInsight
(DescribeInsightRequest describeInsightRequest) Returns details about an insight that you specify using its ID.describeNodegroup
(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest) Describes a managed node group.describeNodegroup
(DescribeNodegroupRequest describeNodegroupRequest) Describes a managed node group.describePodIdentityAssociation
(Consumer<DescribePodIdentityAssociationRequest.Builder> describePodIdentityAssociationRequest) Returns descriptive information about an EKS Pod Identity association.describePodIdentityAssociation
(DescribePodIdentityAssociationRequest describePodIdentityAssociationRequest) Returns descriptive information about an EKS Pod Identity association.default CompletableFuture
<DescribeUpdateResponse> describeUpdate
(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest) Describes an update to an Amazon EKS resource.default CompletableFuture
<DescribeUpdateResponse> describeUpdate
(DescribeUpdateRequest describeUpdateRequest) Describes an update to an Amazon EKS resource.disassociateAccessPolicy
(Consumer<DisassociateAccessPolicyRequest.Builder> disassociateAccessPolicyRequest) Disassociates an access policy from an access entry.disassociateAccessPolicy
(DisassociateAccessPolicyRequest disassociateAccessPolicyRequest) Disassociates an access policy from an access entry.disassociateIdentityProviderConfig
(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest) Disassociates an identity provider configuration from a cluster.disassociateIdentityProviderConfig
(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest) Disassociates an identity provider configuration from a cluster.listAccessEntries
(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) Lists the access entries for your cluster.listAccessEntries
(ListAccessEntriesRequest listAccessEntriesRequest) Lists the access entries for your cluster.default ListAccessEntriesPublisher
listAccessEntriesPaginator
(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) This is a variant oflistAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
operation.default ListAccessEntriesPublisher
listAccessEntriesPaginator
(ListAccessEntriesRequest listAccessEntriesRequest) This is a variant oflistAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
operation.listAccessPolicies
(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) Lists the available access policies.listAccessPolicies
(ListAccessPoliciesRequest listAccessPoliciesRequest) Lists the available access policies.default ListAccessPoliciesPublisher
listAccessPoliciesPaginator
(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) This is a variant oflistAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
operation.default ListAccessPoliciesPublisher
listAccessPoliciesPaginator
(ListAccessPoliciesRequest listAccessPoliciesRequest) This is a variant oflistAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
operation.default CompletableFuture
<ListAddonsResponse> listAddons
(Consumer<ListAddonsRequest.Builder> listAddonsRequest) Lists the installed add-ons.default CompletableFuture
<ListAddonsResponse> listAddons
(ListAddonsRequest listAddonsRequest) Lists the installed add-ons.default ListAddonsPublisher
listAddonsPaginator
(Consumer<ListAddonsRequest.Builder> listAddonsRequest) This is a variant oflistAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation.default ListAddonsPublisher
listAddonsPaginator
(ListAddonsRequest listAddonsRequest) This is a variant oflistAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation.listAssociatedAccessPolicies
(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) Lists the access policies associated with an access entry.listAssociatedAccessPolicies
(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) Lists the access policies associated with an access entry.listAssociatedAccessPoliciesPaginator
(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) This is a variant oflistAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
operation.listAssociatedAccessPoliciesPaginator
(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) This is a variant oflistAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
operation.default CompletableFuture
<ListClustersResponse> Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.default CompletableFuture
<ListClustersResponse> listClusters
(Consumer<ListClustersRequest.Builder> listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.default CompletableFuture
<ListClustersResponse> listClusters
(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.default ListClustersPublisher
This is a variant oflistClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.default ListClustersPublisher
listClustersPaginator
(Consumer<ListClustersRequest.Builder> listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.default ListClustersPublisher
listClustersPaginator
(ListClustersRequest listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.listEksAnywhereSubscriptions
(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) Displays the full description of the subscription.listEksAnywhereSubscriptions
(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) Displays the full description of the subscription.listEksAnywhereSubscriptionsPaginator
(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) This is a variant oflistEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
operation.listEksAnywhereSubscriptionsPaginator
(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) This is a variant oflistEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
operation.listFargateProfiles
(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.listFargateProfiles
(ListFargateProfilesRequest listFargateProfilesRequest) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.default ListFargateProfilesPublisher
listFargateProfilesPaginator
(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) This is a variant oflistFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)
operation.default ListFargateProfilesPublisher
listFargateProfilesPaginator
(ListFargateProfilesRequest listFargateProfilesRequest) This is a variant oflistFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)
operation.listIdentityProviderConfigs
(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) Lists the identity provider configurations for your cluster.listIdentityProviderConfigs
(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) Lists the identity provider configurations for your cluster.listIdentityProviderConfigsPaginator
(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) This is a variant oflistIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.listIdentityProviderConfigsPaginator
(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) This is a variant oflistIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.default CompletableFuture
<ListInsightsResponse> listInsights
(Consumer<ListInsightsRequest.Builder> listInsightsRequest) Returns a list of all insights checked for against the specified cluster.default CompletableFuture
<ListInsightsResponse> listInsights
(ListInsightsRequest listInsightsRequest) Returns a list of all insights checked for against the specified cluster.default ListInsightsPublisher
listInsightsPaginator
(Consumer<ListInsightsRequest.Builder> listInsightsRequest) This is a variant oflistInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
operation.default ListInsightsPublisher
listInsightsPaginator
(ListInsightsRequest listInsightsRequest) This is a variant oflistInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
operation.default CompletableFuture
<ListNodegroupsResponse> listNodegroups
(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.default CompletableFuture
<ListNodegroupsResponse> listNodegroups
(ListNodegroupsRequest listNodegroupsRequest) Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.default ListNodegroupsPublisher
listNodegroupsPaginator
(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) This is a variant oflistNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation.default ListNodegroupsPublisher
listNodegroupsPaginator
(ListNodegroupsRequest listNodegroupsRequest) This is a variant oflistNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation.listPodIdentityAssociations
(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) List the EKS Pod Identity associations in a cluster.listPodIdentityAssociations
(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) List the EKS Pod Identity associations in a cluster.listPodIdentityAssociationsPaginator
(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) This is a variant oflistPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
operation.listPodIdentityAssociationsPaginator
(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) This is a variant oflistPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon EKS resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon EKS resource.default CompletableFuture
<ListUpdatesResponse> listUpdates
(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.default CompletableFuture
<ListUpdatesResponse> listUpdates
(ListUpdatesRequest listUpdatesRequest) Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.default ListUpdatesPublisher
listUpdatesPaginator
(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) This is a variant oflistUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation.default ListUpdatesPublisher
listUpdatesPaginator
(ListUpdatesRequest listUpdatesRequest) This is a variant oflistUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation.default CompletableFuture
<RegisterClusterResponse> registerCluster
(Consumer<RegisterClusterRequest.Builder> registerClusterRequest) Connects a Kubernetes cluster to the Amazon EKS control plane.default CompletableFuture
<RegisterClusterResponse> registerCluster
(RegisterClusterRequest registerClusterRequest) Connects a Kubernetes cluster to the Amazon EKS control plane.default EksServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to an Amazon EKS resource with the specifiedresourceArn
.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to an Amazon EKS resource with the specifiedresourceArn
.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from an Amazon EKS resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from an Amazon EKS resource.updateAccessEntry
(Consumer<UpdateAccessEntryRequest.Builder> updateAccessEntryRequest) Updates an access entry.updateAccessEntry
(UpdateAccessEntryRequest updateAccessEntryRequest) Updates an access entry.default CompletableFuture
<UpdateAddonResponse> updateAddon
(Consumer<UpdateAddonRequest.Builder> updateAddonRequest) Updates an Amazon EKS add-on.default CompletableFuture
<UpdateAddonResponse> updateAddon
(UpdateAddonRequest updateAddonRequest) Updates an Amazon EKS add-on.updateClusterConfig
(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.updateClusterConfig
(UpdateClusterConfigRequest updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.updateClusterVersion
(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.updateClusterVersion
(UpdateClusterVersionRequest updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.updateEksAnywhereSubscription
(Consumer<UpdateEksAnywhereSubscriptionRequest.Builder> updateEksAnywhereSubscriptionRequest) Update an EKS Anywhere Subscription.updateEksAnywhereSubscription
(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest) Update an EKS Anywhere Subscription.updateNodegroupConfig
(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest) Updates an Amazon EKS managed node group configuration.updateNodegroupConfig
(UpdateNodegroupConfigRequest updateNodegroupConfigRequest) Updates an Amazon EKS managed node group configuration.updateNodegroupVersion
(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.updateNodegroupVersion
(UpdateNodegroupVersionRequest updateNodegroupVersionRequest) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.updatePodIdentityAssociation
(Consumer<UpdatePodIdentityAssociationRequest.Builder> updatePodIdentityAssociationRequest) Updates a EKS Pod Identity association.updatePodIdentityAssociation
(UpdatePodIdentityAssociationRequest updatePodIdentityAssociationRequest) Updates a EKS Pod Identity association.default EksAsyncWaiter
waiter()
Create an instance ofEksAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateAccessPolicy
default CompletableFuture<AssociateAccessPolicyResponse> associateAccessPolicy(AssociateAccessPolicyRequest associateAccessPolicyRequest) Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.
- Parameters:
associateAccessPolicyRequest
-- Returns:
- A Java Future containing the result of the AssociateAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
associateAccessPolicy
default CompletableFuture<AssociateAccessPolicyResponse> associateAccessPolicy(Consumer<AssociateAccessPolicyRequest.Builder> associateAccessPolicyRequest) Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
AssociateAccessPolicyRequest.Builder
avoiding the need to create one manually viaAssociateAccessPolicyRequest.builder()
- Parameters:
associateAccessPolicyRequest
- AConsumer
that will call methods onAssociateAccessPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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(AssociateEncryptionConfigRequest associateEncryptionConfigRequest) Associates an encryption configuration to an existing cluster.
Use this API to enable encryption on existing clusters that don't already have encryption 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Associates an encryption configuration to an existing cluster.
Use this API to enable encryption on existing clusters that don't already have encryption 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 viaAssociateEncryptionConfigRequest.builder()
- Parameters:
associateEncryptionConfigRequest
- AConsumer
that will call methods onAssociateEncryptionConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Associates an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes
Role
andClusterRole
objects, assign permissions to them, and then bind them to the identities using KubernetesRoleBinding
andClusterRoleBinding
objects. 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Associates an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes
Role
andClusterRole
objects, assign permissions to them, and then bind them to the identities using KubernetesRoleBinding
andClusterRoleBinding
objects. 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 viaAssociateIdentityProviderConfigRequest.builder()
- Parameters:
associateIdentityProviderConfigRequest
- AConsumer
that will call methods onAssociateIdentityProviderConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
createAccessEntry
default CompletableFuture<CreateAccessEntryResponse> createAccessEntry(CreateAccessEntryRequest createAccessEntryRequest) Creates an access entry.
An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the
aws-auth
ConfigMap
for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage KubernetesRole
,ClusterRole
,RoleBinding
, andClusterRoleBinding
objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage KubernetesRole
,ClusterRole
,RoleBinding
, andClusterRoleBinding
objects.For more information about access entries, see Access entries in the Amazon EKS User Guide.
- Parameters:
createAccessEntryRequest
-- Returns:
- A Java Future containing the result of the CreateAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- ResourceLimitExceededException You have encountered a service limit on the specified resource.
- ResourceInUseException The specified resource is in use.
- 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:
-
createAccessEntry
default CompletableFuture<CreateAccessEntryResponse> createAccessEntry(Consumer<CreateAccessEntryRequest.Builder> createAccessEntryRequest) Creates an access entry.
An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the
aws-auth
ConfigMap
for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage KubernetesRole
,ClusterRole
,RoleBinding
, andClusterRoleBinding
objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage KubernetesRole
,ClusterRole
,RoleBinding
, andClusterRoleBinding
objects.For more information about access entries, see Access entries in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
CreateAccessEntryRequest.Builder
avoiding the need to create one manually viaCreateAccessEntryRequest.builder()
- Parameters:
createAccessEntryRequest
- AConsumer
that will call methods onCreateAccessEntryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- ResourceLimitExceededException You have encountered a service limit on the specified resource.
- ResourceInUseException The specified resource is in use.
- 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
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaCreateAddonRequest.builder()
- Parameters:
createAddonRequest
- AConsumer
that will call methods onCreateAddonRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
, andproxy
data flows).Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the
endpointPublicAccess
andendpointPrivateAccess
parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .You can use the
logging
parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
, andproxy
data flows).Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the
endpointPublicAccess
andendpointPrivateAccess
parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .You can use the
logging
parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see 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 viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 viaCreateEksAnywhereSubscriptionRequest.builder()
- Parameters:
createEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onCreateEksAnywhereSubscriptionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 viaCreateFargateProfileRequest.builder()
- Parameters:
createFargateProfileRequest
- AConsumer
that will call methods onCreateFargateProfileRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Amazon Web Services Regions that support Windows on Amazon EKS.
This is a convenience which creates an instance of the
CreateNodegroupRequest.Builder
avoiding the need to create one manually viaCreateNodegroupRequest.builder()
- Parameters:
createNodegroupRequest
- AConsumer
that will call methods onCreateNodegroupRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
createPodIdentityAssociation
default CompletableFuture<CreatePodIdentityAssociationResponse> createPodIdentityAssociation(CreatePodIdentityAssociationRequest createPodIdentityAssociationRequest) Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.
Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.
Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.
- Parameters:
createPodIdentityAssociationRequest
-- Returns:
- A Java Future containing the result of the CreatePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- ResourceLimitExceededException You have encountered a service limit on the specified resource.
- ResourceInUseException The specified resource is in use.
- 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:
-
createPodIdentityAssociation
default CompletableFuture<CreatePodIdentityAssociationResponse> createPodIdentityAssociation(Consumer<CreatePodIdentityAssociationRequest.Builder> createPodIdentityAssociationRequest) Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.
Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.
Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.
This is a convenience which creates an instance of the
CreatePodIdentityAssociationRequest.Builder
avoiding the need to create one manually viaCreatePodIdentityAssociationRequest.builder()
- Parameters:
createPodIdentityAssociationRequest
- AConsumer
that will call methods onCreatePodIdentityAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- ResourceLimitExceededException You have encountered a service limit on the specified resource.
- ResourceInUseException The specified resource is in use.
- 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:
-
deleteAccessEntry
default CompletableFuture<DeleteAccessEntryResponse> deleteAccessEntry(DeleteAccessEntryRequest deleteAccessEntryRequest) Deletes an access entry.
Deleting an access entry of a type other than
Standard
can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.- Parameters:
deleteAccessEntryRequest
-- Returns:
- A Java Future containing the result of the DeleteAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
deleteAccessEntry
default CompletableFuture<DeleteAccessEntryResponse> deleteAccessEntry(Consumer<DeleteAccessEntryRequest.Builder> deleteAccessEntryRequest) Deletes an access entry.
Deleting an access entry of a type other than
Standard
can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.
This is a convenience which creates an instance of the
DeleteAccessEntryRequest.Builder
avoiding the need to create one manually viaDeleteAccessEntryRequest.builder()
- Parameters:
deleteAccessEntryRequest
- AConsumer
that will call methods onDeleteAccessEntryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
deleteAddon
Deletes an Amazon EKS add-on.
When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Deletes an Amazon EKS add-on.
When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
This is a convenience which creates an instance of the
DeleteAddonRequest.Builder
avoiding the need to create one manually viaDeleteAddonRequest.builder()
- Parameters:
deleteAddonRequest
- AConsumer
that will call methods onDeleteAddonRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 an Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see
DeleteNodgroup
andDeleteFargateProfile
.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 an Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see
DeleteNodgroup
andDeleteFargateProfile
.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 or 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- See Also:
-
deleteEksAnywhereSubscription
default CompletableFuture<DeleteEksAnywhereSubscriptionResponse> deleteEksAnywhereSubscription(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest) Deletes an expired or 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 viaDeleteEksAnywhereSubscriptionRequest.builder()
- Parameters:
deleteEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onDeleteEksAnywhereSubscriptionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- See Also:
-
deleteFargateProfile
default CompletableFuture<DeleteFargateProfileResponse> deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest) Deletes an Fargate profile.
When you delete a Fargate profile, any
Pod
running on Fargate that was created with the profile is deleted. If thePod
matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a pending state.Only one Fargate profile in a cluster can be in the
DELETING
status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
Pod
running on Fargate that was created with the profile is deleted. If thePod
matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a pending state.Only one Fargate profile in a cluster can be in the
DELETING
status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.
This is a convenience which creates an instance of the
DeleteFargateProfileRequest.Builder
avoiding the need to create one manually viaDeleteFargateProfileRequest.builder()
- Parameters:
deleteFargateProfileRequest
- AConsumer
that will call methods onDeleteFargateProfileRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 a managed node group.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 a managed node group.
This is a convenience which creates an instance of the
DeleteNodegroupRequest.Builder
avoiding the need to create one manually viaDeleteNodegroupRequest.builder()
- Parameters:
deleteNodegroupRequest
- AConsumer
that will call methods onDeleteNodegroupRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
deletePodIdentityAssociation
default CompletableFuture<DeletePodIdentityAssociationResponse> deletePodIdentityAssociation(DeletePodIdentityAssociationRequest deletePodIdentityAssociationRequest) Deletes a EKS Pod Identity association.
The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
- Parameters:
deletePodIdentityAssociationRequest
-- Returns:
- A Java Future containing the result of the DeletePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
deletePodIdentityAssociation
default CompletableFuture<DeletePodIdentityAssociationResponse> deletePodIdentityAssociation(Consumer<DeletePodIdentityAssociationRequest.Builder> deletePodIdentityAssociationRequest) Deletes a EKS Pod Identity association.
The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
This is a convenience which creates an instance of the
DeletePodIdentityAssociationRequest.Builder
avoiding the need to create one manually viaDeletePodIdentityAssociationRequest.builder()
- Parameters:
deletePodIdentityAssociationRequest
- AConsumer
that will call methods onDeletePodIdentityAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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.
A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.
This is a convenience which creates an instance of the
DeregisterClusterRequest.Builder
avoiding the need to create one manually viaDeregisterClusterRequest.builder()
- Parameters:
deregisterClusterRequest
- AConsumer
that will call methods onDeregisterClusterRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
describeAccessEntry
default CompletableFuture<DescribeAccessEntryResponse> describeAccessEntry(DescribeAccessEntryRequest describeAccessEntryRequest) Describes an access entry.
- Parameters:
describeAccessEntryRequest
-- Returns:
- A Java Future containing the result of the DescribeAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
describeAccessEntry
default CompletableFuture<DescribeAccessEntryResponse> describeAccessEntry(Consumer<DescribeAccessEntryRequest.Builder> describeAccessEntryRequest) Describes an access entry.
This is a convenience which creates an instance of the
DescribeAccessEntryRequest.Builder
avoiding the need to create one manually viaDescribeAccessEntryRequest.builder()
- Parameters:
describeAccessEntryRequest
- AConsumer
that will call methods onDescribeAccessEntryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaDescribeAddonRequest.builder()
- Parameters:
describeAddonRequest
- AConsumer
that will call methods onDescribeAddonRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaDescribeAddonConfigurationRequest.builder()
- Parameters:
describeAddonConfigurationRequest
- AConsumer
that will call methods onDescribeAddonConfigurationRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 thetype
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 thetype
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 viaDescribeAddonVersionsRequest.builder()
- Parameters:
describeAddonVersionsRequest
- AConsumer
that will call methods onDescribeAddonVersionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaDescribeAddonVersionsRequest.builder()
- Parameters:
describeAddonVersionsRequest
- AConsumer
that will call methods onDescribeAddonVersionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet
andkubectl
to communicate with your Kubernetes API server. For more information, see Creating or updating akubeconfig
file for an Amazon EKS cluster.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- See Also:
-
describeCluster
default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) Describes an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet
andkubectl
to communicate with your Kubernetes API server. For more information, see Creating or updating akubeconfig
file for an Amazon EKS cluster.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 viaDescribeClusterRequest.builder()
- Parameters:
describeClusterRequest
- AConsumer
that will call methods onDescribeClusterRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- 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 viaDescribeEksAnywhereSubscriptionRequest.builder()
- Parameters:
describeEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onDescribeEksAnywhereSubscriptionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
ListClusters
. You can view your available managed node groups withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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.
- ResourceNotFoundException The specified resource could not be found. You can view your available
clusters with
- See Also:
-
describeFargateProfile
default CompletableFuture<DescribeFargateProfileResponse> describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest) Describes 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes an Fargate profile.
This is a convenience which creates an instance of the
DescribeFargateProfileRequest.Builder
avoiding the need to create one manually viaDescribeFargateProfileRequest.builder()
- Parameters:
describeFargateProfileRequest
- AConsumer
that will call methods onDescribeFargateProfileRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes an identity provider configuration.
This is a convenience which creates an instance of the
DescribeIdentityProviderConfigRequest.Builder
avoiding the need to create one manually viaDescribeIdentityProviderConfigRequest.builder()
- Parameters:
describeIdentityProviderConfigRequest
- AConsumer
that will call methods onDescribeIdentityProviderConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
describeInsight
default CompletableFuture<DescribeInsightResponse> describeInsight(DescribeInsightRequest describeInsightRequest) Returns details about an insight that you specify using its ID.
- Parameters:
describeInsightRequest
-- Returns:
- A Java Future containing the result of the DescribeInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
describeInsight
default CompletableFuture<DescribeInsightResponse> describeInsight(Consumer<DescribeInsightRequest.Builder> describeInsightRequest) Returns details about an insight that you specify using its ID.
This is a convenience which creates an instance of the
DescribeInsightRequest.Builder
avoiding the need to create one manually viaDescribeInsightRequest.builder()
- Parameters:
describeInsightRequest
- AConsumer
that will call methods onDescribeInsightRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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) Describes a managed 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes a managed node group.
This is a convenience which creates an instance of the
DescribeNodegroupRequest.Builder
avoiding the need to create one manually viaDescribeNodegroupRequest.builder()
- Parameters:
describeNodegroupRequest
- AConsumer
that will call methods onDescribeNodegroupRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
describePodIdentityAssociation
default CompletableFuture<DescribePodIdentityAssociationResponse> describePodIdentityAssociation(DescribePodIdentityAssociationRequest describePodIdentityAssociationRequest) Returns descriptive information about an EKS Pod Identity association.
This action requires the ID of the association. You can get the ID from the response to the
CreatePodIdentityAssocation
for newly created associations. Or, you can list the IDs for associations withListPodIdentityAssociations
and filter the list by namespace or service account.- Parameters:
describePodIdentityAssociationRequest
-- Returns:
- A Java Future containing the result of the DescribePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
describePodIdentityAssociation
default CompletableFuture<DescribePodIdentityAssociationResponse> describePodIdentityAssociation(Consumer<DescribePodIdentityAssociationRequest.Builder> describePodIdentityAssociationRequest) Returns descriptive information about an EKS Pod Identity association.
This action requires the ID of the association. You can get the ID from the response to the
CreatePodIdentityAssocation
for newly created associations. Or, you can list the IDs for associations withListPodIdentityAssociations
and filter the list by namespace or service account.
This is a convenience which creates an instance of the
DescribePodIdentityAssociationRequest.Builder
avoiding the need to create one manually viaDescribePodIdentityAssociationRequest.builder()
- Parameters:
describePodIdentityAssociationRequest
- AConsumer
that will call methods onDescribePodIdentityAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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) Describes an update to an Amazon EKS resource.
When the status of the update is
Succeeded
, the update is complete. If an update fails, the status isFailed
, and an error detail explains the reason for the failure.- Parameters:
describeUpdateRequest
- Describes an update 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Describes an update to an Amazon EKS resource.
When the status of the update is
Succeeded
, the update is complete. If an update fails, the status isFailed
, 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 viaDescribeUpdateRequest.builder()
- Parameters:
describeUpdateRequest
- AConsumer
that will call methods onDescribeUpdateRequest.Builder
to create a request. Describes an update 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
disassociateAccessPolicy
default CompletableFuture<DisassociateAccessPolicyResponse> disassociateAccessPolicy(DisassociateAccessPolicyRequest disassociateAccessPolicyRequest) Disassociates an access policy from an access entry.
- Parameters:
disassociateAccessPolicyRequest
-- Returns:
- A Java Future containing the result of the DisassociateAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
disassociateAccessPolicy
default CompletableFuture<DisassociateAccessPolicyResponse> disassociateAccessPolicy(Consumer<DisassociateAccessPolicyRequest.Builder> disassociateAccessPolicyRequest) Disassociates an access policy from an access entry.
This is a convenience which creates an instance of the
DisassociateAccessPolicyRequest.Builder
avoiding the need to create one manually viaDisassociateAccessPolicyRequest.builder()
- Parameters:
disassociateAccessPolicyRequest
- AConsumer
that will call methods onDisassociateAccessPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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(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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaDisassociateIdentityProviderConfigRequest.builder()
- Parameters:
disassociateIdentityProviderConfigRequest
- AConsumer
that will call methods onDisassociateIdentityProviderConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listAccessEntries
default CompletableFuture<ListAccessEntriesResponse> listAccessEntries(ListAccessEntriesRequest listAccessEntriesRequest) Lists the access entries for your cluster.
- Parameters:
listAccessEntriesRequest
-- Returns:
- A Java Future containing the result of the ListAccessEntries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listAccessEntries
default CompletableFuture<ListAccessEntriesResponse> listAccessEntries(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) Lists the access entries for your cluster.
This is a convenience which creates an instance of the
ListAccessEntriesRequest.Builder
avoiding the need to create one manually viaListAccessEntriesRequest.builder()
- Parameters:
listAccessEntriesRequest
- AConsumer
that will call methods onListAccessEntriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessEntries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listAccessEntriesPaginator
default ListAccessEntriesPublisher listAccessEntriesPaginator(ListAccessEntriesRequest listAccessEntriesRequest) This is a variant of
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesPublisher publisher = client.listAccessEntriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAccessEntriesPublisher publisher = client.listAccessEntriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse response) { //... }; });
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
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
operation.- Parameters:
listAccessEntriesRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listAccessEntriesPaginator
default ListAccessEntriesPublisher listAccessEntriesPaginator(Consumer<ListAccessEntriesRequest.Builder> listAccessEntriesRequest) This is a variant of
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAccessEntriesPublisher publisher = client.listAccessEntriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAccessEntriesPublisher publisher = client.listAccessEntriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAccessEntriesResponse response) { //... }; });
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
listAccessEntries(software.amazon.awssdk.services.eks.model.ListAccessEntriesRequest)
operation.
This is a convenience which creates an instance of the
ListAccessEntriesRequest.Builder
avoiding the need to create one manually viaListAccessEntriesRequest.builder()
- Parameters:
listAccessEntriesRequest
- AConsumer
that will call methods onListAccessEntriesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listAccessPolicies
default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) Lists the available access policies.
- Parameters:
listAccessPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAccessPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
listAccessPolicies
default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) Lists the available access policies.
This is a convenience which creates an instance of the
ListAccessPoliciesRequest.Builder
avoiding the need to create one manually viaListAccessPoliciesRequest.builder()
- Parameters:
listAccessPoliciesRequest
- AConsumer
that will call methods onListAccessPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
listAccessPoliciesPaginator
default ListAccessPoliciesPublisher listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest) This is a variant of
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse response) { //... }; });
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
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
operation.- Parameters:
listAccessPoliciesRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
listAccessPoliciesPaginator
default ListAccessPoliciesPublisher listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) This is a variant of
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAccessPoliciesResponse response) { //... }; });
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
listAccessPolicies(software.amazon.awssdk.services.eks.model.ListAccessPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListAccessPoliciesRequest.Builder
avoiding the need to create one manually viaListAccessPoliciesRequest.builder()
- Parameters:
listAccessPoliciesRequest
- AConsumer
that will call methods onListAccessPoliciesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaListAddonsRequest.builder()
- Parameters:
listAddonsRequest
- AConsumer
that will call methods onListAddonsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListAddonsRequest.builder()
- Parameters:
listAddonsRequest
- AConsumer
that will call methods onListAddonsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listAssociatedAccessPolicies
default CompletableFuture<ListAssociatedAccessPoliciesResponse> listAssociatedAccessPolicies(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) Lists the access policies associated with an access entry.
- Parameters:
listAssociatedAccessPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAssociatedAccessPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listAssociatedAccessPolicies
default CompletableFuture<ListAssociatedAccessPoliciesResponse> listAssociatedAccessPolicies(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) Lists the access policies associated with an access entry.
This is a convenience which creates an instance of the
ListAssociatedAccessPoliciesRequest.Builder
avoiding the need to create one manually viaListAssociatedAccessPoliciesRequest.builder()
- Parameters:
listAssociatedAccessPoliciesRequest
- AConsumer
that will call methods onListAssociatedAccessPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAssociatedAccessPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listAssociatedAccessPoliciesPaginator
default ListAssociatedAccessPoliciesPublisher listAssociatedAccessPoliciesPaginator(ListAssociatedAccessPoliciesRequest listAssociatedAccessPoliciesRequest) This is a variant of
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesPublisher publisher = client.listAssociatedAccessPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesPublisher publisher = client.listAssociatedAccessPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse response) { //... }; });
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
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
operation.- Parameters:
listAssociatedAccessPoliciesRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listAssociatedAccessPoliciesPaginator
default ListAssociatedAccessPoliciesPublisher listAssociatedAccessPoliciesPaginator(Consumer<ListAssociatedAccessPoliciesRequest.Builder> listAssociatedAccessPoliciesRequest) This is a variant of
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesPublisher publisher = client.listAssociatedAccessPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListAssociatedAccessPoliciesPublisher publisher = client.listAssociatedAccessPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesResponse response) { //... }; });
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
listAssociatedAccessPolicies(software.amazon.awssdk.services.eks.model.ListAssociatedAccessPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListAssociatedAccessPoliciesRequest.Builder
avoiding the need to create one manually viaListAssociatedAccessPoliciesRequest.builder()
- Parameters:
listAssociatedAccessPoliciesRequest
- AConsumer
that will call methods onListAssociatedAccessPoliciesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listClusters
default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Amazon Web Services Region.
This is a convenience which creates an instance of the
ListClustersRequest.Builder
avoiding the need to create one manually viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 viaListEksAnywhereSubscriptionsRequest.builder()
- Parameters:
listEksAnywhereSubscriptionsRequest
- AConsumer
that will call methods onListEksAnywhereSubscriptionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
listEksAnywhereSubscriptionsPaginator
default ListEksAnywhereSubscriptionsPublisher listEksAnywhereSubscriptionsPaginator(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) This is a variant of
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsPublisher publisher = client.listEksAnywhereSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsPublisher publisher = client.listEksAnywhereSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse response) { //... }; });
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
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
operation.- Parameters:
listEksAnywhereSubscriptionsRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
listEksAnywhereSubscriptionsPaginator
default ListEksAnywhereSubscriptionsPublisher listEksAnywhereSubscriptionsPaginator(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) This is a variant of
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsPublisher publisher = client.listEksAnywhereSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListEksAnywhereSubscriptionsPublisher publisher = client.listEksAnywhereSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsResponse response) { //... }; });
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
listEksAnywhereSubscriptions(software.amazon.awssdk.services.eks.model.ListEksAnywhereSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
ListEksAnywhereSubscriptionsRequest.Builder
avoiding the need to create one manually viaListEksAnywhereSubscriptionsRequest.builder()
- Parameters:
listEksAnywhereSubscriptionsRequest
- AConsumer
that will call methods onListEksAnywhereSubscriptionsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 Amazon Web Services Region.
This is a convenience which creates an instance of the
ListFargateProfilesRequest.Builder
avoiding the need to create one manually viaListFargateProfilesRequest.builder()
- Parameters:
listFargateProfilesRequest
- AConsumer
that will call methods onListFargateProfilesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListFargateProfilesRequest.builder()
- Parameters:
listFargateProfilesRequest
- AConsumer
that will call methods onListFargateProfilesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Lists the identity provider configurations for your cluster.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) Lists the identity provider configurations for your cluster.
This is a convenience which creates an instance of the
ListIdentityProviderConfigsRequest.Builder
avoiding the need to create one manually viaListIdentityProviderConfigsRequest.builder()
- Parameters:
listIdentityProviderConfigsRequest
- AConsumer
that will call methods onListIdentityProviderConfigsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListIdentityProviderConfigsRequest.builder()
- Parameters:
listIdentityProviderConfigsRequest
- AConsumer
that will call methods onListIdentityProviderConfigsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listInsights
default CompletableFuture<ListInsightsResponse> listInsights(ListInsightsRequest listInsightsRequest) Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
- Parameters:
listInsightsRequest
-- Returns:
- A Java Future containing the result of the ListInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listInsights
default CompletableFuture<ListInsightsResponse> listInsights(Consumer<ListInsightsRequest.Builder> listInsightsRequest) Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
This is a convenience which creates an instance of the
ListInsightsRequest.Builder
avoiding the need to create one manually viaListInsightsRequest.builder()
- Parameters:
listInsightsRequest
- AConsumer
that will call methods onListInsightsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInsights operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listInsightsPaginator
This is a variant of
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListInsightsPublisher publisher = client.listInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListInsightsPublisher publisher = client.listInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListInsightsResponse response) { //... }; });
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
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
operation.- Parameters:
listInsightsRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listInsightsPaginator
default ListInsightsPublisher listInsightsPaginator(Consumer<ListInsightsRequest.Builder> listInsightsRequest) This is a variant of
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListInsightsPublisher publisher = client.listInsightsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListInsightsPublisher publisher = client.listInsightsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListInsightsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListInsightsResponse response) { //... }; });
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
listInsights(software.amazon.awssdk.services.eks.model.ListInsightsRequest)
operation.
This is a convenience which creates an instance of the
ListInsightsRequest.Builder
avoiding the need to create one manually viaListInsightsRequest.builder()
- Parameters:
listInsightsRequest
- AConsumer
that will call methods onListInsightsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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 managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.
This is a convenience which creates an instance of the
ListNodegroupsRequest.Builder
avoiding the need to create one manually viaListNodegroupsRequest.builder()
- Parameters:
listNodegroupsRequest
- AConsumer
that will call methods onListNodegroupsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListNodegroupsRequest.builder()
- Parameters:
listNodegroupsRequest
- AConsumer
that will call methods onListNodegroupsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
listPodIdentityAssociations
default CompletableFuture<ListPodIdentityAssociationsResponse> listPodIdentityAssociations(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.
- Parameters:
listPodIdentityAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListPodIdentityAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listPodIdentityAssociations
default CompletableFuture<ListPodIdentityAssociationsResponse> listPodIdentityAssociations(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.
This is a convenience which creates an instance of the
ListPodIdentityAssociationsRequest.Builder
avoiding the need to create one manually viaListPodIdentityAssociationsRequest.builder()
- Parameters:
listPodIdentityAssociationsRequest
- AConsumer
that will call methods onListPodIdentityAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPodIdentityAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listPodIdentityAssociationsPaginator
default ListPodIdentityAssociationsPublisher listPodIdentityAssociationsPaginator(ListPodIdentityAssociationsRequest listPodIdentityAssociationsRequest) This is a variant of
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsPublisher publisher = client.listPodIdentityAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsPublisher publisher = client.listPodIdentityAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse response) { //... }; });
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
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
operation.- Parameters:
listPodIdentityAssociationsRequest
-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
listPodIdentityAssociationsPaginator
default ListPodIdentityAssociationsPublisher listPodIdentityAssociationsPaginator(Consumer<ListPodIdentityAssociationsRequest.Builder> listPodIdentityAssociationsRequest) This is a variant of
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsPublisher publisher = client.listPodIdentityAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.eks.paginators.ListPodIdentityAssociationsPublisher publisher = client.listPodIdentityAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsResponse response) { //... }; });
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
listPodIdentityAssociations(software.amazon.awssdk.services.eks.model.ListPodIdentityAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListPodIdentityAssociationsRequest.Builder
avoiding the need to create one manually viaListPodIdentityAssociationsRequest.builder()
- Parameters:
listPodIdentityAssociationsRequest
- AConsumer
that will call methods onListPodIdentityAssociationsRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
This is a convenience which creates an instance of the
ListUpdatesRequest.Builder
avoiding the need to create one manually viaListUpdatesRequest.builder()
- Parameters:
listUpdatesRequest
- AConsumer
that will call methods onListUpdatesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListUpdatesRequest.builder()
- Parameters:
listUpdatesRequest
- AConsumer
that will call methods onListUpdatesRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
andactivationCode
must be applied to the Kubernetes cluster through it's native provider to provide visibility.After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using
DeregisterCluster
.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
andactivationCode
must be applied to the Kubernetes cluster through it's native provider to provide visibility.After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using
DeregisterCluster
.
This is a convenience which creates an instance of the
RegisterClusterRequest.Builder
avoiding the need to create one manually viaRegisterClusterRequest.builder()
- Parameters:
registerClusterRequest
- AConsumer
that will call methods onRegisterClusterRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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
Associates the specified tags to an Amazon EKS resource with the specified
resourceArn
. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 an Amazon EKS resource with the specified
resourceArn
. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 an Amazon EKS 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 an Amazon EKS resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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:
-
updateAccessEntry
default CompletableFuture<UpdateAccessEntryResponse> updateAccessEntry(UpdateAccessEntryRequest updateAccessEntryRequest) Updates an access entry.
- Parameters:
updateAccessEntryRequest
-- Returns:
- A Java Future containing the result of the UpdateAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
updateAccessEntry
default CompletableFuture<UpdateAccessEntryResponse> updateAccessEntry(Consumer<UpdateAccessEntryRequest.Builder> updateAccessEntryRequest) Updates an access entry.
This is a convenience which creates an instance of the
UpdateAccessEntryRequest.Builder
avoiding the need to create one manually viaUpdateAccessEntryRequest.builder()
- Parameters:
updateAccessEntryRequest
- AConsumer
that will call methods onUpdateAccessEntryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccessEntry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaUpdateAddonRequest.builder()
- Parameters:
updateAddonRequest
- AConsumer
that will call methods onUpdateAddonRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
DescribeUpdate
"/>.You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https ://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to
UPDATING
(this status transition is eventually consistent). When the update is complete (eitherFailed
orSuccessful
), the cluster status moves toActive
.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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
DescribeUpdate
"/>.You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https ://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to
UPDATING
(this status transition is eventually consistent). When the update is complete (eitherFailed
orSuccessful
), the cluster status moves toActive
.
This is a convenience which creates an instance of the
UpdateClusterConfigRequest.Builder
avoiding the need to create one manually viaUpdateClusterConfigRequest.builder()
- Parameters:
updateClusterConfigRequest
- AConsumer
that will call methods onUpdateClusterConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 (eitherFailed
orSuccessful
), the cluster status moves toActive
.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 (eitherFailed
orSuccessful
), the cluster status moves toActive
.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 viaUpdateClusterVersionRequest.builder()
- Parameters:
updateClusterVersionRequest
- AConsumer
that will call methods onUpdateClusterVersionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaUpdateEksAnywhereSubscriptionRequest.builder()
- Parameters:
updateEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onUpdateEksAnywhereSubscriptionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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 viaUpdateNodegroupConfigRequest.builder()
- Parameters:
updateNodegroupConfigRequest
- AConsumer
that will call methods onUpdateNodegroupConfigRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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, every
Pod
on that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You canforce
the update if Amazon EKS is unable to drain the nodes as a result of aPod
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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, every
Pod
on that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You canforce
the update if Amazon EKS is unable to drain the nodes as a result of aPod
disruption budget issue.
This is a convenience which creates an instance of the
UpdateNodegroupVersionRequest.Builder
avoiding the need to create one manually viaUpdateNodegroupVersionRequest.builder()
- Parameters:
updateNodegroupVersionRequest
- AConsumer
that will call methods onUpdateNodegroupVersionRequest.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services 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:
-
updatePodIdentityAssociation
default CompletableFuture<UpdatePodIdentityAssociationResponse> updatePodIdentityAssociation(UpdatePodIdentityAssociationRequest updatePodIdentityAssociationRequest) Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.
- Parameters:
updatePodIdentityAssociationRequest
-- Returns:
- A Java Future containing the result of the UpdatePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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:
-
updatePodIdentityAssociation
default CompletableFuture<UpdatePodIdentityAssociationResponse> updatePodIdentityAssociation(Consumer<UpdatePodIdentityAssociationRequest.Builder> updatePodIdentityAssociationRequest) Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.
This is a convenience which creates an instance of the
UpdatePodIdentityAssociationRequest.Builder
avoiding the need to create one manually viaUpdatePodIdentityAssociationRequest.builder()
- Parameters:
updatePodIdentityAssociationRequest
- AConsumer
that will call methods onUpdatePodIdentityAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePodIdentityAssociation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 withListNodegroups
. Amazon EKS clusters and node groups are Amazon Web Services Region specific. - 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.
- 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
Create an instance ofEksAsyncWaiter
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
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aEksAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEksAsyncClient
.
-