Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . eks ]

delete-cluster

Description

Deletes the Amazon EKS cluster control plane.

Note

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-cluster
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the cluster to delete.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To delete a cluster

This example command deletes a cluster named devel in your default region.

Command:

aws eks delete-cluster --name devel

Output

cluster -> (structure)

The full description of the cluster to delete.

name -> (string)

The name of the cluster.

arn -> (string)

The Amazon Resource Name (ARN) of the cluster.

createdAt -> (timestamp)

The Unix epoch time stamp in seconds for when the cluster was created.

version -> (string)

The Kubernetes server version for the cluster.

endpoint -> (string)

The endpoint for your Kubernetes API server.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

resourcesVpcConfig -> (structure)

The VPC subnets and security groups used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide .

subnetIds -> (list)

The subnets associated with your cluster.

(string)

securityGroupIds -> (list)

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

(string)

vpcId -> (string)

The VPC associated with your cluster.

status -> (string)

The current status of the cluster.

certificateAuthority -> (structure)

The certificate-authority-data for your cluster.

data -> (string)

The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

clientRequestToken -> (string)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.