@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EksAsyncClient extends SdkClient
builder()
method.
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateEncryptionConfigResponse> |
associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest)
Associate encryption configuration to an existing cluster.
|
default CompletableFuture<AssociateEncryptionConfigResponse> |
associateEncryptionConfig(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest)
Associate encryption configuration to an existing cluster.
|
default CompletableFuture<AssociateIdentityProviderConfigResponse> |
associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest)
Associate an identity provider configuration to a cluster.
|
default CompletableFuture<AssociateIdentityProviderConfigResponse> |
associateIdentityProviderConfig(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest)
Associate an identity provider configuration to a cluster.
|
static EksAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
EksAsyncClient. |
static EksAsyncClient |
create()
Create a
EksAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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.
|
default CompletableFuture<CreateFargateProfileResponse> |
createFargateProfile(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest)
Creates an Fargate profile for your Amazon EKS cluster.
|
default CompletableFuture<CreateFargateProfileResponse> |
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.
|
default CompletableFuture<DeleteAddonResponse> |
deleteAddon(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest)
Delete an Amazon EKS add-on.
|
default CompletableFuture<DeleteAddonResponse> |
deleteAddon(DeleteAddonRequest deleteAddonRequest)
Delete an Amazon EKS add-on.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes the Amazon EKS cluster control plane.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the Amazon EKS cluster control plane.
|
default CompletableFuture<DeleteFargateProfileResponse> |
deleteFargateProfile(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest)
Deletes an Fargate profile.
|
default CompletableFuture<DeleteFargateProfileResponse> |
deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest)
Deletes an Fargate profile.
|
default CompletableFuture<DeleteNodegroupResponse> |
deleteNodegroup(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest)
Deletes an Amazon EKS node group for a cluster.
|
default CompletableFuture<DeleteNodegroupResponse> |
deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest)
Deletes an Amazon EKS node group for a cluster.
|
default CompletableFuture<DeregisterClusterResponse> |
deregisterCluster(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
|
default CompletableFuture<DeregisterClusterResponse> |
deregisterCluster(DeregisterClusterRequest deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
|
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.
|
default CompletableFuture<DescribeAddonVersionsResponse> |
describeAddonVersions(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
|
default CompletableFuture<DescribeAddonVersionsResponse> |
describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
|
default DescribeAddonVersionsPublisher |
describeAddonVersionsPaginator(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
|
default DescribeAddonVersionsPublisher |
describeAddonVersionsPaginator(DescribeAddonVersionsRequest describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
|
default CompletableFuture<DescribeClusterResponse> |
describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
Returns descriptive information about an Amazon EKS cluster.
|
default CompletableFuture<DescribeClusterResponse> |
describeCluster(DescribeClusterRequest describeClusterRequest)
Returns descriptive information about an Amazon EKS cluster.
|
default CompletableFuture<DescribeFargateProfileResponse> |
describeFargateProfile(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest)
Returns descriptive information about an Fargate profile.
|
default CompletableFuture<DescribeFargateProfileResponse> |
describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest)
Returns descriptive information about an Fargate profile.
|
default CompletableFuture<DescribeIdentityProviderConfigResponse> |
describeIdentityProviderConfig(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest)
Returns descriptive information about an identity provider configuration.
|
default CompletableFuture<DescribeIdentityProviderConfigResponse> |
describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest)
Returns descriptive information about an identity provider configuration.
|
default CompletableFuture<DescribeNodegroupResponse> |
describeNodegroup(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest)
Returns descriptive information about an Amazon EKS node group.
|
default CompletableFuture<DescribeNodegroupResponse> |
describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest)
Returns descriptive information about an Amazon EKS node group.
|
default CompletableFuture<DescribeUpdateResponse> |
describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
|
default CompletableFuture<DescribeUpdateResponse> |
describeUpdate(DescribeUpdateRequest describeUpdateRequest)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
|
default CompletableFuture<DisassociateIdentityProviderConfigResponse> |
disassociateIdentityProviderConfig(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest)
Disassociates an identity provider configuration from a cluster.
|
default CompletableFuture<DisassociateIdentityProviderConfigResponse> |
disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest)
Disassociates an identity provider configuration from a cluster.
|
default CompletableFuture<ListAddonsResponse> |
listAddons(Consumer<ListAddonsRequest.Builder> listAddonsRequest)
Lists the available add-ons.
|
default CompletableFuture<ListAddonsResponse> |
listAddons(ListAddonsRequest listAddonsRequest)
Lists the available add-ons.
|
default ListAddonsPublisher |
listAddonsPaginator(Consumer<ListAddonsRequest.Builder> listAddonsRequest)
Lists the available add-ons.
|
default ListAddonsPublisher |
listAddonsPaginator(ListAddonsRequest listAddonsRequest)
Lists the available add-ons.
|
default CompletableFuture<ListClustersResponse> |
listClusters()
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default CompletableFuture<ListClustersResponse> |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default CompletableFuture<ListClustersResponse> |
listClusters(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default ListClustersPublisher |
listClustersPaginator()
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default ListClustersPublisher |
listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default ListClustersPublisher |
listClustersPaginator(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
|
default CompletableFuture<ListFargateProfilesResponse> |
listFargateProfiles(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the
specified Region.
|
default CompletableFuture<ListFargateProfilesResponse> |
listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the
specified Region.
|
default ListFargateProfilesPublisher |
listFargateProfilesPaginator(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the
specified Region.
|
default ListFargateProfilesPublisher |
listFargateProfilesPaginator(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the
specified Region.
|
default CompletableFuture<ListIdentityProviderConfigsResponse> |
listIdentityProviderConfigs(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)
A list of identity provider configurations.
|
default CompletableFuture<ListIdentityProviderConfigsResponse> |
listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
A list of identity provider configurations.
|
default ListIdentityProviderConfigsPublisher |
listIdentityProviderConfigsPaginator(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)
A list of identity provider configurations.
|
default ListIdentityProviderConfigsPublisher |
listIdentityProviderConfigsPaginator(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
A list of identity provider configurations.
|
default CompletableFuture<ListNodegroupsResponse> |
listNodegroups(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services
account in the specified Region.
|
default CompletableFuture<ListNodegroupsResponse> |
listNodegroups(ListNodegroupsRequest listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services
account in the specified Region.
|
default ListNodegroupsPublisher |
listNodegroupsPaginator(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services
account in the specified Region.
|
default ListNodegroupsPublisher |
listNodegroupsPaginator(ListNodegroupsRequest listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services
account in the specified Region.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for an Amazon EKS resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
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 cluster or managed node group in your Amazon Web Services
account, in the specified Region.
|
default CompletableFuture<ListUpdatesResponse> |
listUpdates(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services
account, in the specified Region.
|
default ListUpdatesPublisher |
listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services
account, in the specified Region.
|
default ListUpdatesPublisher |
listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services
account, in the specified Region.
|
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 CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
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.
|
default CompletableFuture<UpdateClusterConfigResponse> |
updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration.
|
default CompletableFuture<UpdateClusterConfigResponse> |
updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration.
|
default CompletableFuture<UpdateClusterVersionResponse> |
updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version.
|
default CompletableFuture<UpdateClusterVersionResponse> |
updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version.
|
default CompletableFuture<UpdateNodegroupConfigResponse> |
updateNodegroupConfig(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest)
Updates an Amazon EKS managed node group configuration.
|
default CompletableFuture<UpdateNodegroupConfigResponse> |
updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest)
Updates an Amazon EKS managed node group configuration.
|
default CompletableFuture<UpdateNodegroupVersionResponse> |
updateNodegroupVersion(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
|
default CompletableFuture<UpdateNodegroupVersionResponse> |
updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
|
default EksAsyncWaiter |
waiter()
Create an instance of
EksAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static EksAsyncClient create()
EksAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EksAsyncClientBuilder builder()
EksAsyncClient.default CompletableFuture<AssociateEncryptionConfigResponse> associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest)
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
associateEncryptionConfigRequest - default CompletableFuture<AssociateEncryptionConfigResponse> associateEncryptionConfig(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest)
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
This is a convenience which creates an instance of the AssociateEncryptionConfigRequest.Builder avoiding
the need to create one manually via AssociateEncryptionConfigRequest.builder()
associateEncryptionConfigRequest - A Consumer that will call methods on AssociateEncryptionConfigRequest.Builder to create a
request.default CompletableFuture<AssociateIdentityProviderConfigResponse> associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest)
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider
configuration and associate it to your cluster. After configuring authentication to your cluster you can create
Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the
roles to the identities using Kubernetes rolebindings and clusterrolebindings. For more
information see Using RBAC
Authorization in the Kubernetes documentation.
associateIdentityProviderConfigRequest - default CompletableFuture<AssociateIdentityProviderConfigResponse> associateIdentityProviderConfig(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest)
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider
configuration and associate it to your cluster. After configuring authentication to your cluster you can create
Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the
roles to the identities using Kubernetes rolebindings and clusterrolebindings. For more
information see Using RBAC
Authorization in the Kubernetes documentation.
This is a convenience which creates an instance of the AssociateIdentityProviderConfigRequest.Builder
avoiding the need to create one manually via AssociateIdentityProviderConfigRequest.builder()
associateIdentityProviderConfigRequest - A Consumer that will call methods on AssociateIdentityProviderConfigRequest.Builder to
create a request.default CompletableFuture<CreateAddonResponse> createAddon(CreateAddonRequest createAddonRequest)
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons require clusters running version 1.18 or later because Amazon EKS add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
createAddonRequest - 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. Amazon EKS add-ons require clusters running version 1.18 or later because Amazon EKS add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
This is a convenience which creates an instance of the CreateAddonRequest.Builder avoiding the need to
create one manually via CreateAddonRequest.builder()
createAddonRequest - A Consumer that will call methods on CreateAddonRequest.Builder to create a request.default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcd and the API server. The control plane runs in an account managed by Amazon Web Services, and
the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is
single tenant and unique. It runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load
Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to
provide connectivity from the control plane instances to the nodes (for example, to support
kubectl exec, logs, and proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
createClusterRequest - default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcd and the API server. The control plane runs in an account managed by Amazon Web Services, and
the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is
single tenant and unique. It runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load
Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to
provide connectivity from the control plane instances to the nodes (for example, to support
kubectl exec, logs, and proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.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.
createFargateProfileRequest - default CompletableFuture<CreateFargateProfileResponse> createFargateProfile(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest)
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled
with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet that is running on the Fargate infrastructure can register with
your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more
information, see Pod Execution
Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate
profile to finish deleting before you can create any other profiles in that cluster.
For more information, see Fargate Profile in the Amazon EKS User Guide.
This is a convenience which creates an instance of the CreateFargateProfileRequest.Builder avoiding the
need to create one manually via CreateFargateProfileRequest.builder()
createFargateProfileRequest - A Consumer that will call methods on CreateFargateProfileRequest.Builder to create a
request.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. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.
createNodegroupRequest - 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. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.
This is a convenience which creates an instance of the CreateNodegroupRequest.Builder avoiding the need
to create one manually via CreateNodegroupRequest.builder()
createNodegroupRequest - A Consumer that will call methods on CreateNodegroupRequest.Builder to create a request.default CompletableFuture<DeleteAddonResponse> deleteAddon(DeleteAddonRequest deleteAddonRequest)
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
deleteAddonRequest - default CompletableFuture<DeleteAddonResponse> deleteAddon(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest)
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
This is a convenience which creates an instance of the DeleteAddonRequest.Builder avoiding the need to
create one manually via DeleteAddonRequest.builder()
deleteAddonRequest - A Consumer that will call methods on DeleteAddonRequest.Builder to create a request.default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
deleteClusterRequest - default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.default CompletableFuture<DeleteFargateProfileResponse> deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest)
Deletes an Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
deleteFargateProfileRequest - default CompletableFuture<DeleteFargateProfileResponse> deleteFargateProfile(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest)
Deletes an Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
This is a convenience which creates an instance of the DeleteFargateProfileRequest.Builder avoiding the
need to create one manually via DeleteFargateProfileRequest.builder()
deleteFargateProfileRequest - A Consumer that will call methods on DeleteFargateProfileRequest.Builder to create a
request.default CompletableFuture<DeleteNodegroupResponse> deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest)
Deletes an Amazon EKS node group for a cluster.
deleteNodegroupRequest - default CompletableFuture<DeleteNodegroupResponse> deleteNodegroup(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest)
Deletes an Amazon EKS node group for a cluster.
This is a convenience which creates an instance of the DeleteNodegroupRequest.Builder avoiding the need
to create one manually via DeleteNodegroupRequest.builder()
deleteNodegroupRequest - A Consumer that will call methods on DeleteNodegroupRequest.Builder to create a request.default CompletableFuture<DeregisterClusterResponse> deregisterCluster(DeregisterClusterRequest deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
deregisterClusterRequest - default CompletableFuture<DeregisterClusterResponse> deregisterCluster(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest)
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
This is a convenience which creates an instance of the DeregisterClusterRequest.Builder avoiding the need
to create one manually via DeregisterClusterRequest.builder()
deregisterClusterRequest - A Consumer that will call methods on DeregisterClusterRequest.Builder to create a request.default CompletableFuture<DescribeAddonResponse> describeAddon(DescribeAddonRequest describeAddonRequest)
Describes an Amazon EKS add-on.
describeAddonRequest - default CompletableFuture<DescribeAddonResponse> describeAddon(Consumer<DescribeAddonRequest.Builder> describeAddonRequest)
Describes an Amazon EKS add-on.
This is a convenience which creates an instance of the DescribeAddonRequest.Builder avoiding the need to
create one manually via DescribeAddonRequest.builder()
describeAddonRequest - A Consumer that will call methods on DescribeAddonRequest.Builder to create a request.default CompletableFuture<DescribeAddonVersionsResponse> describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
describeAddonVersionsRequest - default CompletableFuture<DescribeAddonVersionsResponse> describeAddonVersions(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
This is a convenience which creates an instance of the DescribeAddonVersionsRequest.Builder avoiding the
need to create one manually via DescribeAddonVersionsRequest.builder()
describeAddonVersionsRequest - A Consumer that will call methods on DescribeAddonVersionsRequest.Builder to create a
request.default DescribeAddonVersionsPublisher describeAddonVersionsPaginator(DescribeAddonVersionsRequest describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.
describeAddonVersionsRequest - default DescribeAddonVersionsPublisher describeAddonVersionsPaginator(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest)
Describes the Kubernetes versions that the add-on can be used with.
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsPublisher publisher = client.describeAddonVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAddonVersionsRequest.Builder avoiding the
need to create one manually via DescribeAddonVersionsRequest.builder()
describeAddonVersionsRequest - A Consumer that will call methods on DescribeAddonVersionsRequest.Builder to create a
request.default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet and kubectl to communicate with your Kubernetes API server. For more
information, see Create a
kubeconfig for Amazon EKS.
The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVE state.
describeClusterRequest - default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet and kubectl to communicate with your Kubernetes API server. For more
information, see Create a
kubeconfig for Amazon EKS.
The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVE state.
This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need
to create one manually via DescribeClusterRequest.builder()
describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.default CompletableFuture<DescribeFargateProfileResponse> describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest)
Returns descriptive information about an Fargate profile.
describeFargateProfileRequest - default CompletableFuture<DescribeFargateProfileResponse> describeFargateProfile(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest)
Returns descriptive information about an Fargate profile.
This is a convenience which creates an instance of the DescribeFargateProfileRequest.Builder avoiding the
need to create one manually via DescribeFargateProfileRequest.builder()
describeFargateProfileRequest - A Consumer that will call methods on DescribeFargateProfileRequest.Builder to create a
request.default CompletableFuture<DescribeIdentityProviderConfigResponse> describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest)
Returns descriptive information about an identity provider configuration.
describeIdentityProviderConfigRequest - default CompletableFuture<DescribeIdentityProviderConfigResponse> describeIdentityProviderConfig(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest)
Returns descriptive information about an identity provider configuration.
This is a convenience which creates an instance of the DescribeIdentityProviderConfigRequest.Builder
avoiding the need to create one manually via DescribeIdentityProviderConfigRequest.builder()
describeIdentityProviderConfigRequest - A Consumer that will call methods on DescribeIdentityProviderConfigRequest.Builder to
create a request.default CompletableFuture<DescribeNodegroupResponse> describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest)
Returns descriptive information about an Amazon EKS node group.
describeNodegroupRequest - default CompletableFuture<DescribeNodegroupResponse> describeNodegroup(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest)
Returns descriptive information about an Amazon EKS node group.
This is a convenience which creates an instance of the DescribeNodegroupRequest.Builder avoiding the need
to create one manually via DescribeNodegroupRequest.builder()
describeNodegroupRequest - A Consumer that will call methods on DescribeNodegroupRequest.Builder to create a request.default CompletableFuture<DescribeUpdateResponse> describeUpdate(DescribeUpdateRequest describeUpdateRequest)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update is Succeeded, the update is complete. If an update fails, the status
is Failed, and an error detail explains the reason for the failure.
describeUpdateRequest - default CompletableFuture<DescribeUpdateResponse> describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update is Succeeded, the update is complete. If an update fails, the status
is Failed, and an error detail explains the reason for the failure.
This is a convenience which creates an instance of the DescribeUpdateRequest.Builder avoiding the need to
create one manually via DescribeUpdateRequest.builder()
describeUpdateRequest - A Consumer that will call methods on DescribeUpdateRequest.Builder to create a request.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 Amazon Web Services IAM users.
disassociateIdentityProviderConfigRequest - 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 Amazon Web Services IAM users.
This is a convenience which creates an instance of the DisassociateIdentityProviderConfigRequest.Builder
avoiding the need to create one manually via DisassociateIdentityProviderConfigRequest.builder()
disassociateIdentityProviderConfigRequest - A Consumer that will call methods on DisassociateIdentityProviderConfigRequest.Builder to
create a request.default CompletableFuture<ListAddonsResponse> listAddons(ListAddonsRequest listAddonsRequest)
Lists the available add-ons.
listAddonsRequest - default CompletableFuture<ListAddonsResponse> listAddons(Consumer<ListAddonsRequest.Builder> listAddonsRequest)
Lists the available add-ons.
This is a convenience which creates an instance of the ListAddonsRequest.Builder avoiding the need to
create one manually via ListAddonsRequest.builder()
listAddonsRequest - A Consumer that will call methods on ListAddonsRequest.Builder to create a request.default ListAddonsPublisher listAddonsPaginator(ListAddonsRequest listAddonsRequest)
Lists the available add-ons.
This is a variant of listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAddonsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListAddonsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation.
listAddonsRequest - default ListAddonsPublisher listAddonsPaginator(Consumer<ListAddonsRequest.Builder> listAddonsRequest)
Lists the available add-ons.
This is a variant of listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListAddonsPublisher publisher = client.listAddonsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListAddonsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListAddonsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest) operation.
This is a convenience which creates an instance of the ListAddonsRequest.Builder avoiding the need to
create one manually via ListAddonsRequest.builder()
listAddonsRequest - A Consumer that will call methods on ListAddonsRequest.Builder to create a request.default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
listClustersRequest - default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.default CompletableFuture<ListClustersResponse> listClusters()
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
default ListClustersPublisher listClustersPaginator()
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.
default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.
listClustersRequest - default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
This is a variant of listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest) operation.
This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.default CompletableFuture<ListFargateProfilesResponse> listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
listFargateProfilesRequest - default CompletableFuture<ListFargateProfilesResponse> listFargateProfiles(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
This is a convenience which creates an instance of the ListFargateProfilesRequest.Builder avoiding the
need to create one manually via ListFargateProfilesRequest.builder()
listFargateProfilesRequest - A Consumer that will call methods on ListFargateProfilesRequest.Builder to create a
request.default ListFargateProfilesPublisher listFargateProfilesPaginator(ListFargateProfilesRequest listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
This is a variant of
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation.
listFargateProfilesRequest - default ListFargateProfilesPublisher listFargateProfilesPaginator(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest)
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
This is a variant of
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListFargateProfilesPublisher publisher = client.listFargateProfilesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest) operation.
This is a convenience which creates an instance of the ListFargateProfilesRequest.Builder avoiding the
need to create one manually via ListFargateProfilesRequest.builder()
listFargateProfilesRequest - A Consumer that will call methods on ListFargateProfilesRequest.Builder to create a
request.default CompletableFuture<ListIdentityProviderConfigsResponse> listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
A list of identity provider configurations.
listIdentityProviderConfigsRequest - default CompletableFuture<ListIdentityProviderConfigsResponse> listIdentityProviderConfigs(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)
A list of identity provider configurations.
This is a convenience which creates an instance of the ListIdentityProviderConfigsRequest.Builder
avoiding the need to create one manually via ListIdentityProviderConfigsRequest.builder()
listIdentityProviderConfigsRequest - A Consumer that will call methods on ListIdentityProviderConfigsRequest.Builder to create
a request.default ListIdentityProviderConfigsPublisher listIdentityProviderConfigsPaginator(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest)
A list of identity provider configurations.
This is a variant of
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.
listIdentityProviderConfigsRequest - default ListIdentityProviderConfigsPublisher listIdentityProviderConfigsPaginator(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest)
A list of identity provider configurations.
This is a variant of
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsPublisher publisher = client.listIdentityProviderConfigsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.
This is a convenience which creates an instance of the ListIdentityProviderConfigsRequest.Builder
avoiding the need to create one manually via ListIdentityProviderConfigsRequest.builder()
listIdentityProviderConfigsRequest - A Consumer that will call methods on ListIdentityProviderConfigsRequest.Builder to create
a request.default CompletableFuture<ListNodegroupsResponse> listNodegroups(ListNodegroupsRequest listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
listNodegroupsRequest - default CompletableFuture<ListNodegroupsResponse> listNodegroups(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
This is a convenience which creates an instance of the ListNodegroupsRequest.Builder avoiding the need to
create one manually via ListNodegroupsRequest.builder()
listNodegroupsRequest - A Consumer that will call methods on ListNodegroupsRequest.Builder to create a request.default ListNodegroupsPublisher listNodegroupsPaginator(ListNodegroupsRequest listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
This is a variant of listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListNodegroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest) operation.
listNodegroupsRequest - default ListNodegroupsPublisher listNodegroupsPaginator(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest)
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
This is a variant of listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListNodegroupsPublisher publisher = client.listNodegroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListNodegroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest) operation.
This is a convenience which creates an instance of the ListNodegroupsRequest.Builder avoiding the need to
create one manually via ListNodegroupsRequest.builder()
listNodegroupsRequest - A Consumer that will call methods on ListNodegroupsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon EKS resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for an Amazon EKS resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListUpdatesResponse> listUpdates(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
listUpdatesRequest - default CompletableFuture<ListUpdatesResponse> listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
This is a convenience which creates an instance of the ListUpdatesRequest.Builder avoiding the need to
create one manually via ListUpdatesRequest.builder()
listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.default ListUpdatesPublisher listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListUpdatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListUpdatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation.
listUpdatesRequest - default ListUpdatesPublisher listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest)
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
This is a variant of listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.eks.paginators.ListUpdatesPublisher publisher = client.listUpdatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.eks.model.ListUpdatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.eks.model.ListUpdatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest) operation.
This is a convenience which creates an instance of the ListUpdatesRequest.Builder avoiding the need to
create one manually via ListUpdatesRequest.builder()
listUpdatesRequest - A Consumer that will call methods on ListUpdatesRequest.Builder to create a request.default CompletableFuture<RegisterClusterResponse> registerCluster(RegisterClusterRequest registerClusterRequest)
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to
the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the
Kubernetes cluster through it's native provider to provide visibility.
After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
registerClusterRequest - default CompletableFuture<RegisterClusterResponse> registerCluster(Consumer<RegisterClusterRequest.Builder> registerClusterRequest)
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to
the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the
Kubernetes cluster through it's native provider to provide visibility.
After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
This is a convenience which creates an instance of the RegisterClusterRequest.Builder avoiding the need
to create one manually via RegisterClusterRequest.builder()
registerClusterRequest - A Consumer that will call methods on RegisterClusterRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate
to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that
tag does not automatically propagate to the subnets and nodes associated with the cluster.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate
to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that
tag does not automatically propagate to the subnets and nodes associated with the cluster.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateAddonResponse> updateAddon(UpdateAddonRequest updateAddonRequest)
Updates an Amazon EKS add-on.
updateAddonRequest - default CompletableFuture<UpdateAddonResponse> updateAddon(Consumer<UpdateAddonRequest.Builder> updateAddonRequest)
Updates an Amazon EKS add-on.
This is a convenience which creates an instance of the UpdateAddonRequest.Builder avoiding the need to
create one manually via UpdateAddonRequest.builder()
updateAddonRequest - A Consumer that will call methods on UpdateAddonRequest.Builder to create a request.default CompletableFuture<UpdateClusterConfigResponse> updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
You can't update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
updateClusterConfigRequest - default CompletableFuture<UpdateClusterConfigResponse> updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest)
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
You can't update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
This is a convenience which creates an instance of the UpdateClusterConfigRequest.Builder avoiding the
need to create one manually via UpdateClusterConfigRequest.builder()
updateClusterConfigRequest - A Consumer that will call methods on UpdateClusterConfigRequest.Builder to create a
request.default CompletableFuture<UpdateClusterVersionResponse> updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
updateClusterVersionRequest - default CompletableFuture<UpdateClusterVersionResponse> updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest)
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster
status moves to UPDATING (this status transition is eventually consistent). When the update is
complete (either Failed or Successful), the cluster status moves to Active
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
This is a convenience which creates an instance of the UpdateClusterVersionRequest.Builder avoiding the
need to create one manually via UpdateClusterVersionRequest.builder()
updateClusterVersionRequest - A Consumer that will call methods on UpdateClusterVersionRequest.Builder to create a
request.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.
updateNodegroupConfigRequest - default CompletableFuture<UpdateNodegroupConfigResponse> updateNodegroupConfig(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest)
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
This is a convenience which creates an instance of the UpdateNodegroupConfigRequest.Builder avoiding the
need to create one manually via UpdateNodegroupConfigRequest.builder()
updateNodegroupConfigRequest - A Consumer that will call methods on UpdateNodegroupConfigRequest.Builder to create a
request.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 more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are
drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget
issue.
updateNodegroupVersionRequest - 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 more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are
drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget
issue.
This is a convenience which creates an instance of the UpdateNodegroupVersionRequest.Builder avoiding the
need to create one manually via UpdateNodegroupVersionRequest.builder()
updateNodegroupVersionRequest - A Consumer that will call methods on UpdateNodegroupVersionRequest.Builder to create a
request.default EksAsyncWaiter waiter()
EksAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
EksAsyncWaiter