@aws-sdk/client-eks 3.231.0 → 3.234.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/models_0.js +4 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-types/EKS.d.ts +52 -49
- package/dist-types/EKSClient.d.ts +1 -1
- package/dist-types/commands/AssociateEncryptionConfigCommand.d.ts +1 -1
- package/dist-types/commands/AssociateIdentityProviderConfigCommand.d.ts +1 -1
- package/dist-types/commands/CreateAddonCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterCommand.d.ts +4 -5
- package/dist-types/commands/CreateFargateProfileCommand.d.ts +5 -5
- package/dist-types/commands/CreateNodegroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteAddonCommand.d.ts +1 -1
- package/dist-types/commands/DeleteClusterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFargateProfileCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClusterCommand.d.ts +3 -3
- package/dist-types/commands/DescribeUpdateCommand.d.ts +1 -1
- package/dist-types/commands/RegisterClusterCommand.d.ts +4 -5
- package/dist-types/commands/UpdateClusterConfigCommand.d.ts +7 -7
- package/dist-types/commands/UpdateClusterVersionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateNodegroupVersionCommand.d.ts +10 -8
- package/dist-types/models/models_0.d.ts +136 -120
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/package.json +7 -7
|
@@ -49,6 +49,10 @@ var AMITypes;
|
|
|
49
49
|
AMITypes["BOTTLEROCKET_x86_64"] = "BOTTLEROCKET_x86_64";
|
|
50
50
|
AMITypes["BOTTLEROCKET_x86_64_NVIDIA"] = "BOTTLEROCKET_x86_64_NVIDIA";
|
|
51
51
|
AMITypes["CUSTOM"] = "CUSTOM";
|
|
52
|
+
AMITypes["WINDOWS_CORE_2019_x86_64"] = "WINDOWS_CORE_2019_x86_64";
|
|
53
|
+
AMITypes["WINDOWS_CORE_2022_x86_64"] = "WINDOWS_CORE_2022_x86_64";
|
|
54
|
+
AMITypes["WINDOWS_FULL_2019_x86_64"] = "WINDOWS_FULL_2019_x86_64";
|
|
55
|
+
AMITypes["WINDOWS_FULL_2022_x86_64"] = "WINDOWS_FULL_2022_x86_64";
|
|
52
56
|
})(AMITypes = exports.AMITypes || (exports.AMITypes = {}));
|
|
53
57
|
var ErrorCode;
|
|
54
58
|
(function (ErrorCode) {
|
|
@@ -43,6 +43,10 @@ export var AMITypes;
|
|
|
43
43
|
AMITypes["BOTTLEROCKET_x86_64"] = "BOTTLEROCKET_x86_64";
|
|
44
44
|
AMITypes["BOTTLEROCKET_x86_64_NVIDIA"] = "BOTTLEROCKET_x86_64_NVIDIA";
|
|
45
45
|
AMITypes["CUSTOM"] = "CUSTOM";
|
|
46
|
+
AMITypes["WINDOWS_CORE_2019_x86_64"] = "WINDOWS_CORE_2019_x86_64";
|
|
47
|
+
AMITypes["WINDOWS_CORE_2022_x86_64"] = "WINDOWS_CORE_2022_x86_64";
|
|
48
|
+
AMITypes["WINDOWS_FULL_2019_x86_64"] = "WINDOWS_FULL_2019_x86_64";
|
|
49
|
+
AMITypes["WINDOWS_FULL_2022_x86_64"] = "WINDOWS_FULL_2022_x86_64";
|
|
46
50
|
})(AMITypes || (AMITypes = {}));
|
|
47
51
|
export var ErrorCode;
|
|
48
52
|
(function (ErrorCode) {
|
package/dist-types/EKS.d.ts
CHANGED
|
@@ -40,7 +40,7 @@ import { EKSClient } from "./EKSClient";
|
|
|
40
40
|
* for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain
|
|
41
41
|
* your own Kubernetes control plane. Kubernetes is an open-source system for automating
|
|
42
42
|
* the deployment, scaling, and management of containerized applications. </p>
|
|
43
|
-
*
|
|
43
|
+
* <p>Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so
|
|
44
44
|
* you can use all the existing plugins and tooling from the Kubernetes community.
|
|
45
45
|
* Applications running on Amazon EKS are fully compatible with applications
|
|
46
46
|
* running on any standard Kubernetes environment, whether running in on-premises data
|
|
@@ -50,7 +50,7 @@ import { EKSClient } from "./EKSClient";
|
|
|
50
50
|
export declare class EKS extends EKSClient {
|
|
51
51
|
/**
|
|
52
52
|
* <p>Associate encryption configuration to an existing cluster.</p>
|
|
53
|
-
*
|
|
53
|
+
* <p>You can use this API to enable encryption on existing clusters which do not have
|
|
54
54
|
* encryption already enabled. This allows you to implement a defense-in-depth security
|
|
55
55
|
* strategy without migrating applications to new Amazon EKS clusters.</p>
|
|
56
56
|
*/
|
|
@@ -59,7 +59,7 @@ export declare class EKS extends EKSClient {
|
|
|
59
59
|
associateEncryptionConfig(args: AssociateEncryptionConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEncryptionConfigCommandOutput) => void): void;
|
|
60
60
|
/**
|
|
61
61
|
* <p>Associate an identity provider configuration to a cluster.</p>
|
|
62
|
-
*
|
|
62
|
+
* <p>If you want to authenticate identities using an identity provider, you can create an
|
|
63
63
|
* identity provider configuration and associate it to your cluster. After configuring
|
|
64
64
|
* authentication to your cluster you can create Kubernetes <code>roles</code> and
|
|
65
65
|
* <code>clusterroles</code> to assign permissions to the roles, and then bind the
|
|
@@ -72,7 +72,7 @@ export declare class EKS extends EKSClient {
|
|
|
72
72
|
associateIdentityProviderConfig(args: AssociateIdentityProviderConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateIdentityProviderConfigCommandOutput) => void): void;
|
|
73
73
|
/**
|
|
74
74
|
* <p>Creates an Amazon EKS add-on.</p>
|
|
75
|
-
*
|
|
75
|
+
* <p>Amazon EKS add-ons help to automate the provisioning and lifecycle management
|
|
76
76
|
* of common operational software for Amazon EKS clusters. For more information,
|
|
77
77
|
* see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
78
78
|
*/
|
|
@@ -81,23 +81,22 @@ export declare class EKS extends EKSClient {
|
|
|
81
81
|
createAddon(args: CreateAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAddonCommandOutput) => void): void;
|
|
82
82
|
/**
|
|
83
83
|
* <p>Creates an Amazon EKS control plane. </p>
|
|
84
|
-
*
|
|
84
|
+
* <p>The Amazon EKS control plane consists of control plane instances that run the
|
|
85
85
|
* Kubernetes software, such as <code>etcd</code> and the API server. The control plane
|
|
86
86
|
* runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by
|
|
87
87
|
* the Amazon EKS API server endpoint. Each Amazon EKS cluster control
|
|
88
88
|
* plane is single tenant and unique. It runs on its own set of Amazon EC2
|
|
89
89
|
* instances.</p>
|
|
90
|
-
*
|
|
90
|
+
* <p>The cluster control plane is provisioned across multiple Availability Zones and
|
|
91
91
|
* fronted by an Elastic Load Balancing
|
|
92
92
|
* Network Load Balancer. Amazon EKS also provisions elastic network interfaces in
|
|
93
93
|
* your VPC subnets to provide connectivity from the control plane instances to the nodes
|
|
94
94
|
* (for example, to support <code>kubectl exec</code>, <code>logs</code>, and
|
|
95
95
|
* <code>proxy</code> data flows).</p>
|
|
96
|
-
*
|
|
96
|
+
* <p>Amazon EKS nodes run in your Amazon Web Services account and connect to your
|
|
97
97
|
* cluster's control plane over the Kubernetes API server endpoint and a certificate file
|
|
98
98
|
* that is created for your cluster.</p>
|
|
99
|
-
*
|
|
100
|
-
* <p>In most cases, it takes several minutes to create a cluster. After you create an
|
|
99
|
+
* <p>In most cases, it takes several minutes to create a cluster. After you create an
|
|
101
100
|
* Amazon EKS cluster, you must configure your Kubernetes tooling to
|
|
102
101
|
* communicate with the API server and launch nodes into your cluster. For more
|
|
103
102
|
* information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html">Managing Cluster Authentication</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html">Launching
|
|
@@ -110,7 +109,7 @@ export declare class EKS extends EKSClient {
|
|
|
110
109
|
* <p>Creates an Fargate profile for your Amazon EKS cluster. You
|
|
111
110
|
* must have at least one Fargate profile in a cluster to be able to run
|
|
112
111
|
* pods on Fargate.</p>
|
|
113
|
-
*
|
|
112
|
+
* <p>The Fargate profile allows an administrator to declare which pods run
|
|
114
113
|
* on Fargate and specify which pods run on which Fargate
|
|
115
114
|
* profile. This declaration is done through the profile’s selectors. Each profile can have
|
|
116
115
|
* up to five selectors that contain a namespace and labels. A namespace is required for
|
|
@@ -118,7 +117,7 @@ export declare class EKS extends EKSClient {
|
|
|
118
117
|
* match the selectors are scheduled on Fargate. If a to-be-scheduled pod
|
|
119
118
|
* matches any of the selectors in the Fargate profile, then that pod is run
|
|
120
119
|
* on Fargate.</p>
|
|
121
|
-
*
|
|
120
|
+
* <p>When you create a Fargate profile, you must specify a pod execution
|
|
122
121
|
* role to use with the pods that are scheduled with the profile. This role is added to the
|
|
123
122
|
* cluster's Kubernetes <a href="https://kubernetes.io/docs/admin/authorization/rbac/">Role Based Access Control</a> (RBAC) for authorization so that the
|
|
124
123
|
* <code>kubelet</code> that is running on the Fargate infrastructure
|
|
@@ -127,13 +126,13 @@ export declare class EKS extends EKSClient {
|
|
|
127
126
|
* Fargate infrastructure to allow read access to Amazon ECR
|
|
128
127
|
* image repositories. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod
|
|
129
128
|
* Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
130
|
-
*
|
|
129
|
+
* <p>Fargate profiles are immutable. However, you can create a new updated
|
|
131
130
|
* profile to replace an existing profile and then delete the original after the updated
|
|
132
131
|
* profile has finished creating.</p>
|
|
133
|
-
*
|
|
132
|
+
* <p>If any Fargate profiles in a cluster are in the <code>DELETING</code>
|
|
134
133
|
* status, you must wait for that Fargate profile to finish deleting before
|
|
135
134
|
* you can create any other profiles in that cluster.</p>
|
|
136
|
-
*
|
|
135
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html">Fargate Profile</a> in the
|
|
137
136
|
* <i>Amazon EKS User Guide</i>.</p>
|
|
138
137
|
*/
|
|
139
138
|
createFargateProfile(args: CreateFargateProfileCommandInput, options?: __HttpHandlerOptions): Promise<CreateFargateProfileCommandOutput>;
|
|
@@ -146,18 +145,21 @@ export declare class EKS extends EKSClient {
|
|
|
146
145
|
* respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using
|
|
147
146
|
* a launch template. For more information about using launch templates, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch
|
|
148
147
|
* template support</a>.</p>
|
|
149
|
-
*
|
|
148
|
+
* <p>An Amazon EKS managed node group is an Amazon EC2
|
|
150
149
|
* Auto Scaling group and associated Amazon EC2 instances that are managed by
|
|
151
|
-
* Amazon Web Services for an Amazon EKS cluster.
|
|
152
|
-
*
|
|
153
|
-
*
|
|
150
|
+
* Amazon Web Services for an Amazon EKS cluster. For more information, see
|
|
151
|
+
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html">Managed node groups</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
152
|
+
* <note>
|
|
153
|
+
* <p>Windows AMI types are only supported for commercial Regions that support Windows
|
|
154
|
+
* Amazon EKS.</p>
|
|
155
|
+
* </note>
|
|
154
156
|
*/
|
|
155
157
|
createNodegroup(args: CreateNodegroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateNodegroupCommandOutput>;
|
|
156
158
|
createNodegroup(args: CreateNodegroupCommandInput, cb: (err: any, data?: CreateNodegroupCommandOutput) => void): void;
|
|
157
159
|
createNodegroup(args: CreateNodegroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNodegroupCommandOutput) => void): void;
|
|
158
160
|
/**
|
|
159
161
|
* <p>Delete an Amazon EKS add-on.</p>
|
|
160
|
-
*
|
|
162
|
+
* <p>When you remove the add-on, it will also be deleted from the cluster. You can always
|
|
161
163
|
* manually start an add-on on the cluster using the Kubernetes API.</p>
|
|
162
164
|
*/
|
|
163
165
|
deleteAddon(args: DeleteAddonCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAddonCommandOutput>;
|
|
@@ -165,12 +167,12 @@ export declare class EKS extends EKSClient {
|
|
|
165
167
|
deleteAddon(args: DeleteAddonCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAddonCommandOutput) => void): void;
|
|
166
168
|
/**
|
|
167
169
|
* <p>Deletes the Amazon EKS cluster control plane.</p>
|
|
168
|
-
*
|
|
170
|
+
* <p>If you have active services in your cluster that are associated with a load balancer,
|
|
169
171
|
* you must delete those services before deleting the cluster so that the load balancers
|
|
170
172
|
* are deleted properly. Otherwise, you can have orphaned resources in your VPC that
|
|
171
173
|
* 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
|
|
172
174
|
* Cluster</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
173
|
-
*
|
|
175
|
+
* <p>If you have managed node groups or Fargate profiles attached to the
|
|
174
176
|
* cluster, you must delete them first. For more information, see <a>DeleteNodegroup</a> and <a>DeleteFargateProfile</a>.</p>
|
|
175
177
|
*/
|
|
176
178
|
deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterCommandOutput>;
|
|
@@ -178,11 +180,11 @@ export declare class EKS extends EKSClient {
|
|
|
178
180
|
deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
|
|
179
181
|
/**
|
|
180
182
|
* <p>Deletes an Fargate profile.</p>
|
|
181
|
-
*
|
|
183
|
+
* <p>When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match
|
|
182
184
|
* another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then
|
|
183
185
|
* they are not scheduled on Fargate and they may remain in a pending
|
|
184
186
|
* state.</p>
|
|
185
|
-
*
|
|
187
|
+
* <p>Only one Fargate profile in a cluster can be in the
|
|
186
188
|
* <code>DELETING</code> status at a time. You must wait for a Fargate
|
|
187
189
|
* profile to finish deleting before you can delete any other profiles in that
|
|
188
190
|
* cluster.</p>
|
|
@@ -225,14 +227,14 @@ export declare class EKS extends EKSClient {
|
|
|
225
227
|
describeAddonVersions(args: DescribeAddonVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAddonVersionsCommandOutput) => void): void;
|
|
226
228
|
/**
|
|
227
229
|
* <p>Returns descriptive information about an Amazon EKS cluster.</p>
|
|
228
|
-
*
|
|
230
|
+
* <p>The API server endpoint and certificate authority data returned by this operation are
|
|
229
231
|
* required for <code>kubelet</code> and <code>kubectl</code> to communicate with your
|
|
230
232
|
* Kubernetes API server. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html">Create a
|
|
231
233
|
* kubeconfig for Amazon EKS</a>.</p>
|
|
232
|
-
*
|
|
234
|
+
* <note>
|
|
233
235
|
* <p>The API server endpoint and certificate authority data aren't available until the
|
|
234
236
|
* cluster reaches the <code>ACTIVE</code> state.</p>
|
|
235
|
-
*
|
|
237
|
+
* </note>
|
|
236
238
|
*/
|
|
237
239
|
describeCluster(args: DescribeClusterCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClusterCommandOutput>;
|
|
238
240
|
describeCluster(args: DescribeClusterCommandInput, cb: (err: any, data?: DescribeClusterCommandOutput) => void): void;
|
|
@@ -258,7 +260,7 @@ export declare class EKS extends EKSClient {
|
|
|
258
260
|
/**
|
|
259
261
|
* <p>Returns descriptive information about an update against your Amazon EKS
|
|
260
262
|
* cluster or associated managed node group or Amazon EKS add-on.</p>
|
|
261
|
-
*
|
|
263
|
+
* <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an
|
|
262
264
|
* update fails, the status is <code>Failed</code>, and an error detail explains the reason
|
|
263
265
|
* for the failure.</p>
|
|
264
266
|
*/
|
|
@@ -323,17 +325,16 @@ export declare class EKS extends EKSClient {
|
|
|
323
325
|
listUpdates(args: ListUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUpdatesCommandOutput) => void): void;
|
|
324
326
|
/**
|
|
325
327
|
* <p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p>
|
|
326
|
-
*
|
|
328
|
+
* <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to
|
|
327
329
|
* view current information about the cluster and its nodes. </p>
|
|
328
|
-
*
|
|
330
|
+
* <p>Cluster connection requires two steps. First, send a <code>
|
|
329
331
|
* <a>RegisterClusterRequest</a>
|
|
330
332
|
* </code> to add it to the Amazon EKS
|
|
331
333
|
* control plane.</p>
|
|
332
|
-
*
|
|
334
|
+
* <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and
|
|
333
335
|
* <code>activationCode</code> must be applied to the Kubernetes cluster through it's
|
|
334
336
|
* native provider to provide visibility.</p>
|
|
335
|
-
*
|
|
336
|
-
* <p>After the Manifest is updated and applied, then the connected cluster is visible to
|
|
337
|
+
* <p>After the Manifest is updated and applied, then the connected cluster is visible to
|
|
337
338
|
* the Amazon EKS control plane. If the Manifest is not applied within three days,
|
|
338
339
|
* then the connected cluster will no longer be visible and must be deregistered. See <a>DeregisterCluster</a>.</p>
|
|
339
340
|
*/
|
|
@@ -368,27 +369,27 @@ export declare class EKS extends EKSClient {
|
|
|
368
369
|
* function during the update. The response output includes an update ID that you can use
|
|
369
370
|
* to track the status of your cluster update with the <a>DescribeUpdate</a> API
|
|
370
371
|
* operation.</p>
|
|
371
|
-
*
|
|
372
|
+
* <p>You can use this API operation to enable or disable exporting the Kubernetes control
|
|
372
373
|
* plane logs for your cluster to CloudWatch Logs. By default, cluster control plane
|
|
373
374
|
* 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 Cluster Control Plane Logs</a> in the
|
|
374
375
|
* <i>
|
|
375
376
|
* <i>Amazon EKS User Guide</i>
|
|
376
377
|
* </i>.</p>
|
|
377
|
-
*
|
|
378
|
+
* <note>
|
|
378
379
|
* <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to
|
|
379
380
|
* exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch
|
|
380
381
|
* Pricing</a>.</p>
|
|
381
|
-
*
|
|
382
|
-
*
|
|
382
|
+
* </note>
|
|
383
|
+
* <p>You can also use this API operation to enable or disable public and private access to
|
|
383
384
|
* your cluster's Kubernetes API server endpoint. By default, public access is enabled, and
|
|
384
385
|
* private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS cluster endpoint access control</a> in the
|
|
385
386
|
* <i>
|
|
386
387
|
* <i>Amazon EKS User Guide</i>
|
|
387
388
|
* </i>. </p>
|
|
388
|
-
*
|
|
389
|
+
* <important>
|
|
389
390
|
* <p>You can't update the subnets or security group IDs for an existing cluster.</p>
|
|
390
|
-
*
|
|
391
|
-
*
|
|
391
|
+
* </important>
|
|
392
|
+
* <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
|
|
392
393
|
* an update, the cluster status moves to <code>UPDATING</code> (this status transition is
|
|
393
394
|
* eventually consistent). When the update is complete (either <code>Failed</code> or
|
|
394
395
|
* <code>Successful</code>), the cluster status moves to <code>Active</code>.</p>
|
|
@@ -400,11 +401,11 @@ export declare class EKS extends EKSClient {
|
|
|
400
401
|
* <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your
|
|
401
402
|
* cluster continues to function during the update. The response output includes an update
|
|
402
403
|
* ID that you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
|
|
403
|
-
*
|
|
404
|
+
* <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
|
|
404
405
|
* an update, the cluster status moves to <code>UPDATING</code> (this status transition is
|
|
405
406
|
* eventually consistent). When the update is complete (either <code>Failed</code> or
|
|
406
407
|
* <code>Successful</code>), the cluster status moves to <code>Active</code>.</p>
|
|
407
|
-
*
|
|
408
|
+
* <p>If your cluster has managed node groups attached to it, all of your node groups’
|
|
408
409
|
* Kubernetes versions must match the cluster’s Kubernetes version in order to update the
|
|
409
410
|
* cluster to a new Kubernetes version.</p>
|
|
410
411
|
*/
|
|
@@ -423,19 +424,21 @@ export declare class EKS extends EKSClient {
|
|
|
423
424
|
/**
|
|
424
425
|
* <p>Updates the Kubernetes version or AMI version of an Amazon EKS managed node
|
|
425
426
|
* group.</p>
|
|
426
|
-
*
|
|
427
|
+
* <p>You can update a node group using a launch template only if the node group was
|
|
427
428
|
* originally deployed with a launch template. If you need to update a custom AMI in a node
|
|
428
429
|
* group that was deployed with a launch template, then update your custom AMI, specify the
|
|
429
430
|
* new ID in a new version of the launch template, and then update the node group to the
|
|
430
431
|
* new version of the launch template.</p>
|
|
431
|
-
*
|
|
432
|
-
* AMI version of a node group's current Kubernetes version by not specifying a Kubernetes
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
432
|
+
* <p>If you update without a launch template, then you can update to the latest available
|
|
433
|
+
* AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in
|
|
434
|
+
* the request. You can update to the latest AMI version of your cluster's current Kubernetes
|
|
435
|
+
* version by specifying your cluster's Kubernetes version in the request. For information about
|
|
436
|
+
* Linux versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html">Amazon EKS optimized Amazon Linux AMI versions</a> in the
|
|
437
|
+
* <i>Amazon EKS User Guide</i>. For information about Windows versions, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html">Amazon EKS optimized Windows AMI versions</a> in the
|
|
438
|
+
* <i>Amazon EKS User Guide</i>. </p>
|
|
439
|
+
* <p>You cannot roll back a node group to an earlier Kubernetes version or AMI
|
|
437
440
|
* version.</p>
|
|
438
|
-
*
|
|
441
|
+
* <p>When a node in a managed node group is terminated due to a scaling action or update,
|
|
439
442
|
* the pods in that node are drained first. Amazon EKS attempts to drain the nodes
|
|
440
443
|
* gracefully and will fail if it is unable to do so. You can <code>force</code> the update
|
|
441
444
|
* if Amazon EKS is unable to drain the nodes as a result of a pod disruption
|
|
@@ -162,7 +162,7 @@ export interface EKSClientResolvedConfig extends EKSClientResolvedConfigType {
|
|
|
162
162
|
* for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain
|
|
163
163
|
* your own Kubernetes control plane. Kubernetes is an open-source system for automating
|
|
164
164
|
* the deployment, scaling, and management of containerized applications. </p>
|
|
165
|
-
*
|
|
165
|
+
* <p>Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so
|
|
166
166
|
* you can use all the existing plugins and tooling from the Kubernetes community.
|
|
167
167
|
* Applications running on Amazon EKS are fully compatible with applications
|
|
168
168
|
* running on any standard Kubernetes environment, whether running in on-premises data
|
|
@@ -9,7 +9,7 @@ export interface AssociateEncryptionConfigCommandOutput extends AssociateEncrypt
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Associate encryption configuration to an existing cluster.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can use this API to enable encryption on existing clusters which do not have
|
|
13
13
|
* encryption already enabled. This allows you to implement a defense-in-depth security
|
|
14
14
|
* strategy without migrating applications to new Amazon EKS clusters.</p>
|
|
15
15
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface AssociateIdentityProviderConfigCommandOutput extends AssociateI
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Associate an identity provider configuration to a cluster.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you want to authenticate identities using an identity provider, you can create an
|
|
13
13
|
* identity provider configuration and associate it to your cluster. After configuring
|
|
14
14
|
* authentication to your cluster you can create Kubernetes <code>roles</code> and
|
|
15
15
|
* <code>clusterroles</code> to assign permissions to the roles, and then bind the
|
|
@@ -9,7 +9,7 @@ export interface CreateAddonCommandOutput extends CreateAddonResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an Amazon EKS add-on.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Amazon EKS add-ons help to automate the provisioning and lifecycle management
|
|
13
13
|
* of common operational software for Amazon EKS clusters. For more information,
|
|
14
14
|
* see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
15
15
|
* @example
|
|
@@ -9,23 +9,22 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an Amazon EKS control plane. </p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The Amazon EKS control plane consists of control plane instances that run the
|
|
13
13
|
* Kubernetes software, such as <code>etcd</code> and the API server. The control plane
|
|
14
14
|
* runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by
|
|
15
15
|
* the Amazon EKS API server endpoint. Each Amazon EKS cluster control
|
|
16
16
|
* plane is single tenant and unique. It runs on its own set of Amazon EC2
|
|
17
17
|
* instances.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>The cluster control plane is provisioned across multiple Availability Zones and
|
|
19
19
|
* fronted by an Elastic Load Balancing
|
|
20
20
|
* Network Load Balancer. Amazon EKS also provisions elastic network interfaces in
|
|
21
21
|
* your VPC subnets to provide connectivity from the control plane instances to the nodes
|
|
22
22
|
* (for example, to support <code>kubectl exec</code>, <code>logs</code>, and
|
|
23
23
|
* <code>proxy</code> data flows).</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>Amazon EKS nodes run in your Amazon Web Services account and connect to your
|
|
25
25
|
* cluster's control plane over the Kubernetes API server endpoint and a certificate file
|
|
26
26
|
* that is created for your cluster.</p>
|
|
27
|
-
*
|
|
28
|
-
* <p>In most cases, it takes several minutes to create a cluster. After you create an
|
|
27
|
+
* <p>In most cases, it takes several minutes to create a cluster. After you create an
|
|
29
28
|
* Amazon EKS cluster, you must configure your Kubernetes tooling to
|
|
30
29
|
* communicate with the API server and launch nodes into your cluster. For more
|
|
31
30
|
* information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html">Managing Cluster Authentication</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html">Launching
|
|
@@ -11,7 +11,7 @@ export interface CreateFargateProfileCommandOutput extends CreateFargateProfileR
|
|
|
11
11
|
* <p>Creates an Fargate profile for your Amazon EKS cluster. You
|
|
12
12
|
* must have at least one Fargate profile in a cluster to be able to run
|
|
13
13
|
* pods on Fargate.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The Fargate profile allows an administrator to declare which pods run
|
|
15
15
|
* on Fargate and specify which pods run on which Fargate
|
|
16
16
|
* profile. This declaration is done through the profile’s selectors. Each profile can have
|
|
17
17
|
* up to five selectors that contain a namespace and labels. A namespace is required for
|
|
@@ -19,7 +19,7 @@ export interface CreateFargateProfileCommandOutput extends CreateFargateProfileR
|
|
|
19
19
|
* match the selectors are scheduled on Fargate. If a to-be-scheduled pod
|
|
20
20
|
* matches any of the selectors in the Fargate profile, then that pod is run
|
|
21
21
|
* on Fargate.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>When you create a Fargate profile, you must specify a pod execution
|
|
23
23
|
* role to use with the pods that are scheduled with the profile. This role is added to the
|
|
24
24
|
* cluster's Kubernetes <a href="https://kubernetes.io/docs/admin/authorization/rbac/">Role Based Access Control</a> (RBAC) for authorization so that the
|
|
25
25
|
* <code>kubelet</code> that is running on the Fargate infrastructure
|
|
@@ -28,13 +28,13 @@ export interface CreateFargateProfileCommandOutput extends CreateFargateProfileR
|
|
|
28
28
|
* Fargate infrastructure to allow read access to Amazon ECR
|
|
29
29
|
* image repositories. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod
|
|
30
30
|
* Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>Fargate profiles are immutable. However, you can create a new updated
|
|
32
32
|
* profile to replace an existing profile and then delete the original after the updated
|
|
33
33
|
* profile has finished creating.</p>
|
|
34
|
-
*
|
|
34
|
+
* <p>If any Fargate profiles in a cluster are in the <code>DELETING</code>
|
|
35
35
|
* status, you must wait for that Fargate profile to finish deleting before
|
|
36
36
|
* you can create any other profiles in that cluster.</p>
|
|
37
|
-
*
|
|
37
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html">Fargate Profile</a> in the
|
|
38
38
|
* <i>Amazon EKS User Guide</i>.</p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,11 +14,14 @@ export interface CreateNodegroupCommandOutput extends CreateNodegroupResponse, _
|
|
|
14
14
|
* respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using
|
|
15
15
|
* a launch template. For more information about using launch templates, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html">Launch
|
|
16
16
|
* template support</a>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>An Amazon EKS managed node group is an Amazon EC2
|
|
18
18
|
* Auto Scaling group and associated Amazon EC2 instances that are managed by
|
|
19
|
-
* Amazon Web Services for an Amazon EKS cluster.
|
|
20
|
-
*
|
|
21
|
-
*
|
|
19
|
+
* Amazon Web Services for an Amazon EKS cluster. For more information, see
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html">Managed node groups</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
21
|
+
* <note>
|
|
22
|
+
* <p>Windows AMI types are only supported for commercial Regions that support Windows
|
|
23
|
+
* Amazon EKS.</p>
|
|
24
|
+
* </note>
|
|
22
25
|
* @example
|
|
23
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
27
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteAddonCommandOutput extends DeleteAddonResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Delete an Amazon EKS add-on.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When you remove the add-on, it will also be deleted from the cluster. You can always
|
|
13
13
|
* manually start an add-on on the cluster using the Kubernetes API.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,12 +9,12 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the Amazon EKS cluster control plane.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you have active services in your cluster that are associated with a load balancer,
|
|
13
13
|
* you must delete those services before deleting the cluster so that the load balancers
|
|
14
14
|
* are deleted properly. Otherwise, you can have orphaned resources in your VPC that
|
|
15
15
|
* 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
|
|
16
16
|
* Cluster</a> in the <i>Amazon EKS User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you have managed node groups or Fargate profiles attached to the
|
|
18
18
|
* cluster, you must delete them first. For more information, see <a>DeleteNodegroup</a> and <a>DeleteFargateProfile</a>.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,11 +9,11 @@ export interface DeleteFargateProfileCommandOutput extends DeleteFargateProfileR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an Fargate profile.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match
|
|
13
13
|
* another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then
|
|
14
14
|
* they are not scheduled on Fargate and they may remain in a pending
|
|
15
15
|
* state.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>Only one Fargate profile in a cluster can be in the
|
|
17
17
|
* <code>DELETING</code> status at a time. You must wait for a Fargate
|
|
18
18
|
* profile to finish deleting before you can delete any other profiles in that
|
|
19
19
|
* cluster.</p>
|
|
@@ -9,14 +9,14 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns descriptive information about an Amazon EKS cluster.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The API server endpoint and certificate authority data returned by this operation are
|
|
13
13
|
* required for <code>kubelet</code> and <code>kubectl</code> to communicate with your
|
|
14
14
|
* Kubernetes API server. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html">Create a
|
|
15
15
|
* kubeconfig for Amazon EKS</a>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <p>The API server endpoint and certificate authority data aren't available until the
|
|
18
18
|
* cluster reaches the <code>ACTIVE</code> state.</p>
|
|
19
|
-
*
|
|
19
|
+
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DescribeUpdateCommandOutput extends DescribeUpdateResponse, __M
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns descriptive information about an update against your Amazon EKS
|
|
12
12
|
* cluster or associated managed node group or Amazon EKS add-on.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an
|
|
14
14
|
* update fails, the status is <code>Failed</code>, and an error detail explains the reason
|
|
15
15
|
* for the failure.</p>
|
|
16
16
|
* @example
|
|
@@ -9,17 +9,16 @@ export interface RegisterClusterCommandOutput extends RegisterClusterResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to
|
|
13
13
|
* view current information about the cluster and its nodes. </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Cluster connection requires two steps. First, send a <code>
|
|
15
15
|
* <a>RegisterClusterRequest</a>
|
|
16
16
|
* </code> to add it to the Amazon EKS
|
|
17
17
|
* control plane.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>Second, a <a href="https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml">Manifest</a> containing the <code>activationID</code> and
|
|
19
19
|
* <code>activationCode</code> must be applied to the Kubernetes cluster through it's
|
|
20
20
|
* native provider to provide visibility.</p>
|
|
21
|
-
*
|
|
22
|
-
* <p>After the Manifest is updated and applied, then the connected cluster is visible to
|
|
21
|
+
* <p>After the Manifest is updated and applied, then the connected cluster is visible to
|
|
23
22
|
* the Amazon EKS control plane. If the Manifest is not applied within three days,
|
|
24
23
|
* then the connected cluster will no longer be visible and must be deregistered. See <a>DeregisterCluster</a>.</p>
|
|
25
24
|
* @example
|
|
@@ -12,27 +12,27 @@ export interface UpdateClusterConfigCommandOutput extends UpdateClusterConfigRes
|
|
|
12
12
|
* function during the update. The response output includes an update ID that you can use
|
|
13
13
|
* to track the status of your cluster update with the <a>DescribeUpdate</a> API
|
|
14
14
|
* operation.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can use this API operation to enable or disable exporting the Kubernetes control
|
|
16
16
|
* plane logs for your cluster to CloudWatch Logs. By default, cluster control plane
|
|
17
17
|
* 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 Cluster Control Plane Logs</a> in the
|
|
18
18
|
* <i>
|
|
19
19
|
* <i>Amazon EKS User Guide</i>
|
|
20
20
|
* </i>.</p>
|
|
21
|
-
*
|
|
21
|
+
* <note>
|
|
22
22
|
* <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to
|
|
23
23
|
* exported control plane logs. For more information, see <a href="http://aws.amazon.com/cloudwatch/pricing/">CloudWatch
|
|
24
24
|
* Pricing</a>.</p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* </note>
|
|
26
|
+
* <p>You can also use this API operation to enable or disable public and private access to
|
|
27
27
|
* your cluster's Kubernetes API server endpoint. By default, public access is enabled, and
|
|
28
28
|
* private access is disabled. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html">Amazon EKS cluster endpoint access control</a> in the
|
|
29
29
|
* <i>
|
|
30
30
|
* <i>Amazon EKS User Guide</i>
|
|
31
31
|
* </i>. </p>
|
|
32
|
-
*
|
|
32
|
+
* <important>
|
|
33
33
|
* <p>You can't update the subnets or security group IDs for an existing cluster.</p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* </important>
|
|
35
|
+
* <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
|
|
36
36
|
* an update, the cluster status moves to <code>UPDATING</code> (this status transition is
|
|
37
37
|
* eventually consistent). When the update is complete (either <code>Failed</code> or
|
|
38
38
|
* <code>Successful</code>), the cluster status moves to <code>Active</code>.</p>
|
|
@@ -11,11 +11,11 @@ export interface UpdateClusterVersionCommandOutput extends UpdateClusterVersionR
|
|
|
11
11
|
* <p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your
|
|
12
12
|
* cluster continues to function during the update. The response output includes an update
|
|
13
13
|
* ID that you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Cluster updates are asynchronous, and they should finish within a few minutes. During
|
|
15
15
|
* an update, the cluster status moves to <code>UPDATING</code> (this status transition is
|
|
16
16
|
* eventually consistent). When the update is complete (either <code>Failed</code> or
|
|
17
17
|
* <code>Successful</code>), the cluster status moves to <code>Active</code>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If your cluster has managed node groups attached to it, all of your node groups’
|
|
19
19
|
* Kubernetes versions must match the cluster’s Kubernetes version in order to update the
|
|
20
20
|
* cluster to a new Kubernetes version.</p>
|
|
21
21
|
* @example
|