aws eks64 CLI commands available for Amazon EKS.
| Command | API Operation | Sample |
|---|---|---|
associate-access-policyAssociates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide. | AssociateAccessPolicy | |
associate-encryption-configAssociates an encryption configuration to an existing cluster. Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters. | AssociateEncryptionConfig | |
associate-identity-provider-configAssociates an identity provider configuration to a cluster. If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes Role and Clust | AssociateIdentityProviderConfig | |
create-access-entryCreates an access entry. An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth ConfigMap for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: | CreateAccessEntry | |
create-addonCreates 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. | CreateAddon | |
create-capabilityCreates a managed capability resource for an Amazon EKS cluster. Capabilities provide fully managed capabilities to build and scale with Kubernetes. When you create a capability, Amazon EKSprovisions and manages the infrastructure required to run the capability outside of your cluster. This approach | CreateCapability | |
create-clusterCreates 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 | CreateCluster | |
create-eks-anywhere-subscriptionCreates 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 Anyw | CreateEksAnywhereSubscription | |
create-fargate-profileCreates 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 | CreateFargateProfile | |
create-nodegroupCreates 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, unles | CreateNodegroup | |
create-pod-identity-associationCreates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to Pods and the credentials are rotated automatically. Amazon EKS Pod Identity associations provide the ability to | CreatePodIdentityAssociation | |
delete-access-entryDeletes an access entry. Deleting an access entry of a type other than Standard can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it. | DeleteAccessEntry | |
delete-addonDeletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API. | DeleteAddon | |
delete-capabilityDeletes a managed capability from your Amazon EKS cluster. When you delete a capability, Amazon EKS removes the capability infrastructure but retains all resources that were managed by the capability. Before deleting a capability, you should delete all Kubernetes resources that were created by the c | DeleteCapability | |
delete-clusterDeletes an Amazon EKS cluster control plane. If you have active services and ingress resources 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 resour | DeleteCluster | |
delete-eks-anywhere-subscriptionDeletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web | DeleteEksAnywhereSubscription | |
delete-fargate-profileDeletes an Fargate profile. When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled | DeleteFargateProfile | |
delete-nodegroupDeletes a managed node group. | DeleteNodegroup | |
delete-pod-identity-associationDeletes a EKS Pod Identity association. The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console. | DeletePodIdentityAssociation | |
deregister-clusterDeregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector. | DeregisterCluster | |
describe-access-entryDescribes an access entry. | DescribeAccessEntry | |
describe-addonDescribes an Amazon EKS add-on. | DescribeAddon | |
describe-addon-configurationReturns configuration options. | DescribeAddonConfiguration | |
describe-addon-versionsDescribes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned. | DescribeAddonVersions | |
describe-capabilityReturns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation. | DescribeCapability | |
describe-clusterDescribes 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 Creating or updating a kubeconfig file for an Amazon EKS cluster. The API | DescribeCluster | |
describe-cluster-versionsLists available Kubernetes versions for Amazon EKS clusters. | DescribeClusterVersions | |
describe-eks-anywhere-subscriptionReturns descriptive information about a subscription. | DescribeEksAnywhereSubscription | |
describe-fargate-profileDescribes an Fargate profile. | DescribeFargateProfile | |
describe-identity-provider-configDescribes an identity provider configuration. | DescribeIdentityProviderConfig | |
describe-insightReturns details about an insight that you specify using its ID. | DescribeInsight | |
describe-insights-refreshReturns the status of the latest on-demand cluster insights refresh operation. | DescribeInsightsRefresh | |
describe-nodegroupDescribes a managed node group. | DescribeNodegroup | |
describe-pod-identity-associationReturns descriptive information about an EKS Pod Identity association. This action requires the ID of the association. You can get the ID from the response to the CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for associations with ListPodIdentityAssociations an | DescribePodIdentityAssociation | |
describe-updateDescribes an update to an Amazon EKS resource. When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure. | DescribeUpdate | |
disassociate-access-policyDisassociates an access policy from an access entry. | DisassociateAccessPolicy | |
disassociate-identity-provider-configDisassociates 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. | DisassociateIdentityProviderConfig | |
list-access-entriesLists the access entries for your cluster. | ListAccessEntries | |
list-access-policiesLists the available access policies. | ListAccessPolicies | |
list-addonsLists the installed add-ons. | ListAddons | |
list-associated-access-policiesLists the access policies associated with an access entry. | ListAssociatedAccessPolicies | |
list-capabilitiesLists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status. | ListCapabilities | |
list-clustersLists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region. | ListClusters | |
list-eks-anywhere-subscriptionsDisplays the full description of the subscription. | ListEksAnywhereSubscriptions | |
list-fargate-profilesLists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. | ListFargateProfiles | |
list-identity-provider-configsLists the identity provider configurations for your cluster. | ListIdentityProviderConfigs | |
list-insightsReturns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: UPGRADE_READINESS: A | ListInsights | |
list-nodegroupsLists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed. | ListNodegroups | |
list-pod-identity-associationsList the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses. | ListPodIdentityAssociations | |
list-tags-for-resourceList the tags for an Amazon EKS resource. | ListTagsForResource | |
list-updatesLists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region. | ListUpdates | |
register-clusterConnects 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 | RegisterCluster | |
start-insights-refreshInitiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule. | StartInsightsRefresh | |
tag-resourceAssociates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazo | TagResource | |
untag-resourceDeletes specified tags from an Amazon EKS resource. | UntagResource | |
update-access-entryUpdates an access entry. | UpdateAccessEntry | |
update-addonUpdates an Amazon EKS add-on. | UpdateAddon | |
update-capabilityUpdates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation policy for a capability. When you update a capability, Amazon EKS applies the changes and may restart capability components as needed. The capabil | UpdateCapability | |
update-cluster-configUpdates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate. You can use this operation to do the following actions: You can use this API | UpdateClusterConfig | |
update-cluster-versionUpdates 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, an | UpdateClusterVersion | |
update-eks-anywhere-subscriptionUpdate an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation. | UpdateEksAnywhereSubscription | |
update-nodegroup-configUpdates 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. You can update the Kubernetes labels and | UpdateNodegroupConfig | |
update-nodegroup-versionUpdates 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. Additionally, the launch template ID or name must match what was used when the node group was | UpdateNodegroupVersion | |
update-pod-identity-associationUpdates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or ser | UpdatePodIdentityAssociation |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterEKS