com.amazonaws.services.eks

Class AmazonEKSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.eks.AmazonEKSClient

All Implemented Interfaces:

AmazonEKS

Direct Known Subclasses:

AmazonEKSAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEKSClient
extends AmazonWebServiceClient
implements AmazonEKS

Client for accessing Amazon EKS. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to 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

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.eks.AmazonEKS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateEncryptionConfigResult	associateEncryptionConfig(AssociateEncryptionConfigRequest request) Associate encryption configuration to an existing cluster.
AssociateIdentityProviderConfigResult	associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest request) Associate an identity provider configuration to a cluster.
static AmazonEKSClientBuilder	builder()
CreateAddonResult	createAddon(CreateAddonRequest request) Creates an Amazon EKS add-on.
CreateClusterResult	createCluster(CreateClusterRequest request) Creates an Amazon EKS control plane.
CreateFargateProfileResult	createFargateProfile(CreateFargateProfileRequest request) Creates an Fargate profile for your Amazon EKS cluster.
CreateNodegroupResult	createNodegroup(CreateNodegroupRequest request) Creates a managed node group for an Amazon EKS cluster.
DeleteAddonResult	deleteAddon(DeleteAddonRequest request) Delete an Amazon EKS add-on.
DeleteClusterResult	deleteCluster(DeleteClusterRequest request) Deletes the Amazon EKS cluster control plane.
DeleteFargateProfileResult	deleteFargateProfile(DeleteFargateProfileRequest request) Deletes an Fargate profile.
DeleteNodegroupResult	deleteNodegroup(DeleteNodegroupRequest request) Deletes an Amazon EKS node group for a cluster.
DescribeAddonResult	describeAddon(DescribeAddonRequest request) Describes an Amazon EKS add-on.
DescribeAddonVersionsResult	describeAddonVersions(DescribeAddonVersionsRequest request) Describes the Kubernetes versions that the add-on can be used with.
DescribeClusterResult	describeCluster(DescribeClusterRequest request) Returns descriptive information about an Amazon EKS cluster.
DescribeFargateProfileResult	describeFargateProfile(DescribeFargateProfileRequest request) Returns descriptive information about an Fargate profile.
DescribeIdentityProviderConfigResult	describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest request) Returns descriptive information about an identity provider configuration.
DescribeNodegroupResult	describeNodegroup(DescribeNodegroupRequest request) Returns descriptive information about an Amazon EKS node group.
DescribeUpdateResult	describeUpdate(DescribeUpdateRequest request) Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
DisassociateIdentityProviderConfigResult	disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest request) Disassociates an identity provider configuration from a cluster.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListAddonsResult	listAddons(ListAddonsRequest request) Lists the available add-ons.
ListClustersResult	listClusters(ListClustersRequest request) Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
ListFargateProfilesResult	listFargateProfiles(ListFargateProfilesRequest request) Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
ListIdentityProviderConfigsResult	listIdentityProviderConfigs(ListIdentityProviderConfigsRequest request) A list of identity provider configurations.
ListNodegroupsResult	listNodegroups(ListNodegroupsRequest request) Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List the tags for an Amazon EKS resource.
ListUpdatesResult	listUpdates(ListUpdatesRequest request) Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Associates the specified tags to a resource with the specified resourceArn.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes specified tags from a resource.
UpdateAddonResult	updateAddon(UpdateAddonRequest request) Updates an Amazon EKS add-on.
UpdateClusterConfigResult	updateClusterConfig(UpdateClusterConfigRequest request) Updates an Amazon EKS cluster configuration.
UpdateClusterVersionResult	updateClusterVersion(UpdateClusterVersionRequest request) Updates an Amazon EKS cluster to the specified Kubernetes version.
UpdateNodegroupConfigResult	updateNodegroupConfig(UpdateNodegroupConfigRequest request) Updates an Amazon EKS managed node group configuration.
UpdateNodegroupVersionResult	updateNodegroupVersion(UpdateNodegroupVersionRequest request) Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
AmazonEKSWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonEKSClientBuilder builder()

associateEncryptionConfig

public AssociateEncryptionConfigResult associateEncryptionConfig(AssociateEncryptionConfigRequest request)

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.

Specified by:

associateEncryptionConfig in interface AmazonEKS

Parameters:

associateEncryptionConfigRequest -

Returns:

Result of the AssociateEncryptionConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

associateIdentityProviderConfig

public AssociateIdentityProviderConfigResult associateIdentityProviderConfig(AssociateIdentityProviderConfigRequest request)

Associate an identity provider configuration to a cluster.

If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings. For more information see Using RBAC Authorization in the Kubernetes documentation.

Specified by:

associateIdentityProviderConfig in interface AmazonEKS

Parameters:

associateIdentityProviderConfigRequest -

Returns:

Result of the AssociateIdentityProviderConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

createAddon

public CreateAddonResult createAddon(CreateAddonRequest request)

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with platform version eks.3 or later because add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later.

Specified by:

createAddon in interface AmazonEKS

Parameters:

createAddonRequest -

Returns:

Result of the CreateAddon operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ResourceInUseException - The specified resource is in use.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

createCluster

public CreateClusterResult createCluster(CreateClusterRequest request)

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 via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

Cluster creation typically takes several minutes. 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.

Specified by:

createCluster in interface AmazonEKS

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceLimitExceededException - You have encountered a service limit on the specified resource.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

UnsupportedAvailabilityZoneException - At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

See Also:

AWS API Documentation

createFargateProfile

public CreateFargateProfileResult createFargateProfile(CreateFargateProfileRequest request)

Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.

For more information, see Fargate Profile in the Amazon EKS User Guide.

Specified by:

createFargateProfile in interface AmazonEKS

Parameters:

createFargateProfileRequest -

Returns:

Result of the CreateFargateProfile operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceLimitExceededException - You have encountered a service limit on the specified resource.

UnsupportedAvailabilityZoneException - At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

See Also:

AWS API Documentation

createNodegroup

public CreateNodegroupResult createNodegroup(CreateNodegroupRequest request)

Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.

Specified by:

createNodegroup in interface AmazonEKS

Parameters:

createNodegroupRequest -

Returns:

Result of the CreateNodegroup operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceLimitExceededException - You have encountered a service limit on the specified resource.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

deleteAddon

public DeleteAddonResult deleteAddon(DeleteAddonRequest request)

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.

Specified by:

deleteAddon in interface AmazonEKS

Parameters:

deleteAddonRequest -

Returns:

Result of the DeleteAddon operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

deleteCluster

public DeleteClusterResult deleteCluster(DeleteClusterRequest request)

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.

Specified by:

deleteCluster in interface AmazonEKS

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

deleteFargateProfile

public DeleteFargateProfileResult deleteFargateProfile(DeleteFargateProfileRequest request)

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.

Specified by:

deleteFargateProfile in interface AmazonEKS

Parameters:

deleteFargateProfileRequest -

Returns:

Result of the DeleteFargateProfile operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

deleteNodegroup

public DeleteNodegroupResult deleteNodegroup(DeleteNodegroupRequest request)

Deletes an Amazon EKS node group for a cluster.

Specified by:

deleteNodegroup in interface AmazonEKS

Parameters:

deleteNodegroupRequest -

Returns:

Result of the DeleteNodegroup operation returned by the service.

Throws:

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

describeAddon

public DescribeAddonResult describeAddon(DescribeAddonRequest request)

Describes an Amazon EKS add-on.

Specified by:

describeAddon in interface AmazonEKS

Parameters:

describeAddonRequest -

Returns:

Result of the DescribeAddon operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

describeAddonVersions

public DescribeAddonVersionsResult describeAddonVersions(DescribeAddonVersionsRequest request)

Describes the Kubernetes versions that the add-on can be used with.

Specified by:

describeAddonVersions in interface AmazonEKS

Parameters:

describeAddonVersionsRequest -

Returns:

Result of the DescribeAddonVersions operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

See Also:

AWS API Documentation

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterRequest request)

Returns descriptive information about an Amazon EKS cluster.

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

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

Specified by:

describeCluster in interface AmazonEKS

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

describeFargateProfile

public DescribeFargateProfileResult describeFargateProfile(DescribeFargateProfileRequest request)

Returns descriptive information about an Fargate profile.

Specified by:

describeFargateProfile in interface AmazonEKS

Parameters:

describeFargateProfileRequest -

Returns:

Result of the DescribeFargateProfile operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

describeIdentityProviderConfig

public DescribeIdentityProviderConfigResult describeIdentityProviderConfig(DescribeIdentityProviderConfigRequest request)

Returns descriptive information about an identity provider configuration.

Specified by:

describeIdentityProviderConfig in interface AmazonEKS

Parameters:

describeIdentityProviderConfigRequest -

Returns:

Result of the DescribeIdentityProviderConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

describeNodegroup

public DescribeNodegroupResult describeNodegroup(DescribeNodegroupRequest request)

Returns descriptive information about an Amazon EKS node group.

Specified by:

describeNodegroup in interface AmazonEKS

Parameters:

describeNodegroupRequest -

Returns:

Result of the DescribeNodegroup operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

describeUpdate

public DescribeUpdateResult describeUpdate(DescribeUpdateRequest request)

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

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

Specified by:

describeUpdate in interface AmazonEKS

Parameters:

describeUpdateRequest -

Returns:

Result of the DescribeUpdate operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

disassociateIdentityProviderConfig

public DisassociateIdentityProviderConfigResult disassociateIdentityProviderConfig(DisassociateIdentityProviderConfigRequest request)

Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with Amazon Web Services IAM users.

Specified by:

disassociateIdentityProviderConfig in interface AmazonEKS

Parameters:

disassociateIdentityProviderConfigRequest -

Returns:

Result of the DisassociateIdentityProviderConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

listAddons

public ListAddonsResult listAddons(ListAddonsRequest request)

Lists the available add-ons.

Specified by:

listAddons in interface AmazonEKS

Parameters:

listAddonsRequest -

Returns:

Result of the ListAddons operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

listClusters

public ListClustersResult listClusters(ListClustersRequest request)

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

Specified by:

listClusters in interface AmazonEKS

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

See Also:

AWS API Documentation

listFargateProfiles

public ListFargateProfilesResult listFargateProfiles(ListFargateProfilesRequest request)

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

Specified by:

listFargateProfiles in interface AmazonEKS

Parameters:

listFargateProfilesRequest -

Returns:

Result of the ListFargateProfiles operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

listIdentityProviderConfigs

public ListIdentityProviderConfigsResult listIdentityProviderConfigs(ListIdentityProviderConfigsRequest request)

A list of identity provider configurations.

Specified by:

listIdentityProviderConfigs in interface AmazonEKS

Parameters:

listIdentityProviderConfigsRequest -

Returns:

Result of the ListIdentityProviderConfigs operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

listNodegroups

public ListNodegroupsResult listNodegroups(ListNodegroupsRequest request)

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.

Specified by:

listNodegroups in interface AmazonEKS

Parameters:

listNodegroupsRequest -

Returns:

Result of the ListNodegroups operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ServiceUnavailableException - The service is unavailable. Back off and retry the operation.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List the tags for an Amazon EKS resource.

Specified by:

listTagsForResource in interface AmazonEKS

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException - A service resource associated with the request could not be found. Clients should not retry such requests.

See Also:

AWS API Documentation

listUpdates

public ListUpdatesResult listUpdates(ListUpdatesRequest request)

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

Specified by:

listUpdates in interface AmazonEKS

Parameters:

listUpdatesRequest -

Returns:

Result of the ListUpdates operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonEKS

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException - A service resource associated with the request could not be found. Clients should not retry such requests.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes specified tags from a resource.

Specified by:

untagResource in interface AmazonEKS

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

NotFoundException - A service resource associated with the request could not be found. Clients should not retry such requests.

See Also:

AWS API Documentation

updateAddon

public UpdateAddonResult updateAddon(UpdateAddonRequest request)

Updates an Amazon EKS add-on.

Specified by:

updateAddon in interface AmazonEKS

Parameters:

updateAddonRequest -

Returns:

Result of the UpdateAddon operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

ResourceInUseException - The specified resource is in use.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

updateClusterConfig

public UpdateClusterConfigResult updateClusterConfig(UpdateClusterConfigRequest request)

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

You can't update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active .

Specified by:

updateClusterConfig in interface AmazonEKS

Parameters:

updateClusterConfigRequest -

Returns:

Result of the UpdateClusterConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

updateClusterVersion

public UpdateClusterVersionResult updateClusterVersion(UpdateClusterVersionRequest request)

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active .

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

Specified by:

updateClusterVersion in interface AmazonEKS

Parameters:

updateClusterVersionRequest -

Returns:

Result of the UpdateClusterVersion operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

updateNodegroupConfig

public UpdateNodegroupConfigResult updateNodegroupConfig(UpdateNodegroupConfigRequest request)

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.

Specified by:

updateNodegroupConfig in interface AmazonEKS

Parameters:

updateNodegroupConfigRequest -

Returns:

Result of the UpdateNodegroupConfig operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

updateNodegroupVersion

public UpdateNodegroupVersionResult updateNodegroupVersion(UpdateNodegroupVersionRequest request)

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.

If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.

Specified by:

updateNodegroupVersion in interface AmazonEKS

Parameters:

updateNodegroupVersionRequest -

Returns:

Result of the UpdateNodegroupVersion operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClientException - These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

ServerException - These errors are usually caused by a server-side issue.

ResourceInUseException - The specified resource is in use.

ResourceNotFoundException - The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

InvalidRequestException - The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonEKS

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AmazonEKSWaiters waiters()

Specified by:

waiters in interface AmazonEKS

shutdown

public void shutdown()

Description copied from interface: AmazonEKS

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonEKS

Overrides:

shutdown in class AmazonWebServiceClient