UNPKG

78.9 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class EKS extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: EKS.Types.ClientConfiguration)
14 config: Config & EKS.Types.ClientConfiguration;
15 /**
16 * 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 AWS, 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 worker nodes (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS worker nodes run in your AWS 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. You can use the endpointPublicAccess and endpointPrivateAccess parameters 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 use the logging parameter 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 Amazon CloudWatch Pricing. Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.
17 */
18 createCluster(params: EKS.Types.CreateClusterRequest, callback?: (err: AWSError, data: EKS.Types.CreateClusterResponse) => void): Request<EKS.Types.CreateClusterResponse, AWSError>;
19 /**
20 * 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 AWS, 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 worker nodes (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS worker nodes run in your AWS 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. You can use the endpointPublicAccess and endpointPrivateAccess parameters 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 use the logging parameter 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 Amazon CloudWatch Pricing. Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.
21 */
22 createCluster(callback?: (err: AWSError, data: EKS.Types.CreateClusterResponse) => void): Request<EKS.Types.CreateClusterResponse, AWSError>;
23 /**
24 * Creates an AWS 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 AWS Fargate Profile in the Amazon EKS User Guide.
25 */
26 createFargateProfile(params: EKS.Types.CreateFargateProfileRequest, callback?: (err: AWSError, data: EKS.Types.CreateFargateProfileResponse) => void): Request<EKS.Types.CreateFargateProfileResponse, AWSError>;
27 /**
28 * Creates an AWS 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 AWS Fargate Profile in the Amazon EKS User Guide.
29 */
30 createFargateProfile(callback?: (err: AWSError, data: EKS.Types.CreateFargateProfileResponse) => void): Request<EKS.Types.CreateFargateProfileResponse, AWSError>;
31 /**
32 * Creates a managed worker 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. An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS 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.
33 */
34 createNodegroup(params: EKS.Types.CreateNodegroupRequest, callback?: (err: AWSError, data: EKS.Types.CreateNodegroupResponse) => void): Request<EKS.Types.CreateNodegroupResponse, AWSError>;
35 /**
36 * Creates a managed worker 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. An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS 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.
37 */
38 createNodegroup(callback?: (err: AWSError, data: EKS.Types.CreateNodegroupResponse) => void): Request<EKS.Types.CreateNodegroupResponse, AWSError>;
39 /**
40 * 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.
41 */
42 deleteCluster(params: EKS.Types.DeleteClusterRequest, callback?: (err: AWSError, data: EKS.Types.DeleteClusterResponse) => void): Request<EKS.Types.DeleteClusterResponse, AWSError>;
43 /**
44 * 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.
45 */
46 deleteCluster(callback?: (err: AWSError, data: EKS.Types.DeleteClusterResponse) => void): Request<EKS.Types.DeleteClusterResponse, AWSError>;
47 /**
48 * Deletes an AWS 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.
49 */
50 deleteFargateProfile(params: EKS.Types.DeleteFargateProfileRequest, callback?: (err: AWSError, data: EKS.Types.DeleteFargateProfileResponse) => void): Request<EKS.Types.DeleteFargateProfileResponse, AWSError>;
51 /**
52 * Deletes an AWS 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.
53 */
54 deleteFargateProfile(callback?: (err: AWSError, data: EKS.Types.DeleteFargateProfileResponse) => void): Request<EKS.Types.DeleteFargateProfileResponse, AWSError>;
55 /**
56 * Deletes an Amazon EKS node group for a cluster.
57 */
58 deleteNodegroup(params: EKS.Types.DeleteNodegroupRequest, callback?: (err: AWSError, data: EKS.Types.DeleteNodegroupResponse) => void): Request<EKS.Types.DeleteNodegroupResponse, AWSError>;
59 /**
60 * Deletes an Amazon EKS node group for a cluster.
61 */
62 deleteNodegroup(callback?: (err: AWSError, data: EKS.Types.DeleteNodegroupResponse) => void): Request<EKS.Types.DeleteNodegroupResponse, AWSError>;
63 /**
64 * 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.
65 */
66 describeCluster(params: EKS.Types.DescribeClusterRequest, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
67 /**
68 * 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.
69 */
70 describeCluster(callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
71 /**
72 * Returns descriptive information about an AWS Fargate profile.
73 */
74 describeFargateProfile(params: EKS.Types.DescribeFargateProfileRequest, callback?: (err: AWSError, data: EKS.Types.DescribeFargateProfileResponse) => void): Request<EKS.Types.DescribeFargateProfileResponse, AWSError>;
75 /**
76 * Returns descriptive information about an AWS Fargate profile.
77 */
78 describeFargateProfile(callback?: (err: AWSError, data: EKS.Types.DescribeFargateProfileResponse) => void): Request<EKS.Types.DescribeFargateProfileResponse, AWSError>;
79 /**
80 * Returns descriptive information about an Amazon EKS node group.
81 */
82 describeNodegroup(params: EKS.Types.DescribeNodegroupRequest, callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
83 /**
84 * Returns descriptive information about an Amazon EKS node group.
85 */
86 describeNodegroup(callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
87 /**
88 * 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.
89 */
90 describeUpdate(params: EKS.Types.DescribeUpdateRequest, callback?: (err: AWSError, data: EKS.Types.DescribeUpdateResponse) => void): Request<EKS.Types.DescribeUpdateResponse, AWSError>;
91 /**
92 * 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.
93 */
94 describeUpdate(callback?: (err: AWSError, data: EKS.Types.DescribeUpdateResponse) => void): Request<EKS.Types.DescribeUpdateResponse, AWSError>;
95 /**
96 * Lists the Amazon EKS clusters in your AWS account in the specified Region.
97 */
98 listClusters(params: EKS.Types.ListClustersRequest, callback?: (err: AWSError, data: EKS.Types.ListClustersResponse) => void): Request<EKS.Types.ListClustersResponse, AWSError>;
99 /**
100 * Lists the Amazon EKS clusters in your AWS account in the specified Region.
101 */
102 listClusters(callback?: (err: AWSError, data: EKS.Types.ListClustersResponse) => void): Request<EKS.Types.ListClustersResponse, AWSError>;
103 /**
104 * Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
105 */
106 listFargateProfiles(params: EKS.Types.ListFargateProfilesRequest, callback?: (err: AWSError, data: EKS.Types.ListFargateProfilesResponse) => void): Request<EKS.Types.ListFargateProfilesResponse, AWSError>;
107 /**
108 * Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
109 */
110 listFargateProfiles(callback?: (err: AWSError, data: EKS.Types.ListFargateProfilesResponse) => void): Request<EKS.Types.ListFargateProfilesResponse, AWSError>;
111 /**
112 * Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
113 */
114 listNodegroups(params: EKS.Types.ListNodegroupsRequest, callback?: (err: AWSError, data: EKS.Types.ListNodegroupsResponse) => void): Request<EKS.Types.ListNodegroupsResponse, AWSError>;
115 /**
116 * Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
117 */
118 listNodegroups(callback?: (err: AWSError, data: EKS.Types.ListNodegroupsResponse) => void): Request<EKS.Types.ListNodegroupsResponse, AWSError>;
119 /**
120 * List the tags for an Amazon EKS resource.
121 */
122 listTagsForResource(params: EKS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: EKS.Types.ListTagsForResourceResponse) => void): Request<EKS.Types.ListTagsForResourceResponse, AWSError>;
123 /**
124 * List the tags for an Amazon EKS resource.
125 */
126 listTagsForResource(callback?: (err: AWSError, data: EKS.Types.ListTagsForResourceResponse) => void): Request<EKS.Types.ListTagsForResourceResponse, AWSError>;
127 /**
128 * Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
129 */
130 listUpdates(params: EKS.Types.ListUpdatesRequest, callback?: (err: AWSError, data: EKS.Types.ListUpdatesResponse) => void): Request<EKS.Types.ListUpdatesResponse, AWSError>;
131 /**
132 * Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
133 */
134 listUpdates(callback?: (err: AWSError, data: EKS.Types.ListUpdatesResponse) => void): Request<EKS.Types.ListUpdatesResponse, AWSError>;
135 /**
136 * 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 worker nodes associated with the cluster.
137 */
138 tagResource(params: EKS.Types.TagResourceRequest, callback?: (err: AWSError, data: EKS.Types.TagResourceResponse) => void): Request<EKS.Types.TagResourceResponse, AWSError>;
139 /**
140 * 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 worker nodes associated with the cluster.
141 */
142 tagResource(callback?: (err: AWSError, data: EKS.Types.TagResourceResponse) => void): Request<EKS.Types.TagResourceResponse, AWSError>;
143 /**
144 * Deletes specified tags from a resource.
145 */
146 untagResource(params: EKS.Types.UntagResourceRequest, callback?: (err: AWSError, data: EKS.Types.UntagResourceResponse) => void): Request<EKS.Types.UntagResourceResponse, AWSError>;
147 /**
148 * Deletes specified tags from a resource.
149 */
150 untagResource(callback?: (err: AWSError, data: EKS.Types.UntagResourceResponse) => void): Request<EKS.Types.UntagResourceResponse, AWSError>;
151 /**
152 * 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 Amazon 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 . At this time, you can not 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.
153 */
154 updateClusterConfig(params: EKS.Types.UpdateClusterConfigRequest, callback?: (err: AWSError, data: EKS.Types.UpdateClusterConfigResponse) => void): Request<EKS.Types.UpdateClusterConfigResponse, AWSError>;
155 /**
156 * 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 Amazon 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 . At this time, you can not 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.
157 */
158 updateClusterConfig(callback?: (err: AWSError, data: EKS.Types.UpdateClusterConfigResponse) => void): Request<EKS.Types.UpdateClusterConfigResponse, AWSError>;
159 /**
160 * 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.
161 */
162 updateClusterVersion(params: EKS.Types.UpdateClusterVersionRequest, callback?: (err: AWSError, data: EKS.Types.UpdateClusterVersionResponse) => void): Request<EKS.Types.UpdateClusterVersionResponse, AWSError>;
163 /**
164 * 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.
165 */
166 updateClusterVersion(callback?: (err: AWSError, data: EKS.Types.UpdateClusterVersionResponse) => void): Request<EKS.Types.UpdateClusterVersionResponse, AWSError>;
167 /**
168 * 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.
169 */
170 updateNodegroupConfig(params: EKS.Types.UpdateNodegroupConfigRequest, callback?: (err: AWSError, data: EKS.Types.UpdateNodegroupConfigResponse) => void): Request<EKS.Types.UpdateNodegroupConfigResponse, AWSError>;
171 /**
172 * 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.
173 */
174 updateNodegroupConfig(callback?: (err: AWSError, data: EKS.Types.UpdateNodegroupConfigResponse) => void): Request<EKS.Types.UpdateNodegroupConfigResponse, AWSError>;
175 /**
176 * Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. 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 Linux 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.
177 */
178 updateNodegroupVersion(params: EKS.Types.UpdateNodegroupVersionRequest, callback?: (err: AWSError, data: EKS.Types.UpdateNodegroupVersionResponse) => void): Request<EKS.Types.UpdateNodegroupVersionResponse, AWSError>;
179 /**
180 * Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. 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 Linux 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.
181 */
182 updateNodegroupVersion(callback?: (err: AWSError, data: EKS.Types.UpdateNodegroupVersionResponse) => void): Request<EKS.Types.UpdateNodegroupVersionResponse, AWSError>;
183 /**
184 * Waits for the clusterActive state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times).
185 */
186 waitFor(state: "clusterActive", params: EKS.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
187 /**
188 * Waits for the clusterActive state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times).
189 */
190 waitFor(state: "clusterActive", callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
191 /**
192 * Waits for the clusterDeleted state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times).
193 */
194 waitFor(state: "clusterDeleted", params: EKS.Types.DescribeClusterRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
195 /**
196 * Waits for the clusterDeleted state by periodically calling the underlying EKS.describeClusteroperation every 30 seconds (at most 40 times).
197 */
198 waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: EKS.Types.DescribeClusterResponse) => void): Request<EKS.Types.DescribeClusterResponse, AWSError>;
199 /**
200 * Waits for the nodegroupActive state by periodically calling the underlying EKS.describeNodegroupoperation every 30 seconds (at most 80 times).
201 */
202 waitFor(state: "nodegroupActive", params: EKS.Types.DescribeNodegroupRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
203 /**
204 * Waits for the nodegroupActive state by periodically calling the underlying EKS.describeNodegroupoperation every 30 seconds (at most 80 times).
205 */
206 waitFor(state: "nodegroupActive", callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
207 /**
208 * Waits for the nodegroupDeleted state by periodically calling the underlying EKS.describeNodegroupoperation every 30 seconds (at most 40 times).
209 */
210 waitFor(state: "nodegroupDeleted", params: EKS.Types.DescribeNodegroupRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
211 /**
212 * Waits for the nodegroupDeleted state by periodically calling the underlying EKS.describeNodegroupoperation every 30 seconds (at most 40 times).
213 */
214 waitFor(state: "nodegroupDeleted", callback?: (err: AWSError, data: EKS.Types.DescribeNodegroupResponse) => void): Request<EKS.Types.DescribeNodegroupResponse, AWSError>;
215}
216declare namespace EKS {
217 export type AMITypes = "AL2_x86_64"|"AL2_x86_64_GPU"|string;
218 export interface AutoScalingGroup {
219 /**
220 * The name of the Auto Scaling group associated with an Amazon EKS managed node group.
221 */
222 name?: String;
223 }
224 export type AutoScalingGroupList = AutoScalingGroup[];
225 export type Boolean = boolean;
226 export type BoxedBoolean = boolean;
227 export type BoxedInteger = number;
228 export type Capacity = number;
229 export interface Certificate {
230 /**
231 * 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.
232 */
233 data?: String;
234 }
235 export interface Cluster {
236 /**
237 * The name of the cluster.
238 */
239 name?: String;
240 /**
241 * The Amazon Resource Name (ARN) of the cluster.
242 */
243 arn?: String;
244 /**
245 * The Unix epoch timestamp in seconds for when the cluster was created.
246 */
247 createdAt?: Timestamp;
248 /**
249 * The Kubernetes server version for the cluster.
250 */
251 version?: String;
252 /**
253 * The endpoint for your Kubernetes API server.
254 */
255 endpoint?: String;
256 /**
257 * 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.
258 */
259 roleArn?: String;
260 /**
261 * The VPC configuration 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.
262 */
263 resourcesVpcConfig?: VpcConfigResponse;
264 /**
265 * The logging configuration for your cluster.
266 */
267 logging?: Logging;
268 /**
269 * The identity provider information for the cluster.
270 */
271 identity?: Identity;
272 /**
273 * The current status of the cluster.
274 */
275 status?: ClusterStatus;
276 /**
277 * The certificate-authority-data for your cluster.
278 */
279 certificateAuthority?: Certificate;
280 /**
281 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
282 */
283 clientRequestToken?: String;
284 /**
285 * The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
286 */
287 platformVersion?: String;
288 /**
289 * The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
290 */
291 tags?: TagMap;
292 /**
293 * The encryption configuration for the cluster.
294 */
295 encryptionConfig?: EncryptionConfigList;
296 }
297 export type ClusterName = string;
298 export type ClusterStatus = "CREATING"|"ACTIVE"|"DELETING"|"FAILED"|"UPDATING"|string;
299 export interface CreateClusterRequest {
300 /**
301 * The unique name to give to your cluster.
302 */
303 name: ClusterName;
304 /**
305 * The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
306 */
307 version?: String;
308 /**
309 * The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
310 */
311 roleArn: String;
312 /**
313 * The VPC configuration 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. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
314 */
315 resourcesVpcConfig: VpcConfigRequest;
316 /**
317 * 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 Amazon CloudWatch Pricing.
318 */
319 logging?: Logging;
320 /**
321 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
322 */
323 clientRequestToken?: String;
324 /**
325 * The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.
326 */
327 tags?: TagMap;
328 /**
329 * The encryption configuration for the cluster.
330 */
331 encryptionConfig?: EncryptionConfigList;
332 }
333 export interface CreateClusterResponse {
334 /**
335 * The full description of your new cluster.
336 */
337 cluster?: Cluster;
338 }
339 export interface CreateFargateProfileRequest {
340 /**
341 * The name of the Fargate profile.
342 */
343 fargateProfileName: String;
344 /**
345 * The name of the Amazon EKS cluster to apply the Fargate profile to.
346 */
347 clusterName: String;
348 /**
349 * The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.
350 */
351 podExecutionRoleArn: String;
352 /**
353 * The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.
354 */
355 subnets?: StringList;
356 /**
357 * The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.
358 */
359 selectors?: FargateProfileSelectors;
360 /**
361 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
362 */
363 clientRequestToken?: String;
364 /**
365 * The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
366 */
367 tags?: TagMap;
368 }
369 export interface CreateFargateProfileResponse {
370 /**
371 * The full description of your new Fargate profile.
372 */
373 fargateProfile?: FargateProfile;
374 }
375 export interface CreateNodegroupRequest {
376 /**
377 * The name of the cluster to create the node group in.
378 */
379 clusterName: String;
380 /**
381 * The unique name to give your node group.
382 */
383 nodegroupName: String;
384 /**
385 * The scaling configuration details for the Auto Scaling group that is created for your node group.
386 */
387 scalingConfig?: NodegroupScalingConfig;
388 /**
389 * The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
390 */
391 diskSize?: BoxedInteger;
392 /**
393 * The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster.
394 */
395 subnets: StringList;
396 /**
397 * The instance type to use for your node group. Currently, you can specify a single instance type for a node group. The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU with the amiType parameter.
398 */
399 instanceTypes?: StringList;
400 /**
401 * The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
402 */
403 amiType?: AMITypes;
404 /**
405 * The remote access (SSH) configuration to use with your node group.
406 */
407 remoteAccess?: RemoteAccessConfig;
408 /**
409 * The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide .
410 */
411 nodeRole: String;
412 /**
413 * The Kubernetes labels to be applied to the nodes in the node group when they are created.
414 */
415 labels?: labelsMap;
416 /**
417 * The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
418 */
419 tags?: TagMap;
420 /**
421 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
422 */
423 clientRequestToken?: String;
424 /**
425 * The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value.
426 */
427 version?: String;
428 /**
429 * The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
430 */
431 releaseVersion?: String;
432 }
433 export interface CreateNodegroupResponse {
434 /**
435 * The full description of your new node group.
436 */
437 nodegroup?: Nodegroup;
438 }
439 export interface DeleteClusterRequest {
440 /**
441 * The name of the cluster to delete.
442 */
443 name: String;
444 }
445 export interface DeleteClusterResponse {
446 /**
447 * The full description of the cluster to delete.
448 */
449 cluster?: Cluster;
450 }
451 export interface DeleteFargateProfileRequest {
452 /**
453 * The name of the Amazon EKS cluster associated with the Fargate profile to delete.
454 */
455 clusterName: String;
456 /**
457 * The name of the Fargate profile to delete.
458 */
459 fargateProfileName: String;
460 }
461 export interface DeleteFargateProfileResponse {
462 /**
463 * The deleted Fargate profile.
464 */
465 fargateProfile?: FargateProfile;
466 }
467 export interface DeleteNodegroupRequest {
468 /**
469 * The name of the Amazon EKS cluster that is associated with your node group.
470 */
471 clusterName: String;
472 /**
473 * The name of the node group to delete.
474 */
475 nodegroupName: String;
476 }
477 export interface DeleteNodegroupResponse {
478 /**
479 * The full description of your deleted node group.
480 */
481 nodegroup?: Nodegroup;
482 }
483 export interface DescribeClusterRequest {
484 /**
485 * The name of the cluster to describe.
486 */
487 name: String;
488 }
489 export interface DescribeClusterResponse {
490 /**
491 * The full description of your specified cluster.
492 */
493 cluster?: Cluster;
494 }
495 export interface DescribeFargateProfileRequest {
496 /**
497 * The name of the Amazon EKS cluster associated with the Fargate profile.
498 */
499 clusterName: String;
500 /**
501 * The name of the Fargate profile to describe.
502 */
503 fargateProfileName: String;
504 }
505 export interface DescribeFargateProfileResponse {
506 /**
507 * The full description of your Fargate profile.
508 */
509 fargateProfile?: FargateProfile;
510 }
511 export interface DescribeNodegroupRequest {
512 /**
513 * The name of the Amazon EKS cluster associated with the node group.
514 */
515 clusterName: String;
516 /**
517 * The name of the node group to describe.
518 */
519 nodegroupName: String;
520 }
521 export interface DescribeNodegroupResponse {
522 /**
523 * The full description of your node group.
524 */
525 nodegroup?: Nodegroup;
526 }
527 export interface DescribeUpdateRequest {
528 /**
529 * The name of the Amazon EKS cluster associated with the update.
530 */
531 name: String;
532 /**
533 * The ID of the update to describe.
534 */
535 updateId: String;
536 /**
537 * The name of the Amazon EKS node group associated with the update.
538 */
539 nodegroupName?: String;
540 }
541 export interface DescribeUpdateResponse {
542 /**
543 * The full description of the specified update.
544 */
545 update?: Update;
546 }
547 export interface EncryptionConfig {
548 /**
549 * Specifies the resources to be encrypted. The only supported value is "secrets".
550 */
551 resources?: StringList;
552 /**
553 * AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.
554 */
555 provider?: Provider;
556 }
557 export type EncryptionConfigList = EncryptionConfig[];
558 export type ErrorCode = "SubnetNotFound"|"SecurityGroupNotFound"|"EniLimitReached"|"IpNotAvailable"|"AccessDenied"|"OperationNotPermitted"|"VpcIdNotFound"|"Unknown"|"NodeCreationFailure"|"PodEvictionFailure"|"InsufficientFreeAddresses"|string;
559 export interface ErrorDetail {
560 /**
561 * A brief description of the error. SubnetNotFound: We couldn't find one of the subnets associated with the cluster. SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster. EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses. AccessDenied: You don't have permissions to perform the specified operation. OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. VpcIdNotFound: We couldn't find the VPC associated with the cluster.
562 */
563 errorCode?: ErrorCode;
564 /**
565 * A more complete description of the error.
566 */
567 errorMessage?: String;
568 /**
569 * An optional field that contains the resource IDs associated with the error.
570 */
571 resourceIds?: StringList;
572 }
573 export type ErrorDetails = ErrorDetail[];
574 export interface FargateProfile {
575 /**
576 * The name of the Fargate profile.
577 */
578 fargateProfileName?: String;
579 /**
580 * The full Amazon Resource Name (ARN) of the Fargate profile.
581 */
582 fargateProfileArn?: String;
583 /**
584 * The name of the Amazon EKS cluster that the Fargate profile belongs to.
585 */
586 clusterName?: String;
587 /**
588 * The Unix epoch timestamp in seconds for when the Fargate profile was created.
589 */
590 createdAt?: Timestamp;
591 /**
592 * The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.
593 */
594 podExecutionRoleArn?: String;
595 /**
596 * The IDs of subnets to launch pods into.
597 */
598 subnets?: StringList;
599 /**
600 * The selectors to match for pods to use this Fargate profile.
601 */
602 selectors?: FargateProfileSelectors;
603 /**
604 * The current status of the Fargate profile.
605 */
606 status?: FargateProfileStatus;
607 /**
608 * The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
609 */
610 tags?: TagMap;
611 }
612 export type FargateProfileLabel = {[key: string]: String};
613 export interface FargateProfileSelector {
614 /**
615 * The Kubernetes namespace that the selector should match.
616 */
617 namespace?: String;
618 /**
619 * The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
620 */
621 labels?: FargateProfileLabel;
622 }
623 export type FargateProfileSelectors = FargateProfileSelector[];
624 export type FargateProfileStatus = "CREATING"|"ACTIVE"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"|string;
625 export type FargateProfilesRequestMaxResults = number;
626 export interface Identity {
627 /**
628 * The OpenID Connect identity provider information for the cluster.
629 */
630 oidc?: OIDC;
631 }
632 export interface Issue {
633 /**
634 * A brief description of the error. AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover. Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster. Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group. Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover. Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover. IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover. IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover. AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances. NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient worker node IAM role permissions or lack of outbound internet access for the nodes. InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover. InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes. AccessDenied: Amazon EKS or one or more of your managed nodes is unable to communicate with your cluster API server. InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
635 */
636 code?: NodegroupIssueCode;
637 /**
638 * The error message associated with the issue.
639 */
640 message?: String;
641 /**
642 * The AWS resources that are afflicted by this issue.
643 */
644 resourceIds?: StringList;
645 }
646 export type IssueList = Issue[];
647 export interface ListClustersRequest {
648 /**
649 * The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.
650 */
651 maxResults?: ListClustersRequestMaxResults;
652 /**
653 * The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
654 */
655 nextToken?: String;
656 }
657 export type ListClustersRequestMaxResults = number;
658 export interface ListClustersResponse {
659 /**
660 * A list of all of the clusters for your account in the specified Region.
661 */
662 clusters?: StringList;
663 /**
664 * The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
665 */
666 nextToken?: String;
667 }
668 export interface ListFargateProfilesRequest {
669 /**
670 * The name of the Amazon EKS cluster that you would like to listFargate profiles in.
671 */
672 clusterName: String;
673 /**
674 * The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.
675 */
676 maxResults?: FargateProfilesRequestMaxResults;
677 /**
678 * The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
679 */
680 nextToken?: String;
681 }
682 export interface ListFargateProfilesResponse {
683 /**
684 * A list of all of the Fargate profiles associated with the specified cluster.
685 */
686 fargateProfileNames?: StringList;
687 /**
688 * The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
689 */
690 nextToken?: String;
691 }
692 export interface ListNodegroupsRequest {
693 /**
694 * The name of the Amazon EKS cluster that you would like to list node groups in.
695 */
696 clusterName: String;
697 /**
698 * The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.
699 */
700 maxResults?: ListNodegroupsRequestMaxResults;
701 /**
702 * The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
703 */
704 nextToken?: String;
705 }
706 export type ListNodegroupsRequestMaxResults = number;
707 export interface ListNodegroupsResponse {
708 /**
709 * A list of all of the node groups associated with the specified cluster.
710 */
711 nodegroups?: StringList;
712 /**
713 * The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
714 */
715 nextToken?: String;
716 }
717 export interface ListTagsForResourceRequest {
718 /**
719 * The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
720 */
721 resourceArn: String;
722 }
723 export interface ListTagsForResourceResponse {
724 /**
725 * The tags for the resource.
726 */
727 tags?: TagMap;
728 }
729 export interface ListUpdatesRequest {
730 /**
731 * The name of the Amazon EKS cluster to list updates for.
732 */
733 name: String;
734 /**
735 * The name of the Amazon EKS managed node group to list updates for.
736 */
737 nodegroupName?: String;
738 /**
739 * The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
740 */
741 nextToken?: String;
742 /**
743 * The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.
744 */
745 maxResults?: ListUpdatesRequestMaxResults;
746 }
747 export type ListUpdatesRequestMaxResults = number;
748 export interface ListUpdatesResponse {
749 /**
750 * A list of all the updates for the specified cluster and Region.
751 */
752 updateIds?: StringList;
753 /**
754 * The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
755 */
756 nextToken?: String;
757 }
758 export interface LogSetup {
759 /**
760 * The available cluster control plane log types.
761 */
762 types?: LogTypes;
763 /**
764 * If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
765 */
766 enabled?: BoxedBoolean;
767 }
768 export type LogSetups = LogSetup[];
769 export type LogType = "api"|"audit"|"authenticator"|"controllerManager"|"scheduler"|string;
770 export type LogTypes = LogType[];
771 export interface Logging {
772 /**
773 * The cluster control plane logging configuration for your cluster.
774 */
775 clusterLogging?: LogSetups;
776 }
777 export interface Nodegroup {
778 /**
779 * The name associated with an Amazon EKS managed node group.
780 */
781 nodegroupName?: String;
782 /**
783 * The Amazon Resource Name (ARN) associated with the managed node group.
784 */
785 nodegroupArn?: String;
786 /**
787 * The name of the cluster that the managed node group resides in.
788 */
789 clusterName?: String;
790 /**
791 * The Kubernetes version of the managed node group.
792 */
793 version?: String;
794 /**
795 * The AMI version of the managed node group. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
796 */
797 releaseVersion?: String;
798 /**
799 * The Unix epoch timestamp in seconds for when the managed node group was created.
800 */
801 createdAt?: Timestamp;
802 /**
803 * The Unix epoch timestamp in seconds for when the managed node group was last modified.
804 */
805 modifiedAt?: Timestamp;
806 /**
807 * The current status of the managed node group.
808 */
809 status?: NodegroupStatus;
810 /**
811 * The scaling configuration details for the Auto Scaling group that is associated with your node group.
812 */
813 scalingConfig?: NodegroupScalingConfig;
814 /**
815 * The instance types associated with your node group.
816 */
817 instanceTypes?: StringList;
818 /**
819 * The subnets allowed for the Auto Scaling group that is associated with your node group. These subnets must have the following tag: kubernetes.io/cluster/CLUSTER_NAME, where CLUSTER_NAME is replaced with the name of your cluster.
820 */
821 subnets?: StringList;
822 /**
823 * The remote access (SSH) configuration that is associated with the node group.
824 */
825 remoteAccess?: RemoteAccessConfig;
826 /**
827 * The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
828 */
829 amiType?: AMITypes;
830 /**
831 * The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide .
832 */
833 nodeRole?: String;
834 /**
835 * The Kubernetes labels applied to the nodes in the node group. Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
836 */
837 labels?: labelsMap;
838 /**
839 * The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
840 */
841 resources?: NodegroupResources;
842 /**
843 * The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
844 */
845 diskSize?: BoxedInteger;
846 /**
847 * The health status of the node group. If there are issues with your node group's health, they are listed here.
848 */
849 health?: NodegroupHealth;
850 /**
851 * The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
852 */
853 tags?: TagMap;
854 }
855 export interface NodegroupHealth {
856 /**
857 * Any issues that are associated with the node group.
858 */
859 issues?: IssueList;
860 }
861 export type NodegroupIssueCode = "AutoScalingGroupNotFound"|"AutoScalingGroupInvalidConfiguration"|"Ec2SecurityGroupNotFound"|"Ec2SecurityGroupDeletionFailure"|"Ec2LaunchTemplateNotFound"|"Ec2LaunchTemplateVersionMismatch"|"Ec2SubnetNotFound"|"Ec2SubnetInvalidConfiguration"|"IamInstanceProfileNotFound"|"IamLimitExceeded"|"IamNodeRoleNotFound"|"NodeCreationFailure"|"AsgInstanceLaunchFailures"|"InstanceLimitExceeded"|"InsufficientFreeAddresses"|"AccessDenied"|"InternalFailure"|string;
862 export interface NodegroupResources {
863 /**
864 * The Auto Scaling groups associated with the node group.
865 */
866 autoScalingGroups?: AutoScalingGroupList;
867 /**
868 * The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.
869 */
870 remoteAccessSecurityGroup?: String;
871 }
872 export interface NodegroupScalingConfig {
873 /**
874 * The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
875 */
876 minSize?: Capacity;
877 /**
878 * The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
879 */
880 maxSize?: Capacity;
881 /**
882 * The current number of worker nodes that the managed node group should maintain.
883 */
884 desiredSize?: Capacity;
885 }
886 export type NodegroupStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"|"DEGRADED"|string;
887 export interface OIDC {
888 /**
889 * The issuer URL for the OpenID Connect identity provider.
890 */
891 issuer?: String;
892 }
893 export interface Provider {
894 /**
895 * Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide.
896 */
897 keyArn?: String;
898 }
899 export interface RemoteAccessConfig {
900 /**
901 * The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
902 */
903 ec2SshKey?: String;
904 /**
905 * The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
906 */
907 sourceSecurityGroups?: StringList;
908 }
909 export type String = string;
910 export type StringList = String[];
911 export type TagKey = string;
912 export type TagKeyList = TagKey[];
913 export type TagMap = {[key: string]: TagValue};
914 export interface TagResourceRequest {
915 /**
916 * The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
917 */
918 resourceArn: String;
919 /**
920 * The tags to add to the resource. A tag is an array of key-value pairs.
921 */
922 tags: TagMap;
923 }
924 export interface TagResourceResponse {
925 }
926 export type TagValue = string;
927 export type Timestamp = Date;
928 export interface UntagResourceRequest {
929 /**
930 * The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
931 */
932 resourceArn: String;
933 /**
934 * The keys of the tags to be removed.
935 */
936 tagKeys: TagKeyList;
937 }
938 export interface UntagResourceResponse {
939 }
940 export interface Update {
941 /**
942 * A UUID that is used to track the update.
943 */
944 id?: String;
945 /**
946 * The current status of the update.
947 */
948 status?: UpdateStatus;
949 /**
950 * The type of the update.
951 */
952 type?: UpdateType;
953 /**
954 * A key-value map that contains the parameters associated with the update.
955 */
956 params?: UpdateParams;
957 /**
958 * The Unix epoch timestamp in seconds for when the update was created.
959 */
960 createdAt?: Timestamp;
961 /**
962 * Any errors associated with a Failed update.
963 */
964 errors?: ErrorDetails;
965 }
966 export interface UpdateClusterConfigRequest {
967 /**
968 * The name of the Amazon EKS cluster to update.
969 */
970 name: String;
971 resourcesVpcConfig?: VpcConfigRequest;
972 /**
973 * 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 Amazon CloudWatch Pricing.
974 */
975 logging?: Logging;
976 /**
977 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
978 */
979 clientRequestToken?: String;
980 }
981 export interface UpdateClusterConfigResponse {
982 update?: Update;
983 }
984 export interface UpdateClusterVersionRequest {
985 /**
986 * The name of the Amazon EKS cluster to update.
987 */
988 name: String;
989 /**
990 * The desired Kubernetes version following a successful update.
991 */
992 version: String;
993 /**
994 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
995 */
996 clientRequestToken?: String;
997 }
998 export interface UpdateClusterVersionResponse {
999 /**
1000 * The full description of the specified update
1001 */
1002 update?: Update;
1003 }
1004 export interface UpdateLabelsPayload {
1005 /**
1006 * Kubernetes labels to be added or updated.
1007 */
1008 addOrUpdateLabels?: labelsMap;
1009 /**
1010 * Kubernetes labels to be removed.
1011 */
1012 removeLabels?: labelsKeyList;
1013 }
1014 export interface UpdateNodegroupConfigRequest {
1015 /**
1016 * The name of the Amazon EKS cluster that the managed node group resides in.
1017 */
1018 clusterName: String;
1019 /**
1020 * The name of the managed node group to update.
1021 */
1022 nodegroupName: String;
1023 /**
1024 * The Kubernetes labels to be applied to the nodes in the node group after the update.
1025 */
1026 labels?: UpdateLabelsPayload;
1027 /**
1028 * The scaling configuration details for the Auto Scaling group after the update.
1029 */
1030 scalingConfig?: NodegroupScalingConfig;
1031 /**
1032 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1033 */
1034 clientRequestToken?: String;
1035 }
1036 export interface UpdateNodegroupConfigResponse {
1037 update?: Update;
1038 }
1039 export interface UpdateNodegroupVersionRequest {
1040 /**
1041 * The name of the Amazon EKS cluster that is associated with the managed node group to update.
1042 */
1043 clusterName: String;
1044 /**
1045 * The name of the managed node group to update.
1046 */
1047 nodegroupName: String;
1048 /**
1049 * The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version.
1050 */
1051 version?: String;
1052 /**
1053 * The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
1054 */
1055 releaseVersion?: String;
1056 /**
1057 * Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
1058 */
1059 force?: Boolean;
1060 /**
1061 * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
1062 */
1063 clientRequestToken?: String;
1064 }
1065 export interface UpdateNodegroupVersionResponse {
1066 update?: Update;
1067 }
1068 export interface UpdateParam {
1069 /**
1070 * The keys associated with an update request.
1071 */
1072 type?: UpdateParamType;
1073 /**
1074 * The value of the keys submitted as part of an update request.
1075 */
1076 value?: String;
1077 }
1078 export type UpdateParamType = "Version"|"PlatformVersion"|"EndpointPrivateAccess"|"EndpointPublicAccess"|"ClusterLogging"|"DesiredSize"|"LabelsToAdd"|"LabelsToRemove"|"MaxSize"|"MinSize"|"ReleaseVersion"|"PublicAccessCidrs"|string;
1079 export type UpdateParams = UpdateParam[];
1080 export type UpdateStatus = "InProgress"|"Failed"|"Cancelled"|"Successful"|string;
1081 export type UpdateType = "VersionUpdate"|"EndpointAccessUpdate"|"LoggingUpdate"|"ConfigUpdate"|string;
1082 export interface VpcConfigRequest {
1083 /**
1084 * Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.
1085 */
1086 subnetIds?: StringList;
1087 /**
1088 * Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
1089 */
1090 securityGroupIds?: StringList;
1091 /**
1092 * Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
1093 */
1094 endpointPublicAccess?: BoxedBoolean;
1095 /**
1096 * Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
1097 */
1098 endpointPrivateAccess?: BoxedBoolean;
1099 /**
1100 * The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
1101 */
1102 publicAccessCidrs?: StringList;
1103 }
1104 export interface VpcConfigResponse {
1105 /**
1106 * The subnets associated with your cluster.
1107 */
1108 subnetIds?: StringList;
1109 /**
1110 * 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.
1111 */
1112 securityGroupIds?: StringList;
1113 /**
1114 * The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
1115 */
1116 clusterSecurityGroupId?: String;
1117 /**
1118 * The VPC associated with your cluster.
1119 */
1120 vpcId?: String;
1121 /**
1122 * This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
1123 */
1124 endpointPublicAccess?: Boolean;
1125 /**
1126 * This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
1127 */
1128 endpointPrivateAccess?: Boolean;
1129 /**
1130 * The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
1131 */
1132 publicAccessCidrs?: StringList;
1133 }
1134 export type labelKey = string;
1135 export type labelValue = string;
1136 export type labelsKeyList = String[];
1137 export type labelsMap = {[key: string]: labelValue};
1138 /**
1139 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1140 */
1141 export type apiVersion = "2017-11-01"|"latest"|string;
1142 export interface ClientApiVersions {
1143 /**
1144 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1145 */
1146 apiVersion?: apiVersion;
1147 }
1148 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1149 /**
1150 * Contains interfaces for use with the EKS client.
1151 */
1152 export import Types = EKS;
1153}
1154export = EKS;