Interface EksClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateEncryptionConfig
(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest) Associate encryption configuration to an existing cluster.associateEncryptionConfig
(AssociateEncryptionConfigRequest associateEncryptionConfigRequest) Associate encryption configuration to an existing cluster.associateIdentityProviderConfig
(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest) Associate an identity provider configuration to a cluster.associateIdentityProviderConfig
(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest) Associate an identity provider configuration to a cluster.static EksClientBuilder
builder()
Create a builder that can be used to configure and create aEksClient
.static EksClient
create()
Create aEksClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAddonResponse
createAddon
(Consumer<CreateAddonRequest.Builder> createAddonRequest) Creates an Amazon EKS add-on.default CreateAddonResponse
createAddon
(CreateAddonRequest createAddonRequest) Creates an Amazon EKS add-on.default CreateClusterResponse
createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates an Amazon EKS control plane.default CreateClusterResponse
createCluster
(CreateClusterRequest createClusterRequest) Creates an Amazon EKS control plane.createEksAnywhereSubscription
(Consumer<CreateEksAnywhereSubscriptionRequest.Builder> createEksAnywhereSubscriptionRequest) Creates an EKS Anywhere subscription.createEksAnywhereSubscription
(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest) Creates an EKS Anywhere subscription.default CreateFargateProfileResponse
createFargateProfile
(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest) Creates an Fargate profile for your Amazon EKS cluster.default CreateFargateProfileResponse
createFargateProfile
(CreateFargateProfileRequest createFargateProfileRequest) Creates an Fargate profile for your Amazon EKS cluster.default CreateNodegroupResponse
createNodegroup
(Consumer<CreateNodegroupRequest.Builder> createNodegroupRequest) Creates a managed node group for an Amazon EKS cluster.default CreateNodegroupResponse
createNodegroup
(CreateNodegroupRequest createNodegroupRequest) Creates a managed node group for an Amazon EKS cluster.default DeleteAddonResponse
deleteAddon
(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest) Delete an Amazon EKS add-on.default DeleteAddonResponse
deleteAddon
(DeleteAddonRequest deleteAddonRequest) Delete an Amazon EKS add-on.default DeleteClusterResponse
deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the Amazon EKS cluster control plane.default DeleteClusterResponse
deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes the Amazon EKS cluster control plane.deleteEksAnywhereSubscription
(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest) Deletes an expired / inactive subscription.deleteEksAnywhereSubscription
(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest) Deletes an expired / inactive subscription.default DeleteFargateProfileResponse
deleteFargateProfile
(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest) Deletes an Fargate profile.default DeleteFargateProfileResponse
deleteFargateProfile
(DeleteFargateProfileRequest deleteFargateProfileRequest) Deletes an Fargate profile.default DeleteNodegroupResponse
deleteNodegroup
(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest) Deletes an Amazon EKS node group for a cluster.default DeleteNodegroupResponse
deleteNodegroup
(DeleteNodegroupRequest deleteNodegroupRequest) Deletes an Amazon EKS node group for a cluster.default DeregisterClusterResponse
deregisterCluster
(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest) Deregisters a connected cluster to remove it from the Amazon EKS control plane.default DeregisterClusterResponse
deregisterCluster
(DeregisterClusterRequest deregisterClusterRequest) Deregisters a connected cluster to remove it from the Amazon EKS control plane.default DescribeAddonResponse
describeAddon
(Consumer<DescribeAddonRequest.Builder> describeAddonRequest) Describes an Amazon EKS add-on.default DescribeAddonResponse
describeAddon
(DescribeAddonRequest describeAddonRequest) Describes an Amazon EKS add-on.describeAddonConfiguration
(Consumer<DescribeAddonConfigurationRequest.Builder> describeAddonConfigurationRequest) Returns configuration options.describeAddonConfiguration
(DescribeAddonConfigurationRequest describeAddonConfigurationRequest) Returns configuration options.default DescribeAddonVersionsResponse
describeAddonVersions
(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) Describes the versions for an add-on.default DescribeAddonVersionsResponse
describeAddonVersions
(DescribeAddonVersionsRequest describeAddonVersionsRequest) Describes the versions for an add-on.default DescribeAddonVersionsIterable
describeAddonVersionsPaginator
(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) Describes the versions for an add-on.default DescribeAddonVersionsIterable
describeAddonVersionsPaginator
(DescribeAddonVersionsRequest describeAddonVersionsRequest) Describes the versions for an add-on.default DescribeClusterResponse
describeCluster
(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) Returns descriptive information about an Amazon EKS cluster.default DescribeClusterResponse
describeCluster
(DescribeClusterRequest describeClusterRequest) Returns descriptive information about an Amazon EKS cluster.describeEksAnywhereSubscription
(Consumer<DescribeEksAnywhereSubscriptionRequest.Builder> describeEksAnywhereSubscriptionRequest) Returns descriptive information about a subscription.describeEksAnywhereSubscription
(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest) Returns descriptive information about a subscription.default DescribeFargateProfileResponse
describeFargateProfile
(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest) Returns descriptive information about an Fargate profile.default DescribeFargateProfileResponse
describeFargateProfile
(DescribeFargateProfileRequest describeFargateProfileRequest) Returns descriptive information about an Fargate profile.describeIdentityProviderConfig
(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest) Returns descriptive information about an identity provider configuration.describeIdentityProviderConfig
(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest) Returns descriptive information about an identity provider configuration.default DescribeNodegroupResponse
describeNodegroup
(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest) Returns descriptive information about an Amazon EKS node group.default DescribeNodegroupResponse
describeNodegroup
(DescribeNodegroupRequest describeNodegroupRequest) Returns descriptive information about an Amazon EKS node group.default DescribeUpdateResponse
describeUpdate
(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest) Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.default DescribeUpdateResponse
describeUpdate
(DescribeUpdateRequest describeUpdateRequest) Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.disassociateIdentityProviderConfig
(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest) Disassociates an identity provider configuration from a cluster.disassociateIdentityProviderConfig
(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest) Disassociates an identity provider configuration from a cluster.default ListAddonsResponse
listAddons
(Consumer<ListAddonsRequest.Builder> listAddonsRequest) Lists the installed add-ons.default ListAddonsResponse
listAddons
(ListAddonsRequest listAddonsRequest) Lists the installed add-ons.default ListAddonsIterable
listAddonsPaginator
(Consumer<ListAddonsRequest.Builder> listAddonsRequest) Lists the installed add-ons.default ListAddonsIterable
listAddonsPaginator
(ListAddonsRequest listAddonsRequest) Lists the installed add-ons.default ListClustersResponse
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.default ListClustersResponse
listClusters
(Consumer<ListClustersRequest.Builder> listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.default ListClustersResponse
listClusters
(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.default ListClustersIterable
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.default ListClustersIterable
listClustersPaginator
(Consumer<ListClustersRequest.Builder> listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.default ListClustersIterable
listClustersPaginator
(ListClustersRequest listClustersRequest) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.listEksAnywhereSubscriptions
(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) Displays the full description of the subscription.listEksAnywhereSubscriptions
(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) Displays the full description of the subscription.default 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 ListFargateProfilesResponse
listFargateProfiles
(ListFargateProfilesRequest listFargateProfilesRequest) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.default ListFargateProfilesIterable
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 ListFargateProfilesIterable
listFargateProfilesPaginator
(ListFargateProfilesRequest listFargateProfilesRequest) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.listIdentityProviderConfigs
(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) A list of identity provider configurations.listIdentityProviderConfigs
(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) A list of identity provider configurations.listIdentityProviderConfigsPaginator
(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) A list of identity provider configurations.listIdentityProviderConfigsPaginator
(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) A list of identity provider configurations.default 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 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 ListNodegroupsIterable
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 ListNodegroupsIterable
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 ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon EKS resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon EKS resource.default 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 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 ListUpdatesIterable
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 ListUpdatesIterable
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 RegisterClusterResponse
registerCluster
(Consumer<RegisterClusterRequest.Builder> registerClusterRequest) Connects a Kubernetes cluster to the Amazon EKS control plane.default RegisterClusterResponse
registerCluster
(RegisterClusterRequest registerClusterRequest) Connects a Kubernetes cluster to the Amazon EKS control plane.default EksServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.default UpdateAddonResponse
updateAddon
(Consumer<UpdateAddonRequest.Builder> updateAddonRequest) Updates an Amazon EKS add-on.default UpdateAddonResponse
updateAddon
(UpdateAddonRequest updateAddonRequest) Updates an Amazon EKS add-on.default UpdateClusterConfigResponse
updateClusterConfig
(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.default UpdateClusterConfigResponse
updateClusterConfig
(UpdateClusterConfigRequest updateClusterConfigRequest) Updates an Amazon EKS cluster configuration.default UpdateClusterVersionResponse
updateClusterVersion
(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.default UpdateClusterVersionResponse
updateClusterVersion
(UpdateClusterVersionRequest updateClusterVersionRequest) Updates an Amazon EKS cluster to the specified Kubernetes version.updateEksAnywhereSubscription
(Consumer<UpdateEksAnywhereSubscriptionRequest.Builder> updateEksAnywhereSubscriptionRequest) Update an EKS Anywhere Subscription.updateEksAnywhereSubscription
(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest) Update an EKS Anywhere Subscription.default UpdateNodegroupConfigResponse
updateNodegroupConfig
(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest) Updates an Amazon EKS managed node group configuration.default UpdateNodegroupConfigResponse
updateNodegroupConfig
(UpdateNodegroupConfigRequest updateNodegroupConfigRequest) Updates an Amazon EKS managed node group configuration.default UpdateNodegroupVersionResponse
updateNodegroupVersion
(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.default UpdateNodegroupVersionResponse
updateNodegroupVersion
(UpdateNodegroupVersionRequest updateNodegroupVersionRequest) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.default EksWaiter
waiter()
Create an instance ofEksWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateEncryptionConfig
default AssociateEncryptionConfigResponse associateEncryptionConfig(AssociateEncryptionConfigRequest associateEncryptionConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
- Parameters:
associateEncryptionConfigRequest
-- Returns:
- Result of the AssociateEncryptionConfig operation returned by the service.
- See Also:
-
associateEncryptionConfig
default AssociateEncryptionConfigResponse associateEncryptionConfig(Consumer<AssociateEncryptionConfigRequest.Builder> associateEncryptionConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException 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 viaAssociateEncryptionConfigRequest.builder()
- Parameters:
associateEncryptionConfigRequest
- AConsumer
that will call methods onAssociateEncryptionConfigRequest.Builder
to create a request.- Returns:
- Result of the AssociateEncryptionConfig operation returned by the service.
- See Also:
-
associateIdentityProviderConfig
default AssociateIdentityProviderConfigResponse associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest associateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException 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
andclusterroles
to assign permissions to the roles, and then bind the roles to the identities using Kubernetesrolebindings
andclusterrolebindings
. For more information see Using RBAC Authorization in the Kubernetes documentation.- Parameters:
associateIdentityProviderConfigRequest
-- Returns:
- Result of the AssociateIdentityProviderConfig operation returned by the service.
- See Also:
-
associateIdentityProviderConfig
default AssociateIdentityProviderConfigResponse associateIdentityProviderConfig(Consumer<AssociateIdentityProviderConfigRequest.Builder> associateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException 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
andclusterroles
to assign permissions to the roles, and then bind the roles to the identities using Kubernetesrolebindings
andclusterrolebindings
. For more information see Using RBAC Authorization in the Kubernetes documentation.
This is a convenience which creates an instance of the
AssociateIdentityProviderConfigRequest.Builder
avoiding the need to create one manually viaAssociateIdentityProviderConfigRequest.builder()
- Parameters:
associateIdentityProviderConfigRequest
- AConsumer
that will call methods onAssociateIdentityProviderConfigRequest.Builder
to create a request.- Returns:
- Result of the AssociateIdentityProviderConfig operation returned by the service.
- See Also:
-
createAddon
default CreateAddonResponse createAddon(CreateAddonRequest createAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
- Parameters:
createAddonRequest
-- Returns:
- Result of the CreateAddon operation returned by the service.
- See Also:
-
createAddon
default CreateAddonResponse createAddon(Consumer<CreateAddonRequest.Builder> createAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
CreateAddonRequest.Builder
avoiding the need to create one manually viaCreateAddonRequest.builder()
- Parameters:
createAddonRequest
- AConsumer
that will call methods onCreateAddonRequest.Builder
to create a request.- Returns:
- Result of the CreateAddon operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcd
and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support
kubectl exec
,logs
, andproxy
data flows).Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as
etcd
and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support
kubectl exec
,logs
, andproxy
data flows).Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createEksAnywhereSubscription
default CreateEksAnywhereSubscriptionResponse createEksAnywhereSubscription(CreateEksAnywhereSubscriptionRequest createEksAnywhereSubscriptionRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.
- Parameters:
createEksAnywhereSubscriptionRequest
-- Returns:
- Result of the CreateEksAnywhereSubscription operation returned by the service.
- See Also:
-
createEksAnywhereSubscription
default CreateEksAnywhereSubscriptionResponse createEksAnywhereSubscription(Consumer<CreateEksAnywhereSubscriptionRequest.Builder> createEksAnywhereSubscriptionRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.
This is a convenience which creates an instance of the
CreateEksAnywhereSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateEksAnywhereSubscriptionRequest.builder()
- Parameters:
createEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onCreateEksAnywhereSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateEksAnywhereSubscription operation returned by the service.
- See Also:
-
createFargateProfile
default CreateFargateProfileResponse createFargateProfile(CreateFargateProfileRequest createFargateProfileRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ServerException, ResourceLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the
kubelet
that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the
DELETING
status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.For more information, see Fargate Profile in the Amazon EKS User Guide.
- Parameters:
createFargateProfileRequest
-- Returns:
- Result of the CreateFargateProfile operation returned by the service.
- See Also:
-
createFargateProfile
default CreateFargateProfileResponse createFargateProfile(Consumer<CreateFargateProfileRequest.Builder> createFargateProfileRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ServerException, ResourceLimitExceededException, UnsupportedAvailabilityZoneException, AwsServiceException, SdkClientException, EksException Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the
kubelet
that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the
DELETING
status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.For more information, see Fargate Profile in the Amazon EKS User Guide.
This is a convenience which creates an instance of the
CreateFargateProfileRequest.Builder
avoiding the need to create one manually viaCreateFargateProfileRequest.builder()
- Parameters:
createFargateProfileRequest
- AConsumer
that will call methods onCreateFargateProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateFargateProfile operation returned by the service.
- See Also:
-
createNodegroup
default CreateNodegroupResponse createNodegroup(CreateNodegroupRequest createNodegroupRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidRequestException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Regions that support Windows Amazon EKS.
- Parameters:
createNodegroupRequest
-- Returns:
- Result of the CreateNodegroup operation returned by the service.
- See Also:
-
createNodegroup
default CreateNodegroupResponse createNodegroup(Consumer<CreateNodegroupRequest.Builder> createNodegroupRequest) throws ResourceInUseException, ResourceLimitExceededException, InvalidRequestException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Regions that support Windows Amazon EKS.
This is a convenience which creates an instance of the
CreateNodegroupRequest.Builder
avoiding the need to create one manually viaCreateNodegroupRequest.builder()
- Parameters:
createNodegroupRequest
- AConsumer
that will call methods onCreateNodegroupRequest.Builder
to create a request.- Returns:
- Result of the CreateNodegroup operation returned by the service.
- See Also:
-
deleteAddon
default DeleteAddonResponse deleteAddon(DeleteAddonRequest deleteAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
- Parameters:
deleteAddonRequest
-- Returns:
- Result of the DeleteAddon operation returned by the service.
- See Also:
-
deleteAddon
default DeleteAddonResponse deleteAddon(Consumer<DeleteAddonRequest.Builder> deleteAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException 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 viaDeleteAddonRequest.builder()
- Parameters:
deleteAddonRequest
- AConsumer
that will call methods onDeleteAddonRequest.Builder
to create a request.- Returns:
- Result of the DeleteAddon operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteEksAnywhereSubscription
default DeleteEksAnywhereSubscriptionResponse deleteEksAnywhereSubscription(DeleteEksAnywhereSubscriptionRequest deleteEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, InvalidRequestException, ServerException, AwsServiceException, SdkClientException, EksException Deletes an expired / inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation, and are cancelled by creating a ticket in the Amazon Web Services Support Center.
- Parameters:
deleteEksAnywhereSubscriptionRequest
-- Returns:
- Result of the DeleteEksAnywhereSubscription operation returned by the service.
- See Also:
-
deleteEksAnywhereSubscription
default DeleteEksAnywhereSubscriptionResponse deleteEksAnywhereSubscription(Consumer<DeleteEksAnywhereSubscriptionRequest.Builder> deleteEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, InvalidRequestException, ServerException, AwsServiceException, SdkClientException, EksException Deletes an expired / inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation, and are cancelled by creating a ticket in the Amazon Web Services Support Center.
This is a convenience which creates an instance of the
DeleteEksAnywhereSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteEksAnywhereSubscriptionRequest.builder()
- Parameters:
deleteEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onDeleteEksAnywhereSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DeleteEksAnywhereSubscription operation returned by the service.
- See Also:
-
deleteFargateProfile
default DeleteFargateProfileResponse deleteFargateProfile(DeleteFargateProfileRequest deleteFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Deletes an Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the
DELETING
status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.- Parameters:
deleteFargateProfileRequest
-- Returns:
- Result of the DeleteFargateProfile operation returned by the service.
- See Also:
-
deleteFargateProfile
default DeleteFargateProfileResponse deleteFargateProfile(Consumer<DeleteFargateProfileRequest.Builder> deleteFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 viaDeleteFargateProfileRequest.builder()
- Parameters:
deleteFargateProfileRequest
- AConsumer
that will call methods onDeleteFargateProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteFargateProfile operation returned by the service.
- See Also:
-
deleteNodegroup
default DeleteNodegroupResponse deleteNodegroup(DeleteNodegroupRequest deleteNodegroupRequest) throws ResourceInUseException, ResourceNotFoundException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Deletes an Amazon EKS node group for a cluster.
- Parameters:
deleteNodegroupRequest
-- Returns:
- Result of the DeleteNodegroup operation returned by the service.
- See Also:
-
deleteNodegroup
default DeleteNodegroupResponse deleteNodegroup(Consumer<DeleteNodegroupRequest.Builder> deleteNodegroupRequest) throws ResourceInUseException, ResourceNotFoundException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 viaDeleteNodegroupRequest.builder()
- Parameters:
deleteNodegroupRequest
- AConsumer
that will call methods onDeleteNodegroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteNodegroup operation returned by the service.
- See Also:
-
deregisterCluster
default DeregisterClusterResponse deregisterCluster(DeregisterClusterRequest deregisterClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, EksException Deregisters a connected cluster to remove it from the Amazon EKS control plane.
- Parameters:
deregisterClusterRequest
-- Returns:
- Result of the DeregisterCluster operation returned by the service.
- See Also:
-
deregisterCluster
default DeregisterClusterResponse deregisterCluster(Consumer<DeregisterClusterRequest.Builder> deregisterClusterRequest) throws ResourceInUseException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, AwsServiceException, SdkClientException, EksException 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 viaDeregisterClusterRequest.builder()
- Parameters:
deregisterClusterRequest
- AConsumer
that will call methods onDeregisterClusterRequest.Builder
to create a request.- Returns:
- Result of the DeregisterCluster operation returned by the service.
- See Also:
-
describeAddon
default DescribeAddonResponse describeAddon(DescribeAddonRequest describeAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Describes an Amazon EKS add-on.
- Parameters:
describeAddonRequest
-- Returns:
- Result of the DescribeAddon operation returned by the service.
- See Also:
-
describeAddon
default DescribeAddonResponse describeAddon(Consumer<DescribeAddonRequest.Builder> describeAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Describes an Amazon EKS add-on.
This is a convenience which creates an instance of the
DescribeAddonRequest.Builder
avoiding the need to create one manually viaDescribeAddonRequest.builder()
- Parameters:
describeAddonRequest
- AConsumer
that will call methods onDescribeAddonRequest.Builder
to create a request.- Returns:
- Result of the DescribeAddon operation returned by the service.
- See Also:
-
describeAddonConfiguration
default DescribeAddonConfigurationResponse describeAddonConfiguration(DescribeAddonConfigurationRequest describeAddonConfigurationRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Returns configuration options.
- Parameters:
describeAddonConfigurationRequest
-- Returns:
- Result of the DescribeAddonConfiguration operation returned by the service.
- See Also:
-
describeAddonConfiguration
default DescribeAddonConfigurationResponse describeAddonConfiguration(Consumer<DescribeAddonConfigurationRequest.Builder> describeAddonConfigurationRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Returns configuration options.
This is a convenience which creates an instance of the
DescribeAddonConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeAddonConfigurationRequest.builder()
- Parameters:
describeAddonConfigurationRequest
- AConsumer
that will call methods onDescribeAddonConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeAddonConfiguration operation returned by the service.
- See Also:
-
describeAddonVersions
default DescribeAddonVersionsResponse describeAddonVersions(DescribeAddonVersionsRequest describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the
owner
,publisher
, and thetype
of the add-on are returned.- Parameters:
describeAddonVersionsRequest
-- Returns:
- Result of the DescribeAddonVersions operation returned by the service.
- See Also:
-
describeAddonVersions
default DescribeAddonVersionsResponse describeAddonVersions(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the
owner
,publisher
, and thetype
of the add-on are returned.
This is a convenience which creates an instance of the
DescribeAddonVersionsRequest.Builder
avoiding the need to create one manually viaDescribeAddonVersionsRequest.builder()
- Parameters:
describeAddonVersionsRequest
- AConsumer
that will call methods onDescribeAddonVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAddonVersions operation returned by the service.
- See Also:
-
describeAddonVersionsPaginator
default DescribeAddonVersionsIterable describeAddonVersionsPaginator(DescribeAddonVersionsRequest describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the
owner
,publisher
, and thetype
of the add-on are returned.
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client .describeAddonVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.- Parameters:
describeAddonVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAddonVersionsPaginator
default DescribeAddonVersionsIterable describeAddonVersionsPaginator(Consumer<DescribeAddonVersionsRequest.Builder> describeAddonVersionsRequest) throws ServerException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EksException Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the
owner
,publisher
, and thetype
of the add-on are returned.
This is a variant of
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client .describeAddonVersionsPaginator(request); for (software.amazon.awssdk.services.eks.model.DescribeAddonVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.DescribeAddonVersionsIterable responses = client.describeAddonVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAddonVersions(software.amazon.awssdk.services.eks.model.DescribeAddonVersionsRequest)
operation.This is a convenience which creates an instance of the
DescribeAddonVersionsRequest.Builder
avoiding the need to create one manually viaDescribeAddonVersionsRequest.builder()
- Parameters:
describeAddonVersionsRequest
- AConsumer
that will call methods onDescribeAddonVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCluster
default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet
andkubectl
to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.The API server endpoint and certificate authority data aren't available until the cluster reaches the
ACTIVE
state.- Parameters:
describeClusterRequest
-- Returns:
- Result of the DescribeCluster operation returned by the service.
- See Also:
-
describeCluster
default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for
kubelet
andkubectl
to communicate with your Kubernetes API server. For more information, see 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 viaDescribeClusterRequest.builder()
- Parameters:
describeClusterRequest
- AConsumer
that will call methods onDescribeClusterRequest.Builder
to create a request.- Returns:
- Result of the DescribeCluster operation returned by the service.
- See Also:
-
describeEksAnywhereSubscription
default DescribeEksAnywhereSubscriptionResponse describeEksAnywhereSubscription(DescribeEksAnywhereSubscriptionRequest describeEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about a subscription.
- Parameters:
describeEksAnywhereSubscriptionRequest
-- Returns:
- Result of the DescribeEksAnywhereSubscription operation returned by the service.
- See Also:
-
describeEksAnywhereSubscription
default DescribeEksAnywhereSubscriptionResponse describeEksAnywhereSubscription(Consumer<DescribeEksAnywhereSubscriptionRequest.Builder> describeEksAnywhereSubscriptionRequest) throws ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about a subscription.
This is a convenience which creates an instance of the
DescribeEksAnywhereSubscriptionRequest.Builder
avoiding the need to create one manually viaDescribeEksAnywhereSubscriptionRequest.builder()
- Parameters:
describeEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onDescribeEksAnywhereSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DescribeEksAnywhereSubscription operation returned by the service.
- See Also:
-
describeFargateProfile
default DescribeFargateProfileResponse describeFargateProfile(DescribeFargateProfileRequest describeFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an Fargate profile.
- Parameters:
describeFargateProfileRequest
-- Returns:
- Result of the DescribeFargateProfile operation returned by the service.
- See Also:
-
describeFargateProfile
default DescribeFargateProfileResponse describeFargateProfile(Consumer<DescribeFargateProfileRequest.Builder> describeFargateProfileRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 viaDescribeFargateProfileRequest.builder()
- Parameters:
describeFargateProfileRequest
- AConsumer
that will call methods onDescribeFargateProfileRequest.Builder
to create a request.- Returns:
- Result of the DescribeFargateProfile operation returned by the service.
- See Also:
-
describeIdentityProviderConfig
default DescribeIdentityProviderConfigResponse describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest describeIdentityProviderConfigRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an identity provider configuration.
- Parameters:
describeIdentityProviderConfigRequest
-- Returns:
- Result of the DescribeIdentityProviderConfig operation returned by the service.
- See Also:
-
describeIdentityProviderConfig
default DescribeIdentityProviderConfigResponse describeIdentityProviderConfig(Consumer<DescribeIdentityProviderConfigRequest.Builder> describeIdentityProviderConfigRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 viaDescribeIdentityProviderConfigRequest.builder()
- Parameters:
describeIdentityProviderConfigRequest
- AConsumer
that will call methods onDescribeIdentityProviderConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeIdentityProviderConfig operation returned by the service.
- See Also:
-
describeNodegroup
default DescribeNodegroupResponse describeNodegroup(DescribeNodegroupRequest describeNodegroupRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an Amazon EKS node group.
- Parameters:
describeNodegroupRequest
-- Returns:
- Result of the DescribeNodegroup operation returned by the service.
- See Also:
-
describeNodegroup
default DescribeNodegroupResponse describeNodegroup(Consumer<DescribeNodegroupRequest.Builder> describeNodegroupRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 viaDescribeNodegroupRequest.builder()
- Parameters:
describeNodegroupRequest
- AConsumer
that will call methods onDescribeNodegroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeNodegroup operation returned by the service.
- See Also:
-
describeUpdate
default DescribeUpdateResponse describeUpdate(DescribeUpdateRequest describeUpdateRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.
When the status of the update is
Succeeded
, the update is complete. If an update fails, the status isFailed
, and an error detail explains the reason for the failure.- Parameters:
describeUpdateRequest
-- Returns:
- Result of the DescribeUpdate operation returned by the service.
- See Also:
-
describeUpdate
default DescribeUpdateResponse describeUpdate(Consumer<DescribeUpdateRequest.Builder> describeUpdateRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.
When the status of the update is
Succeeded
, the update is complete. If an update fails, the status isFailed
, and an error detail explains the reason for the failure.
This is a convenience which creates an instance of the
DescribeUpdateRequest.Builder
avoiding the need to create one manually viaDescribeUpdateRequest.builder()
- Parameters:
describeUpdateRequest
- AConsumer
that will call methods onDescribeUpdateRequest.Builder
to create a request.- Returns:
- Result of the DescribeUpdate operation returned by the service.
- See Also:
-
disassociateIdentityProviderConfig
default DisassociateIdentityProviderConfigResponse disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest disassociateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.
- Parameters:
disassociateIdentityProviderConfigRequest
-- Returns:
- Result of the DisassociateIdentityProviderConfig operation returned by the service.
- See Also:
-
disassociateIdentityProviderConfig
default DisassociateIdentityProviderConfigResponse disassociateIdentityProviderConfig(Consumer<DisassociateIdentityProviderConfigRequest.Builder> disassociateIdentityProviderConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.
This is a convenience which creates an instance of the
DisassociateIdentityProviderConfigRequest.Builder
avoiding the need to create one manually viaDisassociateIdentityProviderConfigRequest.builder()
- Parameters:
disassociateIdentityProviderConfigRequest
- AConsumer
that will call methods onDisassociateIdentityProviderConfigRequest.Builder
to create a request.- Returns:
- Result of the DisassociateIdentityProviderConfig operation returned by the service.
- See Also:
-
listAddons
default ListAddonsResponse listAddons(ListAddonsRequest listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException Lists the installed add-ons.
- Parameters:
listAddonsRequest
-- Returns:
- Result of the ListAddons operation returned by the service.
- See Also:
-
listAddons
default ListAddonsResponse listAddons(Consumer<ListAddonsRequest.Builder> listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException Lists the installed add-ons.
This is a convenience which creates an instance of the
ListAddonsRequest.Builder
avoiding the need to create one manually viaListAddonsRequest.builder()
- Parameters:
listAddonsRequest
- AConsumer
that will call methods onListAddonsRequest.Builder
to create a request.- Returns:
- Result of the ListAddons operation returned by the service.
- See Also:
-
listAddonsPaginator
default ListAddonsIterable listAddonsPaginator(ListAddonsRequest listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException Lists the installed add-ons.
This is a variant of
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAddonsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation.- Parameters:
listAddonsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAddonsPaginator
default ListAddonsIterable listAddonsPaginator(Consumer<ListAddonsRequest.Builder> listAddonsRequest) throws InvalidParameterException, InvalidRequestException, ClientException, ResourceNotFoundException, ServerException, AwsServiceException, SdkClientException, EksException Lists the installed add-ons.
This is a variant of
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListAddonsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListAddonsIterable responses = client.listAddonsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAddons(software.amazon.awssdk.services.eks.model.ListAddonsRequest)
operation.This is a convenience which creates an instance of the
ListAddonsRequest.Builder
avoiding the need to create one manually viaListAddonsRequest.builder()
- Parameters:
listAddonsRequest
- AConsumer
that will call methods onListAddonsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClusters
default ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
- Parameters:
listClustersRequest
-- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters() throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksExceptionLists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator() throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksExceptionLists 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.- Parameters:
listClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.eks.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.eks.model.ListClustersRequest)
operation.This is a convenience which creates an instance of the
ListClustersRequest.Builder
avoiding the need to create one manually viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEksAnywhereSubscriptions
default ListEksAnywhereSubscriptionsResponse listEksAnywhereSubscriptions(ListEksAnywhereSubscriptionsRequest listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Displays the full description of the subscription.
- Parameters:
listEksAnywhereSubscriptionsRequest
-- Returns:
- Result of the ListEksAnywhereSubscriptions operation returned by the service.
- See Also:
-
listEksAnywhereSubscriptions
default ListEksAnywhereSubscriptionsResponse listEksAnywhereSubscriptions(Consumer<ListEksAnywhereSubscriptionsRequest.Builder> listEksAnywhereSubscriptionsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AwsServiceException, SdkClientException, EksException Displays the full description of the subscription.
This is a convenience which creates an instance of the
ListEksAnywhereSubscriptionsRequest.Builder
avoiding the need to create one manually viaListEksAnywhereSubscriptionsRequest.builder()
- Parameters:
listEksAnywhereSubscriptionsRequest
- AConsumer
that will call methods onListEksAnywhereSubscriptionsRequest.Builder
to create a request.- Returns:
- Result of the ListEksAnywhereSubscriptions operation returned by the service.
- See Also:
-
listFargateProfiles
default ListFargateProfilesResponse listFargateProfiles(ListFargateProfilesRequest listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
- Parameters:
listFargateProfilesRequest
-- Returns:
- Result of the ListFargateProfiles operation returned by the service.
- See Also:
-
listFargateProfiles
default ListFargateProfilesResponse listFargateProfiles(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException 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 viaListFargateProfilesRequest.builder()
- Parameters:
listFargateProfilesRequest
- AConsumer
that will call methods onListFargateProfilesRequest.Builder
to create a request.- Returns:
- Result of the ListFargateProfiles operation returned by the service.
- See Also:
-
listFargateProfilesPaginator
default ListFargateProfilesIterable listFargateProfilesPaginator(ListFargateProfilesRequest listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client .listFargateProfilesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)
operation.- Parameters:
listFargateProfilesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFargateProfilesPaginator
default ListFargateProfilesIterable listFargateProfilesPaginator(Consumer<ListFargateProfilesRequest.Builder> listFargateProfilesRequest) throws InvalidParameterException, ResourceNotFoundException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client .listFargateProfilesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListFargateProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListFargateProfilesIterable responses = client.listFargateProfilesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFargateProfiles(software.amazon.awssdk.services.eks.model.ListFargateProfilesRequest)
operation.This is a convenience which creates an instance of the
ListFargateProfilesRequest.Builder
avoiding the need to create one manually viaListFargateProfilesRequest.builder()
- Parameters:
listFargateProfilesRequest
- AConsumer
that will call methods onListFargateProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentityProviderConfigs
default ListIdentityProviderConfigsResponse listIdentityProviderConfigs(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException A list of identity provider configurations.
- Parameters:
listIdentityProviderConfigsRequest
-- Returns:
- Result of the ListIdentityProviderConfigs operation returned by the service.
- See Also:
-
listIdentityProviderConfigs
default ListIdentityProviderConfigsResponse listIdentityProviderConfigs(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 viaListIdentityProviderConfigsRequest.builder()
- Parameters:
listIdentityProviderConfigsRequest
- AConsumer
that will call methods onListIdentityProviderConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListIdentityProviderConfigs operation returned by the service.
- See Also:
-
listIdentityProviderConfigsPaginator
default ListIdentityProviderConfigsIterable listIdentityProviderConfigsPaginator(ListIdentityProviderConfigsRequest listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client .listIdentityProviderConfigsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.- Parameters:
listIdentityProviderConfigsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentityProviderConfigsPaginator
default ListIdentityProviderConfigsIterable listIdentityProviderConfigsPaginator(Consumer<ListIdentityProviderConfigsRequest.Builder> listIdentityProviderConfigsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client .listIdentityProviderConfigsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListIdentityProviderConfigsIterable responses = client.listIdentityProviderConfigsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIdentityProviderConfigs(software.amazon.awssdk.services.eks.model.ListIdentityProviderConfigsRequest)
operation.This is a convenience which creates an instance of the
ListIdentityProviderConfigsRequest.Builder
avoiding the need to create one manually viaListIdentityProviderConfigsRequest.builder()
- Parameters:
listIdentityProviderConfigsRequest
- AConsumer
that will call methods onListIdentityProviderConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listNodegroups
default ListNodegroupsResponse listNodegroups(ListNodegroupsRequest listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
- Parameters:
listNodegroupsRequest
-- Returns:
- Result of the ListNodegroups operation returned by the service.
- See Also:
-
listNodegroups
default ListNodegroupsResponse listNodegroups(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 viaListNodegroupsRequest.builder()
- Parameters:
listNodegroupsRequest
- AConsumer
that will call methods onListNodegroupsRequest.Builder
to create a request.- Returns:
- Result of the ListNodegroups operation returned by the service.
- See Also:
-
listNodegroupsPaginator
default ListNodegroupsIterable listNodegroupsPaginator(ListNodegroupsRequest listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation.- Parameters:
listNodegroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listNodegroupsPaginator
default ListNodegroupsIterable listNodegroupsPaginator(Consumer<ListNodegroupsRequest.Builder> listNodegroupsRequest) throws InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); for (software.amazon.awssdk.services.eks.model.ListNodegroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListNodegroupsIterable responses = client.listNodegroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNodegroups(software.amazon.awssdk.services.eks.model.ListNodegroupsRequest)
operation.This is a convenience which creates an instance of the
ListNodegroupsRequest.Builder
avoiding the need to create one manually viaListNodegroupsRequest.builder()
- Parameters:
listNodegroupsRequest
- AConsumer
that will call methods onListNodegroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException List the tags for an Amazon EKS resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException List the tags for an Amazon EKS resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listUpdates
default ListUpdatesResponse listUpdates(ListUpdatesRequest listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
- Parameters:
listUpdatesRequest
-- Returns:
- Result of the ListUpdates operation returned by the service.
- See Also:
-
listUpdates
default ListUpdatesResponse listUpdates(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 viaListUpdatesRequest.builder()
- Parameters:
listUpdatesRequest
- AConsumer
that will call methods onListUpdatesRequest.Builder
to create a request.- Returns:
- Result of the ListUpdates operation returned by the service.
- See Also:
-
listUpdatesPaginator
default ListUpdatesIterable listUpdatesPaginator(ListUpdatesRequest listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation.- Parameters:
listUpdatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUpdatesPaginator
default ListUpdatesIterable listUpdatesPaginator(Consumer<ListUpdatesRequest.Builder> listUpdatesRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, EksException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); for (software.amazon.awssdk.services.eks.model.ListUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.eks.paginators.ListUpdatesIterable responses = client.listUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUpdates(software.amazon.awssdk.services.eks.model.ListUpdatesRequest)
operation.This is a convenience which creates an instance of the
ListUpdatesRequest.Builder
avoiding the need to create one manually viaListUpdatesRequest.builder()
- Parameters:
listUpdatesRequest
- AConsumer
that will call methods onListUpdatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
registerCluster
default RegisterClusterResponse registerCluster(RegisterClusterRequest registerClusterRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, ResourceInUseException, ResourcePropagationDelayException, AwsServiceException, SdkClientException, EksException Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a
RegisterClusterRequest
to add it to the Amazon EKS control plane.Second, a Manifest containing the
activationID
andactivationCode
must be applied to the Kubernetes cluster through it's native provider to provide visibility.After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
- Parameters:
registerClusterRequest
-- Returns:
- Result of the RegisterCluster operation returned by the service.
- See Also:
-
registerCluster
default RegisterClusterResponse registerCluster(Consumer<RegisterClusterRequest.Builder> registerClusterRequest) throws ResourceLimitExceededException, InvalidParameterException, ClientException, ServerException, ServiceUnavailableException, AccessDeniedException, ResourceInUseException, ResourcePropagationDelayException, AwsServiceException, SdkClientException, EksException Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a
RegisterClusterRequest
to add it to the Amazon EKS control plane.Second, a Manifest containing the
activationID
andactivationCode
must be applied to the Kubernetes cluster through it's native provider to provide visibility.After the Manifest is updated and applied, 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 viaRegisterClusterRequest.builder()
- Parameters:
registerClusterRequest
- AConsumer
that will call methods onRegisterClusterRequest.Builder
to create a request.- Returns:
- Result of the RegisterCluster operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and nodes associated with the cluster.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, NotFoundException, AwsServiceException, SdkClientException, EksException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAddon
default UpdateAddonResponse updateAddon(UpdateAddonRequest updateAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS add-on.
- Parameters:
updateAddonRequest
-- Returns:
- Result of the UpdateAddon operation returned by the service.
- See Also:
-
updateAddon
default UpdateAddonResponse updateAddon(Consumer<UpdateAddonRequest.Builder> updateAddonRequest) throws InvalidParameterException, InvalidRequestException, ResourceNotFoundException, ResourceInUseException, ClientException, ServerException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS add-on.
This is a convenience which creates an instance of the
UpdateAddonRequest.Builder
avoiding the need to create one manually viaUpdateAddonRequest.builder()
- Parameters:
updateAddonRequest
- AConsumer
that will call methods onUpdateAddonRequest.Builder
to create a request.- Returns:
- Result of the UpdateAddon operation returned by the service.
- See Also:
-
updateClusterConfig
default UpdateClusterConfigResponse updateClusterConfig(UpdateClusterConfigRequest updateClusterConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException 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 (eitherFailed
orSuccessful
), the cluster status moves toActive
.- Parameters:
updateClusterConfigRequest
-- Returns:
- Result of the UpdateClusterConfig operation returned by the service.
- See Also:
-
updateClusterConfig
default UpdateClusterConfigResponse updateClusterConfig(Consumer<UpdateClusterConfigRequest.Builder> updateClusterConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException 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 (eitherFailed
orSuccessful
), the cluster status moves toActive
.
This is a convenience which creates an instance of the
UpdateClusterConfigRequest.Builder
avoiding the need to create one manually viaUpdateClusterConfigRequest.builder()
- Parameters:
updateClusterConfigRequest
- AConsumer
that will call methods onUpdateClusterConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateClusterConfig operation returned by the service.
- See Also:
-
updateClusterVersion
default UpdateClusterVersionResponse updateClusterVersion(UpdateClusterVersionRequest updateClusterVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to
UPDATING
(this status transition is eventually consistent). When the update is complete (eitherFailed
orSuccessful
), the cluster status moves toActive
.If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
- Parameters:
updateClusterVersionRequest
-- Returns:
- Result of the UpdateClusterVersion operation returned by the service.
- See Also:
-
updateClusterVersion
default UpdateClusterVersionResponse updateClusterVersion(Consumer<UpdateClusterVersionRequest.Builder> updateClusterVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to
UPDATING
(this status transition is eventually consistent). When the update is complete (eitherFailed
orSuccessful
), the cluster status moves toActive
.If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
This is a convenience which creates an instance of the
UpdateClusterVersionRequest.Builder
avoiding the need to create one manually viaUpdateClusterVersionRequest.builder()
- Parameters:
updateClusterVersionRequest
- AConsumer
that will call methods onUpdateClusterVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateClusterVersion operation returned by the service.
- See Also:
-
updateEksAnywhereSubscription
default UpdateEksAnywhereSubscriptionResponse updateEksAnywhereSubscription(UpdateEksAnywhereSubscriptionRequest updateEksAnywhereSubscriptionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
- Parameters:
updateEksAnywhereSubscriptionRequest
-- Returns:
- Result of the UpdateEksAnywhereSubscription operation returned by the service.
- See Also:
-
updateEksAnywhereSubscription
default UpdateEksAnywhereSubscriptionResponse updateEksAnywhereSubscription(Consumer<UpdateEksAnywhereSubscriptionRequest.Builder> updateEksAnywhereSubscriptionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
This is a convenience which creates an instance of the
UpdateEksAnywhereSubscriptionRequest.Builder
avoiding the need to create one manually viaUpdateEksAnywhereSubscriptionRequest.builder()
- Parameters:
updateEksAnywhereSubscriptionRequest
- AConsumer
that will call methods onUpdateEksAnywhereSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the UpdateEksAnywhereSubscription operation returned by the service.
- See Also:
-
updateNodegroupConfig
default UpdateNodegroupConfigResponse updateNodegroupConfig(UpdateNodegroupConfigRequest updateNodegroupConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
- Parameters:
updateNodegroupConfigRequest
-- Returns:
- Result of the UpdateNodegroupConfig operation returned by the service.
- See Also:
-
updateNodegroupConfig
default UpdateNodegroupConfigResponse updateNodegroupConfig(Consumer<UpdateNodegroupConfigRequest.Builder> updateNodegroupConfigRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
This is a convenience which creates an instance of the
UpdateNodegroupConfigRequest.Builder
avoiding the need to create one manually viaUpdateNodegroupConfigRequest.builder()
- Parameters:
updateNodegroupConfigRequest
- AConsumer
that will call methods onUpdateNodegroupConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateNodegroupConfig operation returned by the service.
- See Also:
-
updateNodegroupVersion
default UpdateNodegroupVersionResponse updateNodegroupVersion(UpdateNodegroupVersionRequest updateNodegroupVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force
the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.- Parameters:
updateNodegroupVersionRequest
-- Returns:
- Result of the UpdateNodegroupVersion operation returned by the service.
- See Also:
-
updateNodegroupVersion
default UpdateNodegroupVersionResponse updateNodegroupVersion(Consumer<UpdateNodegroupVersionRequest.Builder> updateNodegroupVersionRequest) throws InvalidParameterException, ClientException, ServerException, ResourceInUseException, ResourceNotFoundException, InvalidRequestException, AwsServiceException, SdkClientException, EksException Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can
force
the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.
This is a convenience which creates an instance of the
UpdateNodegroupVersionRequest.Builder
avoiding the need to create one manually viaUpdateNodegroupVersionRequest.builder()
- Parameters:
updateNodegroupVersionRequest
- AConsumer
that will call methods onUpdateNodegroupVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateNodegroupVersion operation returned by the service.
- See Also:
-
waiter
Create an instance ofEksWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
EksWaiter
-
create
Create aEksClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEksClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-