Skip to content

Commit f92e1d6

Browse files
author
awstools
committed
docs(client-eks): Update delete cluster description
1 parent 78cd18f commit f92e1d6

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

clients/client-eks/src/commands/CreateClusterCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
3333
* account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint.
3434
* Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of
3535
* Amazon EC2 instances.</p>
36-
* <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an ELB
36+
* <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing
3737
* Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide
3838
* connectivity from the control plane instances to the nodes (for example, to support
3939
* <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data

clients/client-eks/src/commands/DeleteClusterCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
2828

2929
/**
3030
* <p>Deletes an Amazon EKS cluster control plane.</p>
31-
* <p>If you have active services in your cluster that are associated with a load balancer,
31+
* <p>If you have active services and ingress resources in your cluster that are associated with a load balancer,
3232
* you must delete those services before deleting the cluster so that the load balancers
3333
* are deleted properly. Otherwise, you can have orphaned resources in your VPC that
3434
* prevent you from being able to delete the VPC. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html">Deleting a

codegen/sdk-codegen/aws-models/eks.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4171,7 +4171,7 @@
41714171
}
41724172
],
41734173
"traits": {
4174-
"smithy.api#documentation": "<p>Creates an Amazon EKS control plane.</p>\n <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as <code>etcd</code> and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint.\n Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of\n Amazon EC2 instances.</p>\n <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an ELB\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide\n connectivity from the control plane instances to the nodes (for example, to support\n <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data\n flows).</p>\n <p>Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.</p>\n <p>You can use the <code>endpointPublicAccess</code> and\n <code>endpointPrivateAccess</code> parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. The\n endpoint domain name and IP address family depends on the value of the\n <code>ipFamily</code> for the cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster\n Endpoint Access Control</a> in the <i>\n <i>Amazon EKS User Guide</i>\n </i>. </p>\n <p>You can use the <code>logging</code> parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS\n Cluster Control Plane Logs</a> in the\n <i>\n <i>Amazon EKS User Guide</i>\n </i>.</p>\n <note>\n <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p>\n </note>\n <p>In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS\n cluster, you must configure your Kubernetes tooling to communicate with the API server and\n launch nodes into your cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html\">Allowing users to\n access your cluster</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html\">Launching Amazon EKS\n nodes</a> in the <i>Amazon EKS User Guide</i>.</p>",
4174+
"smithy.api#documentation": "<p>Creates an Amazon EKS control plane.</p>\n <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as <code>etcd</code> and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint.\n Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of\n Amazon EC2 instances.</p>\n <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide\n connectivity from the control plane instances to the nodes (for example, to support\n <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data\n flows).</p>\n <p>Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.</p>\n <p>You can use the <code>endpointPublicAccess</code> and\n <code>endpointPrivateAccess</code> parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. The\n endpoint domain name and IP address family depends on the value of the\n <code>ipFamily</code> for the cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster\n Endpoint Access Control</a> in the <i>\n <i>Amazon EKS User Guide</i>\n </i>. </p>\n <p>You can use the <code>logging</code> parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS\n Cluster Control Plane Logs</a> in the\n <i>\n <i>Amazon EKS User Guide</i>\n </i>.</p>\n <note>\n <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p>\n </note>\n <p>In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS\n cluster, you must configure your Kubernetes tooling to communicate with the API server and\n launch nodes into your cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html\">Allowing users to\n access your cluster</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html\">Launching Amazon EKS\n nodes</a> in the <i>Amazon EKS User Guide</i>.</p>",
41754175
"smithy.api#examples": [
41764176
{
41774177
"title": "To create a new cluster",
@@ -5077,7 +5077,7 @@
50775077
}
50785078
],
50795079
"traits": {
5080-
"smithy.api#documentation": "<p>Deletes an Amazon EKS cluster control plane.</p>\n <p>If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html\">Deleting a\n cluster</a> in the <i>Amazon EKS User Guide</i>.</p>\n <p>If you have managed node groups or Fargate profiles attached to the cluster, you\n must delete them first. For more information, see <code>DeleteNodgroup</code> and\n <code>DeleteFargateProfile</code>.</p>",
5080+
"smithy.api#documentation": "<p>Deletes an Amazon EKS cluster control plane.</p>\n <p>If you have active services and ingress resources in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html\">Deleting a\n cluster</a> in the <i>Amazon EKS User Guide</i>.</p>\n <p>If you have managed node groups or Fargate profiles attached to the cluster, you\n must delete them first. For more information, see <code>DeleteNodgroup</code> and\n <code>DeleteFargateProfile</code>.</p>",
50815081
"smithy.api#examples": [
50825082
{
50835083
"title": "To delete a cluster",

0 commit comments

Comments
 (0)