@aws-sdk/client-eks 3.379.1 → 3.382.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.
@@ -39,14 +39,17 @@ export type AddonIssueCode = (typeof AddonIssueCode)[keyof typeof AddonIssueCode
39
39
  */
40
40
  export interface AddonIssue {
41
41
  /**
42
+ * @public
42
43
  * <p>A code that describes the type of issue.</p>
43
44
  */
44
45
  code?: AddonIssueCode | string;
45
46
  /**
47
+ * @public
46
48
  * <p>A message that provides details about the issue and what might cause it.</p>
47
49
  */
48
50
  message?: string;
49
51
  /**
52
+ * @public
50
53
  * <p>The resource IDs of the issue.</p>
51
54
  */
52
55
  resourceIds?: string[];
@@ -57,6 +60,7 @@ export interface AddonIssue {
57
60
  */
58
61
  export interface AddonHealth {
59
62
  /**
63
+ * @public
60
64
  * <p>An object representing the health issues for an add-on.</p>
61
65
  */
62
66
  issues?: AddonIssue[];
@@ -67,10 +71,12 @@ export interface AddonHealth {
67
71
  */
68
72
  export interface MarketplaceInformation {
69
73
  /**
74
+ * @public
70
75
  * <p>The product ID from the Amazon Web Services Marketplace.</p>
71
76
  */
72
77
  productId?: string;
73
78
  /**
79
+ * @public
74
80
  * <p>The product URL from the Amazon Web Services Marketplace.</p>
75
81
  */
76
82
  productUrl?: string;
@@ -100,61 +106,75 @@ export type AddonStatus = (typeof AddonStatus)[keyof typeof AddonStatus];
100
106
  */
101
107
  export interface Addon {
102
108
  /**
109
+ * @public
103
110
  * <p>The name of the add-on.</p>
104
111
  */
105
112
  addonName?: string;
106
113
  /**
114
+ * @public
107
115
  * <p>The name of the cluster.</p>
108
116
  */
109
117
  clusterName?: string;
110
118
  /**
119
+ * @public
111
120
  * <p>The status of the add-on.</p>
112
121
  */
113
122
  status?: AddonStatus | string;
114
123
  /**
124
+ * @public
115
125
  * <p>The version of the add-on.</p>
116
126
  */
117
127
  addonVersion?: string;
118
128
  /**
129
+ * @public
119
130
  * <p>An object that represents the health of the add-on.</p>
120
131
  */
121
132
  health?: AddonHealth;
122
133
  /**
134
+ * @public
123
135
  * <p>The Amazon Resource Name (ARN) of the add-on.</p>
124
136
  */
125
137
  addonArn?: string;
126
138
  /**
139
+ * @public
127
140
  * <p>The date and time that the add-on was created.</p>
128
141
  */
129
142
  createdAt?: Date;
130
143
  /**
144
+ * @public
131
145
  * <p>The date and time that the add-on was last modified.</p>
132
146
  */
133
147
  modifiedAt?: Date;
134
148
  /**
149
+ * @public
135
150
  * <p>The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes service account
136
151
  * that the add-on uses.</p>
137
152
  */
138
153
  serviceAccountRoleArn?: string;
139
154
  /**
155
+ * @public
140
156
  * <p>The metadata that you apply to the add-on to assist with categorization and
141
157
  * organization. Each tag consists of a key and an optional value. You define both. Add-on
142
158
  * tags do not propagate to any other resources associated with the cluster. </p>
143
159
  */
144
160
  tags?: Record<string, string>;
145
161
  /**
162
+ * @public
146
163
  * <p>The publisher of the add-on.</p>
147
164
  */
148
165
  publisher?: string;
149
166
  /**
167
+ * @public
150
168
  * <p>The owner of the add-on.</p>
151
169
  */
152
170
  owner?: string;
153
171
  /**
172
+ * @public
154
173
  * <p>Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.</p>
155
174
  */
156
175
  marketplaceInformation?: MarketplaceInformation;
157
176
  /**
177
+ * @public
158
178
  * <p>The configuration values that you provided.</p>
159
179
  */
160
180
  configurationValues?: string;
@@ -165,14 +185,17 @@ export interface Addon {
165
185
  */
166
186
  export interface Compatibility {
167
187
  /**
188
+ * @public
168
189
  * <p>The supported Kubernetes version of the cluster.</p>
169
190
  */
170
191
  clusterVersion?: string;
171
192
  /**
193
+ * @public
172
194
  * <p>The supported compute platform.</p>
173
195
  */
174
196
  platformVersions?: string[];
175
197
  /**
198
+ * @public
176
199
  * <p>The supported default version.</p>
177
200
  */
178
201
  defaultVersion?: boolean;
@@ -183,18 +206,22 @@ export interface Compatibility {
183
206
  */
184
207
  export interface AddonVersionInfo {
185
208
  /**
209
+ * @public
186
210
  * <p>The version of the add-on.</p>
187
211
  */
188
212
  addonVersion?: string;
189
213
  /**
214
+ * @public
190
215
  * <p>The architectures that the version supports.</p>
191
216
  */
192
217
  architecture?: string[];
193
218
  /**
219
+ * @public
194
220
  * <p>An object representing the compatibilities of a version.</p>
195
221
  */
196
222
  compatibilities?: Compatibility[];
197
223
  /**
224
+ * @public
198
225
  * <p>Whether the add-on requires configuration.</p>
199
226
  */
200
227
  requiresConfiguration?: boolean;
@@ -205,27 +232,33 @@ export interface AddonVersionInfo {
205
232
  */
206
233
  export interface AddonInfo {
207
234
  /**
235
+ * @public
208
236
  * <p>The name of the add-on.</p>
209
237
  */
210
238
  addonName?: string;
211
239
  /**
240
+ * @public
212
241
  * <p>The type of the add-on.</p>
213
242
  */
214
243
  type?: string;
215
244
  /**
245
+ * @public
216
246
  * <p>An object representing information about available add-on versions and compatible
217
247
  * Kubernetes versions.</p>
218
248
  */
219
249
  addonVersions?: AddonVersionInfo[];
220
250
  /**
251
+ * @public
221
252
  * <p>The publisher of the add-on.</p>
222
253
  */
223
254
  publisher?: string;
224
255
  /**
256
+ * @public
225
257
  * <p>The owner of the add-on.</p>
226
258
  */
227
259
  owner?: string;
228
260
  /**
261
+ * @public
229
262
  * <p>Information about the add-on from the Amazon Web Services Marketplace.</p>
230
263
  */
231
264
  marketplaceInformation?: MarketplaceInformation;
@@ -259,6 +292,7 @@ export type AMITypes = (typeof AMITypes)[keyof typeof AMITypes];
259
292
  */
260
293
  export interface Provider {
261
294
  /**
295
+ * @public
262
296
  * <p>Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same
263
297
  * region as the cluster, and if the KMS key was created in a different account, the user
264
298
  * must have access to the KMS key. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html">Allowing
@@ -272,10 +306,12 @@ export interface Provider {
272
306
  */
273
307
  export interface EncryptionConfig {
274
308
  /**
309
+ * @public
275
310
  * <p>Specifies the resources to be encrypted. The only supported value is "secrets".</p>
276
311
  */
277
312
  resources?: string[];
278
313
  /**
314
+ * @public
279
315
  * <p>Key Management Service (KMS) key. Either the ARN or the alias can be
280
316
  * used.</p>
281
317
  */
@@ -286,14 +322,17 @@ export interface EncryptionConfig {
286
322
  */
287
323
  export interface AssociateEncryptionConfigRequest {
288
324
  /**
325
+ * @public
289
326
  * <p>The name of the cluster that you are associating with encryption configuration.</p>
290
327
  */
291
328
  clusterName: string | undefined;
292
329
  /**
330
+ * @public
293
331
  * <p>The configuration you are using for encryption.</p>
294
332
  */
295
333
  encryptionConfig: EncryptionConfig[] | undefined;
296
334
  /**
335
+ * @public
297
336
  * <p>The client request token you are using with the encryption configuration.</p>
298
337
  */
299
338
  clientRequestToken?: string;
@@ -331,6 +370,7 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
331
370
  */
332
371
  export interface ErrorDetail {
333
372
  /**
373
+ * @public
334
374
  * <p>A brief description of the error. </p>
335
375
  * <ul>
336
376
  * <li>
@@ -373,10 +413,12 @@ export interface ErrorDetail {
373
413
  */
374
414
  errorCode?: ErrorCode | string;
375
415
  /**
416
+ * @public
376
417
  * <p>A more complete description of the error.</p>
377
418
  */
378
419
  errorMessage?: string;
379
420
  /**
421
+ * @public
380
422
  * <p>An optional field that contains the resource IDs associated with the error.</p>
381
423
  */
382
424
  resourceIds?: string[];
@@ -420,10 +462,12 @@ export type UpdateParamType = (typeof UpdateParamType)[keyof typeof UpdateParamT
420
462
  */
421
463
  export interface UpdateParam {
422
464
  /**
465
+ * @public
423
466
  * <p>The keys associated with an update request.</p>
424
467
  */
425
468
  type?: UpdateParamType | string;
426
469
  /**
470
+ * @public
427
471
  * <p>The value of the keys submitted as part of an update request.</p>
428
472
  */
429
473
  value?: string;
@@ -466,26 +510,32 @@ export type UpdateType = (typeof UpdateType)[keyof typeof UpdateType];
466
510
  */
467
511
  export interface Update {
468
512
  /**
513
+ * @public
469
514
  * <p>A UUID that is used to track the update.</p>
470
515
  */
471
516
  id?: string;
472
517
  /**
518
+ * @public
473
519
  * <p>The current status of the update.</p>
474
520
  */
475
521
  status?: UpdateStatus | string;
476
522
  /**
523
+ * @public
477
524
  * <p>The type of the update.</p>
478
525
  */
479
526
  type?: UpdateType | string;
480
527
  /**
528
+ * @public
481
529
  * <p>A key-value map that contains the parameters associated with the update.</p>
482
530
  */
483
531
  params?: UpdateParam[];
484
532
  /**
533
+ * @public
485
534
  * <p>The Unix epoch timestamp in seconds for when the update was created.</p>
486
535
  */
487
536
  createdAt?: Date;
488
537
  /**
538
+ * @public
489
539
  * <p>Any errors associated with a <code>Failed</code> update.</p>
490
540
  */
491
541
  errors?: ErrorDetail[];
@@ -495,6 +545,7 @@ export interface Update {
495
545
  */
496
546
  export interface AssociateEncryptionConfigResponse {
497
547
  /**
548
+ * @public
498
549
  * <p>An object representing an asynchronous update.</p>
499
550
  */
500
551
  update?: Update;
@@ -509,10 +560,12 @@ export declare class ClientException extends __BaseException {
509
560
  readonly name: "ClientException";
510
561
  readonly $fault: "client";
511
562
  /**
563
+ * @public
512
564
  * <p>The Amazon EKS cluster associated with the exception.</p>
513
565
  */
514
566
  clusterName?: string;
515
567
  /**
568
+ * @public
516
569
  * <p>The Amazon EKS managed node group associated with the exception.</p>
517
570
  */
518
571
  nodegroupName?: string;
@@ -531,14 +584,17 @@ export declare class InvalidParameterException extends __BaseException {
531
584
  readonly name: "InvalidParameterException";
532
585
  readonly $fault: "client";
533
586
  /**
587
+ * @public
534
588
  * <p>The Amazon EKS cluster associated with the exception.</p>
535
589
  */
536
590
  clusterName?: string;
537
591
  /**
592
+ * @public
538
593
  * <p>The Amazon EKS managed node group associated with the exception.</p>
539
594
  */
540
595
  nodegroupName?: string;
541
596
  /**
597
+ * @public
542
598
  * <p>The Fargate profile associated with the exception.</p>
543
599
  */
544
600
  fargateProfileName?: string;
@@ -557,10 +613,12 @@ export declare class InvalidRequestException extends __BaseException {
557
613
  readonly name: "InvalidRequestException";
558
614
  readonly $fault: "client";
559
615
  /**
616
+ * @public
560
617
  * <p>The Amazon EKS cluster associated with the exception.</p>
561
618
  */
562
619
  clusterName?: string;
563
620
  /**
621
+ * @public
564
622
  * <p>The Amazon EKS managed node group associated with the exception.</p>
565
623
  */
566
624
  nodegroupName?: string;
@@ -578,10 +636,12 @@ export declare class ResourceInUseException extends __BaseException {
578
636
  readonly name: "ResourceInUseException";
579
637
  readonly $fault: "client";
580
638
  /**
639
+ * @public
581
640
  * <p>The Amazon EKS cluster associated with the exception.</p>
582
641
  */
583
642
  clusterName?: string;
584
643
  /**
644
+ * @public
585
645
  * <p>The Amazon EKS managed node group associated with the exception.</p>
586
646
  */
587
647
  nodegroupName?: string;
@@ -602,14 +662,17 @@ export declare class ResourceNotFoundException extends __BaseException {
602
662
  readonly name: "ResourceNotFoundException";
603
663
  readonly $fault: "client";
604
664
  /**
665
+ * @public
605
666
  * <p>The Amazon EKS cluster associated with the exception.</p>
606
667
  */
607
668
  clusterName?: string;
608
669
  /**
670
+ * @public
609
671
  * <p>The Amazon EKS managed node group associated with the exception.</p>
610
672
  */
611
673
  nodegroupName?: string;
612
674
  /**
675
+ * @public
613
676
  * <p>The Fargate profile associated with the exception.</p>
614
677
  */
615
678
  fargateProfileName?: string;
@@ -627,10 +690,12 @@ export declare class ServerException extends __BaseException {
627
690
  readonly name: "ServerException";
628
691
  readonly $fault: "server";
629
692
  /**
693
+ * @public
630
694
  * <p>The Amazon EKS cluster associated with the exception.</p>
631
695
  */
632
696
  clusterName?: string;
633
697
  /**
698
+ * @public
634
699
  * <p>The Amazon EKS managed node group associated with the exception.</p>
635
700
  */
636
701
  nodegroupName?: string;
@@ -649,10 +714,12 @@ export declare class ServerException extends __BaseException {
649
714
  */
650
715
  export interface OidcIdentityProviderConfigRequest {
651
716
  /**
717
+ * @public
652
718
  * <p>The name of the OIDC provider configuration.</p>
653
719
  */
654
720
  identityProviderConfigName: string | undefined;
655
721
  /**
722
+ * @public
656
723
  * <p>The URL of the OpenID identity provider that allows the API server to discover public
657
724
  * signing keys for verifying tokens. The URL must begin with <code>https://</code> and
658
725
  * should correspond to the <code>iss</code> claim in the provider's OIDC ID tokens. Per
@@ -664,11 +731,13 @@ export interface OidcIdentityProviderConfigRequest {
664
731
  */
665
732
  issuerUrl: string | undefined;
666
733
  /**
734
+ * @public
667
735
  * <p>This is also known as <i>audience</i>. The ID for the client application
668
736
  * that makes authentication requests to the OpenID identity provider.</p>
669
737
  */
670
738
  clientId: string | undefined;
671
739
  /**
740
+ * @public
672
741
  * <p>The JSON Web Token (JWT) claim to use as the username. The default is
673
742
  * <code>sub</code>, which is expected to be a unique identifier of the end user. You can
674
743
  * choose other claims, such as <code>email</code> or <code>name</code>, depending on the
@@ -677,6 +746,7 @@ export interface OidcIdentityProviderConfigRequest {
677
746
  */
678
747
  usernameClaim?: string;
679
748
  /**
749
+ * @public
680
750
  * <p>The prefix that is prepended to username claims to prevent clashes with existing
681
751
  * names. If you do not provide this field, and <code>username</code> is a value other than
682
752
  * <code>email</code>, the prefix defaults to <code>issuerurl#</code>. You can use the
@@ -684,10 +754,12 @@ export interface OidcIdentityProviderConfigRequest {
684
754
  */
685
755
  usernamePrefix?: string;
686
756
  /**
757
+ * @public
687
758
  * <p>The JWT claim that the provider uses to return your groups.</p>
688
759
  */
689
760
  groupsClaim?: string;
690
761
  /**
762
+ * @public
691
763
  * <p>The prefix that is prepended to group claims to prevent clashes with existing names
692
764
  * (such as <code>system:</code> groups). For example, the value<code> oidc:</code> will
693
765
  * create group names like <code>oidc:engineering</code> and
@@ -695,6 +767,7 @@ export interface OidcIdentityProviderConfigRequest {
695
767
  */
696
768
  groupsPrefix?: string;
697
769
  /**
770
+ * @public
698
771
  * <p>The key value pairs that describe required claims in the identity token. If set, each
699
772
  * claim is verified to be present in the token with a matching value. For the maximum
700
773
  * number of claims that you can require, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html">Amazon EKS service
@@ -707,20 +780,24 @@ export interface OidcIdentityProviderConfigRequest {
707
780
  */
708
781
  export interface AssociateIdentityProviderConfigRequest {
709
782
  /**
783
+ * @public
710
784
  * <p>The name of the cluster to associate the configuration to.</p>
711
785
  */
712
786
  clusterName: string | undefined;
713
787
  /**
788
+ * @public
714
789
  * <p>An object representing an OpenID Connect (OIDC) identity provider
715
790
  * configuration.</p>
716
791
  */
717
792
  oidc: OidcIdentityProviderConfigRequest | undefined;
718
793
  /**
794
+ * @public
719
795
  * <p>The metadata to apply to the configuration to assist with categorization and
720
796
  * organization. Each tag consists of a key and an optional value. You define both.</p>
721
797
  */
722
798
  tags?: Record<string, string>;
723
799
  /**
800
+ * @public
724
801
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
725
802
  * request.</p>
726
803
  */
@@ -731,10 +808,12 @@ export interface AssociateIdentityProviderConfigRequest {
731
808
  */
732
809
  export interface AssociateIdentityProviderConfigResponse {
733
810
  /**
811
+ * @public
734
812
  * <p>An object representing an asynchronous update.</p>
735
813
  */
736
814
  update?: Update;
737
815
  /**
816
+ * @public
738
817
  * <p>The tags for the resource.</p>
739
818
  */
740
819
  tags?: Record<string, string>;
@@ -746,6 +825,7 @@ export interface AssociateIdentityProviderConfigResponse {
746
825
  */
747
826
  export interface AutoScalingGroup {
748
827
  /**
828
+ * @public
749
829
  * <p>The name of the Auto Scaling group associated with an Amazon EKS managed node
750
830
  * group.</p>
751
831
  */
@@ -769,22 +849,26 @@ export type ResolveConflicts = (typeof ResolveConflicts)[keyof typeof ResolveCon
769
849
  */
770
850
  export interface CreateAddonRequest {
771
851
  /**
852
+ * @public
772
853
  * <p>The name of the cluster to create the add-on for.</p>
773
854
  */
774
855
  clusterName: string | undefined;
775
856
  /**
857
+ * @public
776
858
  * <p>The name of the add-on. The name must match one of the names that <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
777
859
  * <code>DescribeAddonVersions</code>
778
860
  * </a> returns.</p>
779
861
  */
780
862
  addonName: string | undefined;
781
863
  /**
864
+ * @public
782
865
  * <p>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
783
866
  * <code>DescribeAddonVersions</code>
784
867
  * </a>.</p>
785
868
  */
786
869
  addonVersion?: string;
787
870
  /**
871
+ * @public
788
872
  * <p>The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the
789
873
  * permissions assigned to the node IAM role. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the <i>Amazon EKS User Guide</i>.</p>
790
874
  * <note>
@@ -796,6 +880,7 @@ export interface CreateAddonRequest {
796
880
  */
797
881
  serviceAccountRoleArn?: string;
798
882
  /**
883
+ * @public
799
884
  * <p>How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are
800
885
  * handled based on the value you choose:</p>
801
886
  * <ul>
@@ -824,16 +909,19 @@ export interface CreateAddonRequest {
824
909
  */
825
910
  resolveConflicts?: ResolveConflicts | string;
826
911
  /**
912
+ * @public
827
913
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
828
914
  * request.</p>
829
915
  */
830
916
  clientRequestToken?: string;
831
917
  /**
918
+ * @public
832
919
  * <p>The metadata to apply to the cluster to assist with categorization and organization.
833
920
  * Each tag consists of a key and an optional value. You define both.</p>
834
921
  */
835
922
  tags?: Record<string, string>;
836
923
  /**
924
+ * @public
837
925
  * <p>The set of configuration values for the add-on that's created. The values that you
838
926
  * provide are validated against the schema in <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html">
839
927
  * <code>DescribeAddonConfiguration</code>
@@ -846,6 +934,7 @@ export interface CreateAddonRequest {
846
934
  */
847
935
  export interface CreateAddonResponse {
848
936
  /**
937
+ * @public
849
938
  * <p>An Amazon EKS add-on. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in
850
939
  * the <i>Amazon EKS User Guide</i>.</p>
851
940
  */
@@ -869,6 +958,7 @@ export type IpFamily = (typeof IpFamily)[keyof typeof IpFamily];
869
958
  */
870
959
  export interface KubernetesNetworkConfigRequest {
871
960
  /**
961
+ * @public
872
962
  * <p>Don't specify a value if you select <code>ipv6</code> for <b>ipFamily</b>. The CIDR block to assign Kubernetes service IP addresses from.
873
963
  * If you don't specify a block, Kubernetes assigns addresses from either the <code>10.100.0.0/16</code>
874
964
  * or <code>172.20.0.0/16</code> CIDR blocks. We recommend that you specify a block that does not
@@ -894,6 +984,7 @@ export interface KubernetesNetworkConfigRequest {
894
984
  */
895
985
  serviceIpv4Cidr?: string;
896
986
  /**
987
+ * @public
897
988
  * <p>Specify which IP family is used to assign Kubernetes pod and service IP addresses. If
898
989
  * you don't specify a value, <code>ipv4</code> is used by default. You can only specify an
899
990
  * IP family when you create a cluster and can't change this value once the cluster is
@@ -932,10 +1023,12 @@ export type LogType = (typeof LogType)[keyof typeof LogType];
932
1023
  */
933
1024
  export interface LogSetup {
934
1025
  /**
1026
+ * @public
935
1027
  * <p>The available cluster control plane log types.</p>
936
1028
  */
937
1029
  types?: (LogType | string)[];
938
1030
  /**
1031
+ * @public
939
1032
  * <p>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
940
1033
  * plane logs. Each individual log type can be enabled or disabled independently.</p>
941
1034
  */
@@ -947,6 +1040,7 @@ export interface LogSetup {
947
1040
  */
948
1041
  export interface Logging {
949
1042
  /**
1043
+ * @public
950
1044
  * <p>The cluster control plane logging configuration for your cluster.</p>
951
1045
  */
952
1046
  clusterLogging?: LogSetup[];
@@ -960,6 +1054,7 @@ export interface Logging {
960
1054
  */
961
1055
  export interface ControlPlanePlacementRequest {
962
1056
  /**
1057
+ * @public
963
1058
  * <p>The name of the placement group for the Kubernetes control plane instances. This
964
1059
  * setting can't be changed after cluster creation. </p>
965
1060
  */
@@ -974,11 +1069,13 @@ export interface ControlPlanePlacementRequest {
974
1069
  */
975
1070
  export interface OutpostConfigRequest {
976
1071
  /**
1072
+ * @public
977
1073
  * <p>The ARN of the Outpost that you want to use for your local Amazon EKS
978
1074
  * cluster on Outposts. Only a single Outpost ARN is supported.</p>
979
1075
  */
980
1076
  outpostArns: string[] | undefined;
981
1077
  /**
1078
+ * @public
982
1079
  * <p>The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes
983
1080
  * that your cluster will have. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html">Capacity
984
1081
  * considerations</a> in the <i>Amazon EKS User Guide</i>.</p>
@@ -989,6 +1086,7 @@ export interface OutpostConfigRequest {
989
1086
  */
990
1087
  controlPlaneInstanceType: string | undefined;
991
1088
  /**
1089
+ * @public
992
1090
  * <p>An object representing the placement configuration for all the control plane instances
993
1091
  * of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more
994
1092
  * information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html">Capacity considerations</a> in the <i>Amazon EKS User Guide</i>.</p>
@@ -1002,12 +1100,14 @@ export interface OutpostConfigRequest {
1002
1100
  */
1003
1101
  export interface VpcConfigRequest {
1004
1102
  /**
1103
+ * @public
1005
1104
  * <p>Specify subnets for your Amazon EKS nodes. Amazon EKS creates
1006
1105
  * cross-account elastic network interfaces in these subnets to allow communication between
1007
1106
  * your nodes and the Kubernetes control plane.</p>
1008
1107
  */
1009
1108
  subnetIds?: string[];
1010
1109
  /**
1110
+ * @public
1011
1111
  * <p>Specify one or more security groups for the cross-account elastic network interfaces
1012
1112
  * that Amazon EKS creates to use that allow communication between your nodes and
1013
1113
  * the Kubernetes control plane. If you don't specify any security groups, then familiarize
@@ -1019,6 +1119,7 @@ export interface VpcConfigRequest {
1019
1119
  */
1020
1120
  securityGroupIds?: string[];
1021
1121
  /**
1122
+ * @public
1022
1123
  * <p>Set this value to <code>false</code> to disable public access to your cluster's
1023
1124
  * Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes
1024
1125
  * API server can only receive requests from within the cluster VPC. The default value for
@@ -1030,6 +1131,7 @@ export interface VpcConfigRequest {
1030
1131
  */
1031
1132
  endpointPublicAccess?: boolean;
1032
1133
  /**
1134
+ * @public
1033
1135
  * <p>Set this value to <code>true</code> to enable private access for your cluster's
1034
1136
  * Kubernetes API server endpoint. If you enable private access, Kubernetes API requests
1035
1137
  * from within your cluster's VPC use the private VPC endpoint. The default value for this
@@ -1044,6 +1146,7 @@ export interface VpcConfigRequest {
1044
1146
  */
1045
1147
  endpointPrivateAccess?: boolean;
1046
1148
  /**
1149
+ * @public
1047
1150
  * <p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server
1048
1151
  * endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that
1049
1152
  * you specify is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled
@@ -1061,10 +1164,12 @@ export interface VpcConfigRequest {
1061
1164
  */
1062
1165
  export interface CreateClusterRequest {
1063
1166
  /**
1167
+ * @public
1064
1168
  * <p>The unique name to give to your cluster.</p>
1065
1169
  */
1066
1170
  name: string | undefined;
1067
1171
  /**
1172
+ * @public
1068
1173
  * <p>The desired Kubernetes version for your cluster. If you don't specify a value here,
1069
1174
  * the default version available in Amazon EKS is used.</p>
1070
1175
  * <note>
@@ -1073,6 +1178,7 @@ export interface CreateClusterRequest {
1073
1178
  */
1074
1179
  version?: string;
1075
1180
  /**
1181
+ * @public
1076
1182
  * <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the
1077
1183
  * Kubernetes control plane to make calls to Amazon Web Services API operations on your
1078
1184
  * behalf. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html">Amazon EKS Service IAM Role</a> in the <i>
@@ -1081,6 +1187,7 @@ export interface CreateClusterRequest {
1081
1187
  */
1082
1188
  roleArn: string | undefined;
1083
1189
  /**
1190
+ * @public
1084
1191
  * <p>The VPC configuration that's used by the cluster control plane. Amazon EKS VPC
1085
1192
  * resources have specific requirements to work properly with Kubernetes. For more
1086
1193
  * information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">Cluster VPC Considerations</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html">Cluster Security
@@ -1090,10 +1197,12 @@ export interface CreateClusterRequest {
1090
1197
  */
1091
1198
  resourcesVpcConfig: VpcConfigRequest | undefined;
1092
1199
  /**
1200
+ * @public
1093
1201
  * <p>The Kubernetes network configuration for the cluster.</p>
1094
1202
  */
1095
1203
  kubernetesNetworkConfig?: KubernetesNetworkConfigRequest;
1096
1204
  /**
1205
+ * @public
1097
1206
  * <p>Enable or disable exporting the Kubernetes control plane logs for your cluster to
1098
1207
  * CloudWatch Logs. By default, cluster control plane logs aren't exported to
1099
1208
  * 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
@@ -1108,20 +1217,24 @@ export interface CreateClusterRequest {
1108
1217
  */
1109
1218
  logging?: Logging;
1110
1219
  /**
1220
+ * @public
1111
1221
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1112
1222
  * request.</p>
1113
1223
  */
1114
1224
  clientRequestToken?: string;
1115
1225
  /**
1226
+ * @public
1116
1227
  * <p>The metadata to apply to the cluster to assist with categorization and organization.
1117
1228
  * Each tag consists of a key and an optional value. You define both.</p>
1118
1229
  */
1119
1230
  tags?: Record<string, string>;
1120
1231
  /**
1232
+ * @public
1121
1233
  * <p>The encryption configuration for the cluster.</p>
1122
1234
  */
1123
1235
  encryptionConfig?: EncryptionConfig[];
1124
1236
  /**
1237
+ * @public
1125
1238
  * <p>An object representing the configuration of your local Amazon EKS cluster on
1126
1239
  * an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review
1127
1240
  * <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html">Local clusters
@@ -1138,6 +1251,7 @@ export interface CreateClusterRequest {
1138
1251
  */
1139
1252
  export interface Certificate {
1140
1253
  /**
1254
+ * @public
1141
1255
  * <p>The Base64-encoded certificate data required to communicate with your cluster. Add
1142
1256
  * this to the <code>certificate-authority-data</code> section of the
1143
1257
  * <code>kubeconfig</code> file for your cluster.</p>
@@ -1150,23 +1264,28 @@ export interface Certificate {
1150
1264
  */
1151
1265
  export interface ConnectorConfigResponse {
1152
1266
  /**
1267
+ * @public
1153
1268
  * <p>A unique ID associated with the cluster for registration purposes.</p>
1154
1269
  */
1155
1270
  activationId?: string;
1156
1271
  /**
1272
+ * @public
1157
1273
  * <p>A unique code associated with the cluster for registration purposes.</p>
1158
1274
  */
1159
1275
  activationCode?: string;
1160
1276
  /**
1277
+ * @public
1161
1278
  * <p>The expiration time of the connected cluster. The cluster's YAML file must be applied
1162
1279
  * through the native provider.</p>
1163
1280
  */
1164
1281
  activationExpiry?: Date;
1165
1282
  /**
1283
+ * @public
1166
1284
  * <p>The cluster's cloud service provider.</p>
1167
1285
  */
1168
1286
  provider?: string;
1169
1287
  /**
1288
+ * @public
1170
1289
  * <p>The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes
1171
1290
  * cluster.</p>
1172
1291
  */
@@ -1196,14 +1315,17 @@ export type ClusterIssueCode = (typeof ClusterIssueCode)[keyof typeof ClusterIss
1196
1315
  */
1197
1316
  export interface ClusterIssue {
1198
1317
  /**
1318
+ * @public
1199
1319
  * <p>The error code of the issue.</p>
1200
1320
  */
1201
1321
  code?: ClusterIssueCode | string;
1202
1322
  /**
1323
+ * @public
1203
1324
  * <p>A description of the issue.</p>
1204
1325
  */
1205
1326
  message?: string;
1206
1327
  /**
1328
+ * @public
1207
1329
  * <p>The resource IDs that the issue relates to.</p>
1208
1330
  */
1209
1331
  resourceIds?: string[];
@@ -1216,6 +1338,7 @@ export interface ClusterIssue {
1216
1338
  */
1217
1339
  export interface ClusterHealth {
1218
1340
  /**
1341
+ * @public
1219
1342
  * <p>An object representing the health issues of your local Amazon EKS cluster on
1220
1343
  * an Amazon Web Services Outpost.</p>
1221
1344
  */
@@ -1228,6 +1351,7 @@ export interface ClusterHealth {
1228
1351
  */
1229
1352
  export interface OIDC {
1230
1353
  /**
1354
+ * @public
1231
1355
  * <p>The issuer URL for the OIDC identity provider.</p>
1232
1356
  */
1233
1357
  issuer?: string;
@@ -1238,6 +1362,7 @@ export interface OIDC {
1238
1362
  */
1239
1363
  export interface Identity {
1240
1364
  /**
1365
+ * @public
1241
1366
  * <p>An object representing the <a href="https://openid.net/connect/">OpenID
1242
1367
  * Connect</a> identity provider information.</p>
1243
1368
  */
@@ -1250,6 +1375,7 @@ export interface Identity {
1250
1375
  */
1251
1376
  export interface KubernetesNetworkConfigResponse {
1252
1377
  /**
1378
+ * @public
1253
1379
  * <p>The CIDR block that Kubernetes pod and service IP addresses are assigned from. Kubernetes
1254
1380
  * assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If
1255
1381
  * you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns
@@ -1259,6 +1385,7 @@ export interface KubernetesNetworkConfigResponse {
1259
1385
  */
1260
1386
  serviceIpv4Cidr?: string;
1261
1387
  /**
1388
+ * @public
1262
1389
  * <p>The CIDR block that Kubernetes pod and service IP addresses are assigned from if you
1263
1390
  * created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and
1264
1391
  * specified <code>ipv6</code> for <b>ipFamily</b> when you
@@ -1268,6 +1395,7 @@ export interface KubernetesNetworkConfigResponse {
1268
1395
  */
1269
1396
  serviceIpv6Cidr?: string;
1270
1397
  /**
1398
+ * @public
1271
1399
  * <p>The IP family used to assign Kubernetes pod and service IP addresses. The IP family is
1272
1400
  * always <code>ipv4</code>, unless you have a <code>1.21</code> or later cluster running
1273
1401
  * version 1.10.1 or later of the Amazon VPC CNI add-on and specified <code>ipv6</code> when you
@@ -1282,6 +1410,7 @@ export interface KubernetesNetworkConfigResponse {
1282
1410
  */
1283
1411
  export interface ControlPlanePlacementResponse {
1284
1412
  /**
1413
+ * @public
1285
1414
  * <p>The name of the placement group for the Kubernetes control plane instances.</p>
1286
1415
  */
1287
1416
  groupName?: string;
@@ -1294,16 +1423,19 @@ export interface ControlPlanePlacementResponse {
1294
1423
  */
1295
1424
  export interface OutpostConfigResponse {
1296
1425
  /**
1426
+ * @public
1297
1427
  * <p>The ARN of the Outpost that you specified for use with your local Amazon EKS
1298
1428
  * cluster on Outposts.</p>
1299
1429
  */
1300
1430
  outpostArns: string[] | undefined;
1301
1431
  /**
1432
+ * @public
1302
1433
  * <p>The Amazon EC2 instance type used for the control plane. The instance type is
1303
1434
  * the same for all control plane instances.</p>
1304
1435
  */
1305
1436
  controlPlaneInstanceType: string | undefined;
1306
1437
  /**
1438
+ * @public
1307
1439
  * <p>An object representing the placement configuration for all the control plane instances
1308
1440
  * of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more
1309
1441
  * information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html">Capacity
@@ -1318,26 +1450,31 @@ export interface OutpostConfigResponse {
1318
1450
  */
1319
1451
  export interface VpcConfigResponse {
1320
1452
  /**
1453
+ * @public
1321
1454
  * <p>The subnets associated with your cluster.</p>
1322
1455
  */
1323
1456
  subnetIds?: string[];
1324
1457
  /**
1458
+ * @public
1325
1459
  * <p>The security groups associated with the cross-account elastic network interfaces that
1326
1460
  * are used to allow communication between your nodes and the Kubernetes control
1327
1461
  * plane.</p>
1328
1462
  */
1329
1463
  securityGroupIds?: string[];
1330
1464
  /**
1465
+ * @public
1331
1466
  * <p>The cluster security group that was created by Amazon EKS for the cluster.
1332
1467
  * Managed node groups use this security group for control-plane-to-data-plane
1333
1468
  * communication.</p>
1334
1469
  */
1335
1470
  clusterSecurityGroupId?: string;
1336
1471
  /**
1472
+ * @public
1337
1473
  * <p>The VPC associated with your cluster.</p>
1338
1474
  */
1339
1475
  vpcId?: string;
1340
1476
  /**
1477
+ * @public
1341
1478
  * <p>This parameter indicates whether the Amazon EKS public API server endpoint is
1342
1479
  * enabled. If the Amazon EKS public API server endpoint is disabled, your
1343
1480
  * cluster's Kubernetes API server can only receive requests that originate from within the
@@ -1345,6 +1482,7 @@ export interface VpcConfigResponse {
1345
1482
  */
1346
1483
  endpointPublicAccess?: boolean;
1347
1484
  /**
1485
+ * @public
1348
1486
  * <p>This parameter indicates whether the Amazon EKS private API server endpoint is
1349
1487
  * enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes
1350
1488
  * API requests that originate from within your cluster's VPC use the private VPC endpoint
@@ -1358,6 +1496,7 @@ export interface VpcConfigResponse {
1358
1496
  */
1359
1497
  endpointPrivateAccess?: boolean;
1360
1498
  /**
1499
+ * @public
1361
1500
  * <p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server
1362
1501
  * endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks
1363
1502
  * is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private
@@ -1391,32 +1530,39 @@ export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
1391
1530
  */
1392
1531
  export interface Cluster {
1393
1532
  /**
1533
+ * @public
1394
1534
  * <p>The name of the cluster.</p>
1395
1535
  */
1396
1536
  name?: string;
1397
1537
  /**
1538
+ * @public
1398
1539
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1399
1540
  */
1400
1541
  arn?: string;
1401
1542
  /**
1543
+ * @public
1402
1544
  * <p>The Unix epoch timestamp in seconds for when the cluster was created.</p>
1403
1545
  */
1404
1546
  createdAt?: Date;
1405
1547
  /**
1548
+ * @public
1406
1549
  * <p>The Kubernetes server version for the cluster.</p>
1407
1550
  */
1408
1551
  version?: string;
1409
1552
  /**
1553
+ * @public
1410
1554
  * <p>The endpoint for your Kubernetes API server.</p>
1411
1555
  */
1412
1556
  endpoint?: string;
1413
1557
  /**
1558
+ * @public
1414
1559
  * <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the
1415
1560
  * Kubernetes control plane to make calls to Amazon Web Services API operations on your
1416
1561
  * behalf.</p>
1417
1562
  */
1418
1563
  roleArn?: string;
1419
1564
  /**
1565
+ * @public
1420
1566
  * <p>The VPC configuration used by the cluster control plane. Amazon EKS VPC
1421
1567
  * resources have specific requirements to work properly with Kubernetes. For more
1422
1568
  * information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">Cluster VPC Considerations</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html">Cluster Security
@@ -1424,31 +1570,38 @@ export interface Cluster {
1424
1570
  */
1425
1571
  resourcesVpcConfig?: VpcConfigResponse;
1426
1572
  /**
1573
+ * @public
1427
1574
  * <p>The Kubernetes network configuration for the cluster.</p>
1428
1575
  */
1429
1576
  kubernetesNetworkConfig?: KubernetesNetworkConfigResponse;
1430
1577
  /**
1578
+ * @public
1431
1579
  * <p>The logging configuration for your cluster.</p>
1432
1580
  */
1433
1581
  logging?: Logging;
1434
1582
  /**
1583
+ * @public
1435
1584
  * <p>The identity provider information for the cluster.</p>
1436
1585
  */
1437
1586
  identity?: Identity;
1438
1587
  /**
1588
+ * @public
1439
1589
  * <p>The current status of the cluster.</p>
1440
1590
  */
1441
1591
  status?: ClusterStatus | string;
1442
1592
  /**
1593
+ * @public
1443
1594
  * <p>The <code>certificate-authority-data</code> for your cluster.</p>
1444
1595
  */
1445
1596
  certificateAuthority?: Certificate;
1446
1597
  /**
1598
+ * @public
1447
1599
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1448
1600
  * request.</p>
1449
1601
  */
1450
1602
  clientRequestToken?: string;
1451
1603
  /**
1604
+ * @public
1452
1605
  * <p>The platform version of your Amazon EKS cluster. For more information, see
1453
1606
  * <a href="https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html">Platform Versions</a> in the <i>
1454
1607
  * <i>Amazon EKS User Guide</i>
@@ -1456,31 +1609,37 @@ export interface Cluster {
1456
1609
  */
1457
1610
  platformVersion?: string;
1458
1611
  /**
1612
+ * @public
1459
1613
  * <p>The metadata that you apply to the cluster to assist with categorization and
1460
1614
  * organization. Each tag consists of a key and an optional value. You define both. Cluster
1461
1615
  * tags do not propagate to any other resources associated with the cluster.</p>
1462
1616
  */
1463
1617
  tags?: Record<string, string>;
1464
1618
  /**
1619
+ * @public
1465
1620
  * <p>The encryption configuration for the cluster.</p>
1466
1621
  */
1467
1622
  encryptionConfig?: EncryptionConfig[];
1468
1623
  /**
1624
+ * @public
1469
1625
  * <p>The configuration used to connect to a cluster for registration.</p>
1470
1626
  */
1471
1627
  connectorConfig?: ConnectorConfigResponse;
1472
1628
  /**
1629
+ * @public
1473
1630
  * <p>The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This
1474
1631
  * property isn't available for an Amazon EKS cluster on the Amazon Web Services
1475
1632
  * cloud.</p>
1476
1633
  */
1477
1634
  id?: string;
1478
1635
  /**
1636
+ * @public
1479
1637
  * <p>An object representing the health of your local Amazon EKS cluster on an
1480
1638
  * Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>
1481
1639
  */
1482
1640
  health?: ClusterHealth;
1483
1641
  /**
1642
+ * @public
1484
1643
  * <p>An object representing the configuration of your local Amazon EKS cluster on
1485
1644
  * an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>
1486
1645
  */
@@ -1491,6 +1650,7 @@ export interface Cluster {
1491
1650
  */
1492
1651
  export interface CreateClusterResponse {
1493
1652
  /**
1653
+ * @public
1494
1654
  * <p>The full description of your new cluster.</p>
1495
1655
  */
1496
1656
  cluster?: Cluster;
@@ -1503,10 +1663,12 @@ export declare class ResourceLimitExceededException extends __BaseException {
1503
1663
  readonly name: "ResourceLimitExceededException";
1504
1664
  readonly $fault: "client";
1505
1665
  /**
1666
+ * @public
1506
1667
  * <p>The Amazon EKS cluster associated with the exception.</p>
1507
1668
  */
1508
1669
  clusterName?: string;
1509
1670
  /**
1671
+ * @public
1510
1672
  * <p>The Amazon EKS managed node group associated with the exception.</p>
1511
1673
  */
1512
1674
  nodegroupName?: string;
@@ -1538,14 +1700,17 @@ export declare class UnsupportedAvailabilityZoneException extends __BaseExceptio
1538
1700
  readonly name: "UnsupportedAvailabilityZoneException";
1539
1701
  readonly $fault: "client";
1540
1702
  /**
1703
+ * @public
1541
1704
  * <p>The Amazon EKS cluster associated with the exception.</p>
1542
1705
  */
1543
1706
  clusterName?: string;
1544
1707
  /**
1708
+ * @public
1545
1709
  * <p>The Amazon EKS managed node group associated with the exception.</p>
1546
1710
  */
1547
1711
  nodegroupName?: string;
1548
1712
  /**
1713
+ * @public
1549
1714
  * <p>The supported Availability Zones for your account. Choose subnets in these
1550
1715
  * Availability Zones for your cluster.</p>
1551
1716
  */
@@ -1561,10 +1726,12 @@ export declare class UnsupportedAvailabilityZoneException extends __BaseExceptio
1561
1726
  */
1562
1727
  export interface FargateProfileSelector {
1563
1728
  /**
1729
+ * @public
1564
1730
  * <p>The Kubernetes namespace that the selector should match.</p>
1565
1731
  */
1566
1732
  namespace?: string;
1567
1733
  /**
1734
+ * @public
1568
1735
  * <p>The Kubernetes labels that the selector should match. A pod must contain all of the
1569
1736
  * labels that are specified in the selector for it to be considered a match.</p>
1570
1737
  */
@@ -1575,15 +1742,18 @@ export interface FargateProfileSelector {
1575
1742
  */
1576
1743
  export interface CreateFargateProfileRequest {
1577
1744
  /**
1745
+ * @public
1578
1746
  * <p>The name of the Fargate profile.</p>
1579
1747
  */
1580
1748
  fargateProfileName: string | undefined;
1581
1749
  /**
1750
+ * @public
1582
1751
  * <p>The name of the Amazon EKS cluster to apply the Fargate profile
1583
1752
  * to.</p>
1584
1753
  */
1585
1754
  clusterName: string | undefined;
1586
1755
  /**
1756
+ * @public
1587
1757
  * <p>The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in
1588
1758
  * the Fargate profile. The pod execution role allows Fargate
1589
1759
  * infrastructure to register with your cluster as a node, and it provides read access to
@@ -1592,11 +1762,13 @@ export interface CreateFargateProfileRequest {
1592
1762
  */
1593
1763
  podExecutionRoleArn: string | undefined;
1594
1764
  /**
1765
+ * @public
1595
1766
  * <p>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
1596
1767
  * no direct route to an Internet Gateway) are accepted for this parameter.</p>
1597
1768
  */
1598
1769
  subnets?: string[];
1599
1770
  /**
1771
+ * @public
1600
1772
  * <p>The selectors to match for pods to use this Fargate profile. Each
1601
1773
  * selector must have an associated namespace. Optionally, you can also specify labels for
1602
1774
  * a namespace. You may specify up to five selectors in a Fargate
@@ -1604,11 +1776,13 @@ export interface CreateFargateProfileRequest {
1604
1776
  */
1605
1777
  selectors?: FargateProfileSelector[];
1606
1778
  /**
1779
+ * @public
1607
1780
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1608
1781
  * request.</p>
1609
1782
  */
1610
1783
  clientRequestToken?: string;
1611
1784
  /**
1785
+ * @public
1612
1786
  * <p>The metadata to apply to the Fargate profile to assist with
1613
1787
  * categorization and organization. Each tag consists of a key and an optional value. You
1614
1788
  * define both. Fargate profile tags do not propagate to any other resources
@@ -1638,42 +1812,51 @@ export type FargateProfileStatus = (typeof FargateProfileStatus)[keyof typeof Fa
1638
1812
  */
1639
1813
  export interface FargateProfile {
1640
1814
  /**
1815
+ * @public
1641
1816
  * <p>The name of the Fargate profile.</p>
1642
1817
  */
1643
1818
  fargateProfileName?: string;
1644
1819
  /**
1820
+ * @public
1645
1821
  * <p>The full Amazon Resource Name (ARN) of the Fargate profile.</p>
1646
1822
  */
1647
1823
  fargateProfileArn?: string;
1648
1824
  /**
1825
+ * @public
1649
1826
  * <p>The name of the Amazon EKS cluster that the Fargate profile
1650
1827
  * belongs to.</p>
1651
1828
  */
1652
1829
  clusterName?: string;
1653
1830
  /**
1831
+ * @public
1654
1832
  * <p>The Unix epoch timestamp in seconds for when the Fargate profile was
1655
1833
  * created.</p>
1656
1834
  */
1657
1835
  createdAt?: Date;
1658
1836
  /**
1837
+ * @public
1659
1838
  * <p>The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in
1660
1839
  * the Fargate profile. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html">Pod
1661
1840
  * Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>
1662
1841
  */
1663
1842
  podExecutionRoleArn?: string;
1664
1843
  /**
1844
+ * @public
1665
1845
  * <p>The IDs of subnets to launch pods into.</p>
1666
1846
  */
1667
1847
  subnets?: string[];
1668
1848
  /**
1849
+ * @public
1669
1850
  * <p>The selectors to match for pods to use this Fargate profile.</p>
1670
1851
  */
1671
1852
  selectors?: FargateProfileSelector[];
1672
1853
  /**
1854
+ * @public
1673
1855
  * <p>The current status of the Fargate profile.</p>
1674
1856
  */
1675
1857
  status?: FargateProfileStatus | string;
1676
1858
  /**
1859
+ * @public
1677
1860
  * <p>The metadata applied to the Fargate profile to assist with
1678
1861
  * categorization and organization. Each tag consists of a key and an optional value. You
1679
1862
  * define both. Fargate profile tags do not propagate to any other resources
@@ -1687,6 +1870,7 @@ export interface FargateProfile {
1687
1870
  */
1688
1871
  export interface CreateFargateProfileResponse {
1689
1872
  /**
1873
+ * @public
1690
1874
  * <p>The full description of your new Fargate profile.</p>
1691
1875
  */
1692
1876
  fargateProfile?: FargateProfile;
@@ -1726,17 +1910,20 @@ export type CapacityTypes = (typeof CapacityTypes)[keyof typeof CapacityTypes];
1726
1910
  */
1727
1911
  export interface LaunchTemplateSpecification {
1728
1912
  /**
1913
+ * @public
1729
1914
  * <p>The name of the launch template.</p>
1730
1915
  * <p>You must specify either the launch template name or the launch template ID in the
1731
1916
  * request, but not both.</p>
1732
1917
  */
1733
1918
  name?: string;
1734
1919
  /**
1920
+ * @public
1735
1921
  * <p>The version number of the launch template to use. If no version is specified, then the
1736
1922
  * template's default version is used.</p>
1737
1923
  */
1738
1924
  version?: string;
1739
1925
  /**
1926
+ * @public
1740
1927
  * <p>The ID of the launch template.</p>
1741
1928
  * <p>You must specify either the launch template ID or the launch template name in the
1742
1929
  * request, but not both.</p>
@@ -1750,6 +1937,7 @@ export interface LaunchTemplateSpecification {
1750
1937
  */
1751
1938
  export interface RemoteAccessConfig {
1752
1939
  /**
1940
+ * @public
1753
1941
  * <p>The Amazon EC2 SSH key name that provides access for SSH communication with
1754
1942
  * the nodes in the managed node group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Linux instances</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>. For
1755
1943
  * Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more
@@ -1758,6 +1946,7 @@ export interface RemoteAccessConfig {
1758
1946
  */
1759
1947
  ec2SshKey?: string;
1760
1948
  /**
1949
+ * @public
1761
1950
  * <p>The security group IDs that are allowed SSH access (port 22) to the nodes. For
1762
1951
  * Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't
1763
1952
  * specify a source security group when you create a managed node group, then the port on
@@ -1775,15 +1964,18 @@ export interface RemoteAccessConfig {
1775
1964
  */
1776
1965
  export interface NodegroupScalingConfig {
1777
1966
  /**
1967
+ * @public
1778
1968
  * <p>The minimum number of nodes that the managed node group can scale in to.</p>
1779
1969
  */
1780
1970
  minSize?: number;
1781
1971
  /**
1972
+ * @public
1782
1973
  * <p>The maximum number of nodes that the managed node group can scale out to. For
1783
1974
  * information about the maximum number that you can specify, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</p>
1784
1975
  */
1785
1976
  maxSize?: number;
1786
1977
  /**
1978
+ * @public
1787
1979
  * <p>The current number of nodes that the managed node group should maintain.</p>
1788
1980
  * <important>
1789
1981
  * <p>If you use Cluster Autoscaler, you shouldn't change the desiredSize value
@@ -1826,14 +2018,17 @@ export type TaintEffect = (typeof TaintEffect)[keyof typeof TaintEffect];
1826
2018
  */
1827
2019
  export interface Taint {
1828
2020
  /**
2021
+ * @public
1829
2022
  * <p>The key of the taint.</p>
1830
2023
  */
1831
2024
  key?: string;
1832
2025
  /**
2026
+ * @public
1833
2027
  * <p>The value of the taint.</p>
1834
2028
  */
1835
2029
  value?: string;
1836
2030
  /**
2031
+ * @public
1837
2032
  * <p>The effect of the taint.</p>
1838
2033
  */
1839
2034
  effect?: TaintEffect | string;
@@ -1844,12 +2039,14 @@ export interface Taint {
1844
2039
  */
1845
2040
  export interface NodegroupUpdateConfig {
1846
2041
  /**
2042
+ * @public
1847
2043
  * <p>The maximum number of nodes unavailable at once during a version update. Nodes will be
1848
2044
  * updated in parallel. This value or <code>maxUnavailablePercentage</code> is required to
1849
2045
  * have a value.The maximum number is 100.</p>
1850
2046
  */
1851
2047
  maxUnavailable?: number;
1852
2048
  /**
2049
+ * @public
1853
2050
  * <p>The maximum percentage of nodes unavailable during a version update. This percentage
1854
2051
  * of nodes will be updated in parallel, up to 100 nodes at once. This value or
1855
2052
  * <code>maxUnavailable</code> is required to have a value.</p>
@@ -1861,19 +2058,23 @@ export interface NodegroupUpdateConfig {
1861
2058
  */
1862
2059
  export interface CreateNodegroupRequest {
1863
2060
  /**
2061
+ * @public
1864
2062
  * <p>The name of the cluster to create the node group in.</p>
1865
2063
  */
1866
2064
  clusterName: string | undefined;
1867
2065
  /**
2066
+ * @public
1868
2067
  * <p>The unique name to give your node group.</p>
1869
2068
  */
1870
2069
  nodegroupName: string | undefined;
1871
2070
  /**
2071
+ * @public
1872
2072
  * <p>The scaling configuration details for the Auto Scaling group that is created for your
1873
2073
  * node group.</p>
1874
2074
  */
1875
2075
  scalingConfig?: NodegroupScalingConfig;
1876
2076
  /**
2077
+ * @public
1877
2078
  * <p>The root device disk size (in GiB) for your node group instances. The default disk
1878
2079
  * size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.
1879
2080
  * If you specify <code>launchTemplate</code>, then don't specify <code>diskSize</code>, or the node group
@@ -1881,6 +2082,7 @@ export interface CreateNodegroupRequest {
1881
2082
  */
1882
2083
  diskSize?: number;
1883
2084
  /**
2085
+ * @public
1884
2086
  * <p>The subnets to use for the Auto Scaling group that is created for your node group.
1885
2087
  * If you specify <code>launchTemplate</code>, then don't specify <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">
1886
2088
  * <code>SubnetId</code>
@@ -1889,6 +2091,7 @@ export interface CreateNodegroupRequest {
1889
2091
  */
1890
2092
  subnets: string[] | undefined;
1891
2093
  /**
2094
+ * @public
1892
2095
  * <p>Specify the instance types for a node group. If you specify a GPU instance type, make
1893
2096
  * sure to also specify an applicable GPU AMI type with the <code>amiType</code> parameter.
1894
2097
  * If you specify <code>launchTemplate</code>, then you can specify zero or one instance
@@ -1903,6 +2106,7 @@ export interface CreateNodegroupRequest {
1903
2106
  */
1904
2107
  instanceTypes?: string[];
1905
2108
  /**
2109
+ * @public
1906
2110
  * <p>The AMI type for your node group. If you specify <code>launchTemplate</code>, and your launch template uses a custom AMI,
1907
2111
  * then don't specify <code>amiType</code>, or the node group deployment
1908
2112
  * will fail. If your launch template uses a Windows custom AMI, then add
@@ -1912,6 +2116,7 @@ export interface CreateNodegroupRequest {
1912
2116
  */
1913
2117
  amiType?: AMITypes | string;
1914
2118
  /**
2119
+ * @public
1915
2120
  * <p>The remote access configuration to use with your node group.
1916
2121
  * For Linux, the protocol is SSH. For Windows, the protocol is RDP.
1917
2122
  * If you specify <code>launchTemplate</code>, then don't specify
@@ -1920,6 +2125,7 @@ export interface CreateNodegroupRequest {
1920
2125
  */
1921
2126
  remoteAccess?: RemoteAccessConfig;
1922
2127
  /**
2128
+ * @public
1923
2129
  * <p>The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The
1924
2130
  * Amazon EKS worker node <code>kubelet</code> daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls
1925
2131
  * through an IAM instance profile and associated policies. Before you can
@@ -1935,17 +2141,20 @@ export interface CreateNodegroupRequest {
1935
2141
  */
1936
2142
  nodeRole: string | undefined;
1937
2143
  /**
2144
+ * @public
1938
2145
  * <p>The Kubernetes labels to be applied to the nodes in the node group when they are
1939
2146
  * created.</p>
1940
2147
  */
1941
2148
  labels?: Record<string, string>;
1942
2149
  /**
2150
+ * @public
1943
2151
  * <p>The Kubernetes taints to be applied to the nodes in the node group. For more
1944
2152
  * information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html">Node taints on
1945
2153
  * managed node groups</a>.</p>
1946
2154
  */
1947
2155
  taints?: Taint[];
1948
2156
  /**
2157
+ * @public
1949
2158
  * <p>The metadata to apply to the node group to assist with categorization and
1950
2159
  * organization. Each tag consists of a key and an optional value. You define both. Node
1951
2160
  * group tags do not propagate to any other resources associated with the node group, such
@@ -1953,11 +2162,13 @@ export interface CreateNodegroupRequest {
1953
2162
  */
1954
2163
  tags?: Record<string, string>;
1955
2164
  /**
2165
+ * @public
1956
2166
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1957
2167
  * request.</p>
1958
2168
  */
1959
2169
  clientRequestToken?: string;
1960
2170
  /**
2171
+ * @public
1961
2172
  * <p>An object representing a node group's launch template specification. If specified,
1962
2173
  * then do not specify <code>instanceTypes</code>, <code>diskSize</code>, or
1963
2174
  * <code>remoteAccess</code> and make sure that the launch template meets the
@@ -1965,14 +2176,17 @@ export interface CreateNodegroupRequest {
1965
2176
  */
1966
2177
  launchTemplate?: LaunchTemplateSpecification;
1967
2178
  /**
2179
+ * @public
1968
2180
  * <p>The node group update configuration.</p>
1969
2181
  */
1970
2182
  updateConfig?: NodegroupUpdateConfig;
1971
2183
  /**
2184
+ * @public
1972
2185
  * <p>The capacity type for your node group.</p>
1973
2186
  */
1974
2187
  capacityType?: CapacityTypes | string;
1975
2188
  /**
2189
+ * @public
1976
2190
  * <p>The Kubernetes version to use for your managed nodes. By default, the Kubernetes
1977
2191
  * version of the cluster is used, and this is the only accepted specified value.
1978
2192
  * If you specify <code>launchTemplate</code>, and your launch template uses a custom AMI, then don't specify <code>version</code>,
@@ -1980,6 +2194,7 @@ export interface CreateNodegroupRequest {
1980
2194
  */
1981
2195
  version?: string;
1982
2196
  /**
2197
+ * @public
1983
2198
  * <p>The AMI version of the Amazon EKS optimized AMI to use with your node group.
1984
2199
  * By default, the latest available AMI version for the node group's current Kubernetes version
1985
2200
  * is used. For information about 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 <i>Amazon EKS User Guide</i>. Amazon EKS managed node groups support the November 2022 and later releases of the
@@ -2040,6 +2255,7 @@ export type NodegroupIssueCode = (typeof NodegroupIssueCode)[keyof typeof Nodegr
2040
2255
  */
2041
2256
  export interface Issue {
2042
2257
  /**
2258
+ * @public
2043
2259
  * <p>A brief description of the error.</p>
2044
2260
  * <ul>
2045
2261
  * <li>
@@ -2143,10 +2359,12 @@ export interface Issue {
2143
2359
  */
2144
2360
  code?: NodegroupIssueCode | string;
2145
2361
  /**
2362
+ * @public
2146
2363
  * <p>The error message associated with the issue.</p>
2147
2364
  */
2148
2365
  message?: string;
2149
2366
  /**
2367
+ * @public
2150
2368
  * <p>The Amazon Web Services resources that are afflicted by this issue.</p>
2151
2369
  */
2152
2370
  resourceIds?: string[];
@@ -2157,6 +2375,7 @@ export interface Issue {
2157
2375
  */
2158
2376
  export interface NodegroupHealth {
2159
2377
  /**
2378
+ * @public
2160
2379
  * <p>Any issues that are associated with the node group. </p>
2161
2380
  */
2162
2381
  issues?: Issue[];
@@ -2168,10 +2387,12 @@ export interface NodegroupHealth {
2168
2387
  */
2169
2388
  export interface NodegroupResources {
2170
2389
  /**
2390
+ * @public
2171
2391
  * <p>The Auto Scaling groups associated with the node group.</p>
2172
2392
  */
2173
2393
  autoScalingGroups?: AutoScalingGroup[];
2174
2394
  /**
2395
+ * @public
2175
2396
  * <p>The remote access security group associated with the node group. This security group
2176
2397
  * controls SSH access to the nodes.</p>
2177
2398
  */
@@ -2200,22 +2421,27 @@ export type NodegroupStatus = (typeof NodegroupStatus)[keyof typeof NodegroupSta
2200
2421
  */
2201
2422
  export interface Nodegroup {
2202
2423
  /**
2424
+ * @public
2203
2425
  * <p>The name associated with an Amazon EKS managed node group.</p>
2204
2426
  */
2205
2427
  nodegroupName?: string;
2206
2428
  /**
2429
+ * @public
2207
2430
  * <p>The Amazon Resource Name (ARN) associated with the managed node group.</p>
2208
2431
  */
2209
2432
  nodegroupArn?: string;
2210
2433
  /**
2434
+ * @public
2211
2435
  * <p>The name of the cluster that the managed node group resides in.</p>
2212
2436
  */
2213
2437
  clusterName?: string;
2214
2438
  /**
2439
+ * @public
2215
2440
  * <p>The Kubernetes version of the managed node group.</p>
2216
2441
  */
2217
2442
  version?: string;
2218
2443
  /**
2444
+ * @public
2219
2445
  * <p>If the node group was deployed using a launch template with a custom AMI, then this is
2220
2446
  * the AMI ID that was specified in the launch template. For node groups that weren't
2221
2447
  * deployed using a launch template, this is the version of the Amazon EKS
@@ -2223,52 +2449,62 @@ export interface Nodegroup {
2223
2449
  */
2224
2450
  releaseVersion?: string;
2225
2451
  /**
2452
+ * @public
2226
2453
  * <p>The Unix epoch timestamp in seconds for when the managed node group was
2227
2454
  * created.</p>
2228
2455
  */
2229
2456
  createdAt?: Date;
2230
2457
  /**
2458
+ * @public
2231
2459
  * <p>The Unix epoch timestamp in seconds for when the managed node group was last
2232
2460
  * modified.</p>
2233
2461
  */
2234
2462
  modifiedAt?: Date;
2235
2463
  /**
2464
+ * @public
2236
2465
  * <p>The current status of the managed node group.</p>
2237
2466
  */
2238
2467
  status?: NodegroupStatus | string;
2239
2468
  /**
2469
+ * @public
2240
2470
  * <p>The capacity type of your managed node group.</p>
2241
2471
  */
2242
2472
  capacityType?: CapacityTypes | string;
2243
2473
  /**
2474
+ * @public
2244
2475
  * <p>The scaling configuration details for the Auto Scaling group that is associated with
2245
2476
  * your node group.</p>
2246
2477
  */
2247
2478
  scalingConfig?: NodegroupScalingConfig;
2248
2479
  /**
2480
+ * @public
2249
2481
  * <p>If the node group wasn't deployed with a launch template, then this is the instance
2250
2482
  * type that is associated with the node group. If the node group was deployed with a
2251
2483
  * launch template, then this is <code>null</code>.</p>
2252
2484
  */
2253
2485
  instanceTypes?: string[];
2254
2486
  /**
2487
+ * @public
2255
2488
  * <p>The subnets that were specified for the Auto Scaling group that is associated with
2256
2489
  * your node group.</p>
2257
2490
  */
2258
2491
  subnets?: string[];
2259
2492
  /**
2493
+ * @public
2260
2494
  * <p>If the node group wasn't deployed with a launch template, then this is the remote
2261
2495
  * access configuration that is associated with the node group. If the node group was
2262
2496
  * deployed with a launch template, then this is <code>null</code>.</p>
2263
2497
  */
2264
2498
  remoteAccess?: RemoteAccessConfig;
2265
2499
  /**
2500
+ * @public
2266
2501
  * <p>If the node group was deployed using a launch template with a custom AMI, then this is
2267
2502
  * <code>CUSTOM</code>. For node groups that weren't deployed using a launch template,
2268
2503
  * this is the AMI type that was specified in the node group configuration.</p>
2269
2504
  */
2270
2505
  amiType?: AMITypes | string;
2271
2506
  /**
2507
+ * @public
2272
2508
  * <p>The IAM role associated with your node group. The Amazon EKS
2273
2509
  * node <code>kubelet</code> daemon makes calls to Amazon Web Services APIs on your behalf.
2274
2510
  * Nodes receive permissions for these API calls through an IAM instance
@@ -2276,6 +2512,7 @@ export interface Nodegroup {
2276
2512
  */
2277
2513
  nodeRole?: string;
2278
2514
  /**
2515
+ * @public
2279
2516
  * <p>The Kubernetes labels applied to the nodes in the node group.</p>
2280
2517
  * <note>
2281
2518
  * <p>Only labels that are applied with the Amazon EKS API are shown here. There
@@ -2284,6 +2521,7 @@ export interface Nodegroup {
2284
2521
  */
2285
2522
  labels?: Record<string, string>;
2286
2523
  /**
2524
+ * @public
2287
2525
  * <p>The Kubernetes taints to be applied to the nodes in the node group when they are
2288
2526
  * created. Effect is one of <code>No_Schedule</code>, <code>Prefer_No_Schedule</code>, or
2289
2527
  * <code>No_Execute</code>. Kubernetes taints can be used together with tolerations to
@@ -2291,31 +2529,37 @@ export interface Nodegroup {
2291
2529
  */
2292
2530
  taints?: Taint[];
2293
2531
  /**
2532
+ * @public
2294
2533
  * <p>The resources associated with the node group, such as Auto Scaling groups and security
2295
2534
  * groups for remote access.</p>
2296
2535
  */
2297
2536
  resources?: NodegroupResources;
2298
2537
  /**
2538
+ * @public
2299
2539
  * <p>If the node group wasn't deployed with a launch template, then this is the disk size
2300
2540
  * in the node group configuration. If the node group was deployed with a launch template,
2301
2541
  * then this is <code>null</code>.</p>
2302
2542
  */
2303
2543
  diskSize?: number;
2304
2544
  /**
2545
+ * @public
2305
2546
  * <p>The health status of the node group. If there are issues with your node group's
2306
2547
  * health, they are listed here.</p>
2307
2548
  */
2308
2549
  health?: NodegroupHealth;
2309
2550
  /**
2551
+ * @public
2310
2552
  * <p>The node group update configuration.</p>
2311
2553
  */
2312
2554
  updateConfig?: NodegroupUpdateConfig;
2313
2555
  /**
2556
+ * @public
2314
2557
  * <p>If a launch template was used to create the node group, then this is the launch
2315
2558
  * template that was used.</p>
2316
2559
  */
2317
2560
  launchTemplate?: LaunchTemplateSpecification;
2318
2561
  /**
2562
+ * @public
2319
2563
  * <p>The metadata applied to the node group to assist with categorization and organization.
2320
2564
  * Each tag consists of a key and an optional value. You define both. Node group tags do
2321
2565
  * not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets. </p>
@@ -2327,6 +2571,7 @@ export interface Nodegroup {
2327
2571
  */
2328
2572
  export interface CreateNodegroupResponse {
2329
2573
  /**
2574
+ * @public
2330
2575
  * <p>The full description of your new node group.</p>
2331
2576
  */
2332
2577
  nodegroup?: Nodegroup;
@@ -2336,16 +2581,19 @@ export interface CreateNodegroupResponse {
2336
2581
  */
2337
2582
  export interface DeleteAddonRequest {
2338
2583
  /**
2584
+ * @public
2339
2585
  * <p>The name of the cluster to delete the add-on from.</p>
2340
2586
  */
2341
2587
  clusterName: string | undefined;
2342
2588
  /**
2589
+ * @public
2343
2590
  * <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html">
2344
2591
  * <code>ListAddons</code>
2345
2592
  * </a>.</p>
2346
2593
  */
2347
2594
  addonName: string | undefined;
2348
2595
  /**
2596
+ * @public
2349
2597
  * <p>Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM
2350
2598
  * account is associated with the add-on, it isn't removed.</p>
2351
2599
  */
@@ -2356,6 +2604,7 @@ export interface DeleteAddonRequest {
2356
2604
  */
2357
2605
  export interface DeleteAddonResponse {
2358
2606
  /**
2607
+ * @public
2359
2608
  * <p>An Amazon EKS add-on. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in
2360
2609
  * the <i>Amazon EKS User Guide</i>.</p>
2361
2610
  */
@@ -2366,6 +2615,7 @@ export interface DeleteAddonResponse {
2366
2615
  */
2367
2616
  export interface DeleteClusterRequest {
2368
2617
  /**
2618
+ * @public
2369
2619
  * <p>The name of the cluster to delete.</p>
2370
2620
  */
2371
2621
  name: string | undefined;
@@ -2375,6 +2625,7 @@ export interface DeleteClusterRequest {
2375
2625
  */
2376
2626
  export interface DeleteClusterResponse {
2377
2627
  /**
2628
+ * @public
2378
2629
  * <p>The full description of the cluster to delete.</p>
2379
2630
  */
2380
2631
  cluster?: Cluster;
@@ -2384,11 +2635,13 @@ export interface DeleteClusterResponse {
2384
2635
  */
2385
2636
  export interface DeleteFargateProfileRequest {
2386
2637
  /**
2638
+ * @public
2387
2639
  * <p>The name of the Amazon EKS cluster associated with the Fargate
2388
2640
  * profile to delete.</p>
2389
2641
  */
2390
2642
  clusterName: string | undefined;
2391
2643
  /**
2644
+ * @public
2392
2645
  * <p>The name of the Fargate profile to delete.</p>
2393
2646
  */
2394
2647
  fargateProfileName: string | undefined;
@@ -2398,6 +2651,7 @@ export interface DeleteFargateProfileRequest {
2398
2651
  */
2399
2652
  export interface DeleteFargateProfileResponse {
2400
2653
  /**
2654
+ * @public
2401
2655
  * <p>The deleted Fargate profile.</p>
2402
2656
  */
2403
2657
  fargateProfile?: FargateProfile;
@@ -2407,11 +2661,13 @@ export interface DeleteFargateProfileResponse {
2407
2661
  */
2408
2662
  export interface DeleteNodegroupRequest {
2409
2663
  /**
2664
+ * @public
2410
2665
  * <p>The name of the Amazon EKS cluster that is associated with your node
2411
2666
  * group.</p>
2412
2667
  */
2413
2668
  clusterName: string | undefined;
2414
2669
  /**
2670
+ * @public
2415
2671
  * <p>The name of the node group to delete.</p>
2416
2672
  */
2417
2673
  nodegroupName: string | undefined;
@@ -2421,6 +2677,7 @@ export interface DeleteNodegroupRequest {
2421
2677
  */
2422
2678
  export interface DeleteNodegroupResponse {
2423
2679
  /**
2680
+ * @public
2424
2681
  * <p>The full description of your deleted node group.</p>
2425
2682
  */
2426
2683
  nodegroup?: Nodegroup;
@@ -2430,6 +2687,7 @@ export interface DeleteNodegroupResponse {
2430
2687
  */
2431
2688
  export interface DeregisterClusterRequest {
2432
2689
  /**
2690
+ * @public
2433
2691
  * <p>The name of the connected cluster to deregister.</p>
2434
2692
  */
2435
2693
  name: string | undefined;
@@ -2439,6 +2697,7 @@ export interface DeregisterClusterRequest {
2439
2697
  */
2440
2698
  export interface DeregisterClusterResponse {
2441
2699
  /**
2700
+ * @public
2442
2701
  * <p>An object representing an Amazon EKS cluster.</p>
2443
2702
  */
2444
2703
  cluster?: Cluster;
@@ -2448,10 +2707,12 @@ export interface DeregisterClusterResponse {
2448
2707
  */
2449
2708
  export interface DescribeAddonRequest {
2450
2709
  /**
2710
+ * @public
2451
2711
  * <p>The name of the cluster.</p>
2452
2712
  */
2453
2713
  clusterName: string | undefined;
2454
2714
  /**
2715
+ * @public
2455
2716
  * <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html">
2456
2717
  * <code>ListAddons</code>
2457
2718
  * </a>.</p>
@@ -2463,6 +2724,7 @@ export interface DescribeAddonRequest {
2463
2724
  */
2464
2725
  export interface DescribeAddonResponse {
2465
2726
  /**
2727
+ * @public
2466
2728
  * <p>An Amazon EKS add-on. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html">Amazon EKS add-ons</a> in
2467
2729
  * the <i>Amazon EKS User Guide</i>.</p>
2468
2730
  */
@@ -2473,12 +2735,14 @@ export interface DescribeAddonResponse {
2473
2735
  */
2474
2736
  export interface DescribeAddonConfigurationRequest {
2475
2737
  /**
2738
+ * @public
2476
2739
  * <p>The name of the add-on. The name must match one of the names that <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
2477
2740
  * <code>DescribeAddonVersions</code>
2478
2741
  * </a> returns.</p>
2479
2742
  */
2480
2743
  addonName: string | undefined;
2481
2744
  /**
2745
+ * @public
2482
2746
  * <p>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
2483
2747
  * <code>DescribeAddonVersions</code>
2484
2748
  * </a>.</p>
@@ -2490,16 +2754,19 @@ export interface DescribeAddonConfigurationRequest {
2490
2754
  */
2491
2755
  export interface DescribeAddonConfigurationResponse {
2492
2756
  /**
2757
+ * @public
2493
2758
  * <p>The name of the add-on.</p>
2494
2759
  */
2495
2760
  addonName?: string;
2496
2761
  /**
2762
+ * @public
2497
2763
  * <p>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
2498
2764
  * <code>DescribeAddonVersions</code>
2499
2765
  * </a>.</p>
2500
2766
  */
2501
2767
  addonVersion?: string;
2502
2768
  /**
2769
+ * @public
2503
2770
  * <p>A JSON schema that's used to validate the configuration values that you provide when
2504
2771
  * an addon is created or updated.</p>
2505
2772
  */
@@ -2510,14 +2777,17 @@ export interface DescribeAddonConfigurationResponse {
2510
2777
  */
2511
2778
  export interface DescribeAddonVersionsRequest {
2512
2779
  /**
2780
+ * @public
2513
2781
  * <p>The Kubernetes versions that you can use the add-on with.</p>
2514
2782
  */
2515
2783
  kubernetesVersion?: string;
2516
2784
  /**
2785
+ * @public
2517
2786
  * <p>The maximum number of results to return.</p>
2518
2787
  */
2519
2788
  maxResults?: number;
2520
2789
  /**
2790
+ * @public
2521
2791
  * <p>The <code>nextToken</code> value returned from a previous paginated
2522
2792
  * <code>DescribeAddonVersionsRequest</code> where <code>maxResults</code> was used and
2523
2793
  * the results exceeded the value of that parameter. Pagination continues from the end of
@@ -2529,22 +2799,26 @@ export interface DescribeAddonVersionsRequest {
2529
2799
  */
2530
2800
  nextToken?: string;
2531
2801
  /**
2802
+ * @public
2532
2803
  * <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html">
2533
2804
  * <code>ListAddons</code>
2534
2805
  * </a>.</p>
2535
2806
  */
2536
2807
  addonName?: string;
2537
2808
  /**
2809
+ * @public
2538
2810
  * <p>The type of the add-on. For valid <code>types</code>, don't specify a value for this
2539
2811
  * property.</p>
2540
2812
  */
2541
2813
  types?: string[];
2542
2814
  /**
2815
+ * @public
2543
2816
  * <p>The publisher of the add-on. For valid <code>publishers</code>, don't specify a value
2544
2817
  * for this property.</p>
2545
2818
  */
2546
2819
  publishers?: string[];
2547
2820
  /**
2821
+ * @public
2548
2822
  * <p>The owner of the add-on. For valid <code>owners</code>, don't specify a value for this
2549
2823
  * property.</p>
2550
2824
  */
@@ -2555,11 +2829,13 @@ export interface DescribeAddonVersionsRequest {
2555
2829
  */
2556
2830
  export interface DescribeAddonVersionsResponse {
2557
2831
  /**
2832
+ * @public
2558
2833
  * <p>The list of available versions with Kubernetes version compatibility and other
2559
2834
  * properties.</p>
2560
2835
  */
2561
2836
  addons?: AddonInfo[];
2562
2837
  /**
2838
+ * @public
2563
2839
  * <p>The <code>nextToken</code> value returned from a previous paginated
2564
2840
  * <code>DescribeAddonVersionsResponse</code> where <code>maxResults</code> was used
2565
2841
  * and the results exceeded the value of that parameter. Pagination continues from the end
@@ -2576,6 +2852,7 @@ export interface DescribeAddonVersionsResponse {
2576
2852
  */
2577
2853
  export interface DescribeClusterRequest {
2578
2854
  /**
2855
+ * @public
2579
2856
  * <p>The name of the cluster to describe.</p>
2580
2857
  */
2581
2858
  name: string | undefined;
@@ -2585,6 +2862,7 @@ export interface DescribeClusterRequest {
2585
2862
  */
2586
2863
  export interface DescribeClusterResponse {
2587
2864
  /**
2865
+ * @public
2588
2866
  * <p>The full description of your specified cluster.</p>
2589
2867
  */
2590
2868
  cluster?: Cluster;
@@ -2594,11 +2872,13 @@ export interface DescribeClusterResponse {
2594
2872
  */
2595
2873
  export interface DescribeFargateProfileRequest {
2596
2874
  /**
2875
+ * @public
2597
2876
  * <p>The name of the Amazon EKS cluster associated with the Fargate
2598
2877
  * profile.</p>
2599
2878
  */
2600
2879
  clusterName: string | undefined;
2601
2880
  /**
2881
+ * @public
2602
2882
  * <p>The name of the Fargate profile to describe.</p>
2603
2883
  */
2604
2884
  fargateProfileName: string | undefined;
@@ -2608,6 +2888,7 @@ export interface DescribeFargateProfileRequest {
2608
2888
  */
2609
2889
  export interface DescribeFargateProfileResponse {
2610
2890
  /**
2891
+ * @public
2611
2892
  * <p>The full description of your Fargate profile.</p>
2612
2893
  */
2613
2894
  fargateProfile?: FargateProfile;
@@ -2618,11 +2899,13 @@ export interface DescribeFargateProfileResponse {
2618
2899
  */
2619
2900
  export interface IdentityProviderConfig {
2620
2901
  /**
2902
+ * @public
2621
2903
  * <p>The type of the identity provider configuration. The only type available is
2622
2904
  * <code>oidc</code>.</p>
2623
2905
  */
2624
2906
  type: string | undefined;
2625
2907
  /**
2908
+ * @public
2626
2909
  * <p>The name of the identity provider configuration.</p>
2627
2910
  */
2628
2911
  name: string | undefined;
@@ -2632,10 +2915,12 @@ export interface IdentityProviderConfig {
2632
2915
  */
2633
2916
  export interface DescribeIdentityProviderConfigRequest {
2634
2917
  /**
2918
+ * @public
2635
2919
  * <p>The cluster name that the identity provider configuration is associated to.</p>
2636
2920
  */
2637
2921
  clusterName: string | undefined;
2638
2922
  /**
2923
+ * @public
2639
2924
  * <p>An object representing an identity provider configuration.</p>
2640
2925
  */
2641
2926
  identityProviderConfig: IdentityProviderConfig | undefined;
@@ -2660,42 +2945,51 @@ export type ConfigStatus = (typeof ConfigStatus)[keyof typeof ConfigStatus];
2660
2945
  */
2661
2946
  export interface OidcIdentityProviderConfig {
2662
2947
  /**
2948
+ * @public
2663
2949
  * <p>The name of the configuration.</p>
2664
2950
  */
2665
2951
  identityProviderConfigName?: string;
2666
2952
  /**
2953
+ * @public
2667
2954
  * <p>The ARN of the configuration.</p>
2668
2955
  */
2669
2956
  identityProviderConfigArn?: string;
2670
2957
  /**
2958
+ * @public
2671
2959
  * <p>The cluster that the configuration is associated to.</p>
2672
2960
  */
2673
2961
  clusterName?: string;
2674
2962
  /**
2963
+ * @public
2675
2964
  * <p>The URL of the OIDC identity provider that allows the API server to discover public
2676
2965
  * signing keys for verifying tokens.</p>
2677
2966
  */
2678
2967
  issuerUrl?: string;
2679
2968
  /**
2969
+ * @public
2680
2970
  * <p>This is also known as <i>audience</i>. The ID of the client application
2681
2971
  * that makes authentication requests to the OIDC identity provider.</p>
2682
2972
  */
2683
2973
  clientId?: string;
2684
2974
  /**
2975
+ * @public
2685
2976
  * <p>The JSON Web token (JWT) claim that is used as the username.</p>
2686
2977
  */
2687
2978
  usernameClaim?: string;
2688
2979
  /**
2980
+ * @public
2689
2981
  * <p>The prefix that is prepended to username claims to prevent clashes with existing
2690
2982
  * names. The prefix can't contain <code>system:</code>
2691
2983
  * </p>
2692
2984
  */
2693
2985
  usernamePrefix?: string;
2694
2986
  /**
2987
+ * @public
2695
2988
  * <p>The JSON web token (JWT) claim that the provider uses to return your groups.</p>
2696
2989
  */
2697
2990
  groupsClaim?: string;
2698
2991
  /**
2992
+ * @public
2699
2993
  * <p>The prefix that is prepended to group claims to prevent clashes with existing names
2700
2994
  * (such as <code>system:</code> groups). For example, the value<code> oidc:</code> creates
2701
2995
  * group names like <code>oidc:engineering</code> and <code>oidc:infra</code>. The prefix
@@ -2704,16 +2998,19 @@ export interface OidcIdentityProviderConfig {
2704
2998
  */
2705
2999
  groupsPrefix?: string;
2706
3000
  /**
3001
+ * @public
2707
3002
  * <p>The key-value pairs that describe required claims in the identity token. If set, each
2708
3003
  * claim is verified to be present in the token with a matching value.</p>
2709
3004
  */
2710
3005
  requiredClaims?: Record<string, string>;
2711
3006
  /**
3007
+ * @public
2712
3008
  * <p>The metadata to apply to the provider configuration to assist with categorization and
2713
3009
  * organization. Each tag consists of a key and an optional value. You define both.</p>
2714
3010
  */
2715
3011
  tags?: Record<string, string>;
2716
3012
  /**
3013
+ * @public
2717
3014
  * <p>The status of the OIDC identity provider.</p>
2718
3015
  */
2719
3016
  status?: ConfigStatus | string;
@@ -2724,6 +3021,7 @@ export interface OidcIdentityProviderConfig {
2724
3021
  */
2725
3022
  export interface IdentityProviderConfigResponse {
2726
3023
  /**
3024
+ * @public
2727
3025
  * <p>An object representing an OpenID Connect (OIDC) identity provider
2728
3026
  * configuration.</p>
2729
3027
  */
@@ -2734,6 +3032,7 @@ export interface IdentityProviderConfigResponse {
2734
3032
  */
2735
3033
  export interface DescribeIdentityProviderConfigResponse {
2736
3034
  /**
3035
+ * @public
2737
3036
  * <p>The object that represents an OpenID Connect (OIDC) identity provider
2738
3037
  * configuration.</p>
2739
3038
  */
@@ -2744,10 +3043,12 @@ export interface DescribeIdentityProviderConfigResponse {
2744
3043
  */
2745
3044
  export interface DescribeNodegroupRequest {
2746
3045
  /**
3046
+ * @public
2747
3047
  * <p>The name of the Amazon EKS cluster associated with the node group.</p>
2748
3048
  */
2749
3049
  clusterName: string | undefined;
2750
3050
  /**
3051
+ * @public
2751
3052
  * <p>The name of the node group to describe.</p>
2752
3053
  */
2753
3054
  nodegroupName: string | undefined;
@@ -2757,6 +3058,7 @@ export interface DescribeNodegroupRequest {
2757
3058
  */
2758
3059
  export interface DescribeNodegroupResponse {
2759
3060
  /**
3061
+ * @public
2760
3062
  * <p>The full description of your node group.</p>
2761
3063
  */
2762
3064
  nodegroup?: Nodegroup;
@@ -2766,19 +3068,23 @@ export interface DescribeNodegroupResponse {
2766
3068
  */
2767
3069
  export interface DescribeUpdateRequest {
2768
3070
  /**
3071
+ * @public
2769
3072
  * <p>The name of the Amazon EKS cluster associated with the update.</p>
2770
3073
  */
2771
3074
  name: string | undefined;
2772
3075
  /**
3076
+ * @public
2773
3077
  * <p>The ID of the update to describe.</p>
2774
3078
  */
2775
3079
  updateId: string | undefined;
2776
3080
  /**
3081
+ * @public
2777
3082
  * <p>The name of the Amazon EKS node group associated with the update. This
2778
3083
  * parameter is required if the update is a node group update.</p>
2779
3084
  */
2780
3085
  nodegroupName?: string;
2781
3086
  /**
3087
+ * @public
2782
3088
  * <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html">
2783
3089
  * <code>ListAddons</code>
2784
3090
  * </a>. This parameter is required if the update is an add-on update.</p>
@@ -2790,6 +3096,7 @@ export interface DescribeUpdateRequest {
2790
3096
  */
2791
3097
  export interface DescribeUpdateResponse {
2792
3098
  /**
3099
+ * @public
2793
3100
  * <p>The full description of the specified update.</p>
2794
3101
  */
2795
3102
  update?: Update;
@@ -2799,14 +3106,17 @@ export interface DescribeUpdateResponse {
2799
3106
  */
2800
3107
  export interface DisassociateIdentityProviderConfigRequest {
2801
3108
  /**
3109
+ * @public
2802
3110
  * <p>The name of the cluster to disassociate an identity provider from.</p>
2803
3111
  */
2804
3112
  clusterName: string | undefined;
2805
3113
  /**
3114
+ * @public
2806
3115
  * <p>An object representing an identity provider configuration.</p>
2807
3116
  */
2808
3117
  identityProviderConfig: IdentityProviderConfig | undefined;
2809
3118
  /**
3119
+ * @public
2810
3120
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2811
3121
  * request.</p>
2812
3122
  */
@@ -2817,6 +3127,7 @@ export interface DisassociateIdentityProviderConfigRequest {
2817
3127
  */
2818
3128
  export interface DisassociateIdentityProviderConfigResponse {
2819
3129
  /**
3130
+ * @public
2820
3131
  * <p>An object representing an asynchronous update.</p>
2821
3132
  */
2822
3133
  update?: Update;
@@ -2826,10 +3137,12 @@ export interface DisassociateIdentityProviderConfigResponse {
2826
3137
  */
2827
3138
  export interface ListAddonsRequest {
2828
3139
  /**
3140
+ * @public
2829
3141
  * <p>The name of the cluster.</p>
2830
3142
  */
2831
3143
  clusterName: string | undefined;
2832
3144
  /**
3145
+ * @public
2833
3146
  * <p>The maximum number of add-on results returned by <code>ListAddonsRequest</code> in
2834
3147
  * paginated output. When you use this parameter, <code>ListAddonsRequest</code> returns
2835
3148
  * only <code>maxResults</code> results in a single page along with a
@@ -2842,6 +3155,7 @@ export interface ListAddonsRequest {
2842
3155
  */
2843
3156
  maxResults?: number;
2844
3157
  /**
3158
+ * @public
2845
3159
  * <p>The <code>nextToken</code> value returned from a previous paginated
2846
3160
  * <code>ListAddonsRequest</code> where <code>maxResults</code> was used and the
2847
3161
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -2858,10 +3172,12 @@ export interface ListAddonsRequest {
2858
3172
  */
2859
3173
  export interface ListAddonsResponse {
2860
3174
  /**
3175
+ * @public
2861
3176
  * <p>A list of available add-ons.</p>
2862
3177
  */
2863
3178
  addons?: string[];
2864
3179
  /**
3180
+ * @public
2865
3181
  * <p>The <code>nextToken</code> value returned from a previous paginated
2866
3182
  * <code>ListAddonsResponse</code> where <code>maxResults</code> was used and the
2867
3183
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -2878,6 +3194,7 @@ export interface ListAddonsResponse {
2878
3194
  */
2879
3195
  export interface ListClustersRequest {
2880
3196
  /**
3197
+ * @public
2881
3198
  * <p>The maximum number of cluster results returned by <code>ListClusters</code> in
2882
3199
  * paginated output. When you use this parameter, <code>ListClusters</code> returns only
2883
3200
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code>
@@ -2889,6 +3206,7 @@ export interface ListClustersRequest {
2889
3206
  */
2890
3207
  maxResults?: number;
2891
3208
  /**
3209
+ * @public
2892
3210
  * <p>The <code>nextToken</code> value returned from a previous paginated
2893
3211
  * <code>ListClusters</code> request where <code>maxResults</code> was used and the
2894
3212
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -2900,6 +3218,7 @@ export interface ListClustersRequest {
2900
3218
  */
2901
3219
  nextToken?: string;
2902
3220
  /**
3221
+ * @public
2903
3222
  * <p>Indicates whether external clusters are included in the returned list. Use
2904
3223
  * '<code>all</code>' to return connected clusters, or blank to return only Amazon EKS clusters. '<code>all</code>' must be in lowercase otherwise an error
2905
3224
  * occurs.</p>
@@ -2911,10 +3230,12 @@ export interface ListClustersRequest {
2911
3230
  */
2912
3231
  export interface ListClustersResponse {
2913
3232
  /**
3233
+ * @public
2914
3234
  * <p>A list of all of the clusters for your account in the specified Region.</p>
2915
3235
  */
2916
3236
  clusters?: string[];
2917
3237
  /**
3238
+ * @public
2918
3239
  * <p>The <code>nextToken</code> value to include in a future <code>ListClusters</code>
2919
3240
  * request. When the results of a <code>ListClusters</code> request exceed
2920
3241
  * <code>maxResults</code>, you can use this value to retrieve the next page of
@@ -2928,10 +3249,12 @@ export interface ListClustersResponse {
2928
3249
  */
2929
3250
  export interface ListFargateProfilesRequest {
2930
3251
  /**
3252
+ * @public
2931
3253
  * <p>The name of the Amazon EKS cluster that you would like to list Fargate profiles in.</p>
2932
3254
  */
2933
3255
  clusterName: string | undefined;
2934
3256
  /**
3257
+ * @public
2935
3258
  * <p>The maximum number of Fargate profile results returned by
2936
3259
  * <code>ListFargateProfiles</code> in paginated output. When you use this parameter,
2937
3260
  * <code>ListFargateProfiles</code> returns only <code>maxResults</code> results in a
@@ -2944,6 +3267,7 @@ export interface ListFargateProfilesRequest {
2944
3267
  */
2945
3268
  maxResults?: number;
2946
3269
  /**
3270
+ * @public
2947
3271
  * <p>The <code>nextToken</code> value returned from a previous paginated
2948
3272
  * <code>ListFargateProfiles</code> request where <code>maxResults</code> was used and
2949
3273
  * the results exceeded the value of that parameter. Pagination continues from the end of
@@ -2956,11 +3280,13 @@ export interface ListFargateProfilesRequest {
2956
3280
  */
2957
3281
  export interface ListFargateProfilesResponse {
2958
3282
  /**
3283
+ * @public
2959
3284
  * <p>A list of all of the Fargate profiles associated with the specified
2960
3285
  * cluster.</p>
2961
3286
  */
2962
3287
  fargateProfileNames?: string[];
2963
3288
  /**
3289
+ * @public
2964
3290
  * <p>The <code>nextToken</code> value to include in a future
2965
3291
  * <code>ListFargateProfiles</code> request. When the results of a
2966
3292
  * <code>ListFargateProfiles</code> request exceed <code>maxResults</code>, you can use
@@ -2974,10 +3300,12 @@ export interface ListFargateProfilesResponse {
2974
3300
  */
2975
3301
  export interface ListIdentityProviderConfigsRequest {
2976
3302
  /**
3303
+ * @public
2977
3304
  * <p>The cluster name that you want to list identity provider configurations for.</p>
2978
3305
  */
2979
3306
  clusterName: string | undefined;
2980
3307
  /**
3308
+ * @public
2981
3309
  * <p>The maximum number of identity provider configurations returned by
2982
3310
  * <code>ListIdentityProviderConfigs</code> in paginated output. When you use this
2983
3311
  * parameter, <code>ListIdentityProviderConfigs</code> returns only <code>maxResults</code>
@@ -2991,6 +3319,7 @@ export interface ListIdentityProviderConfigsRequest {
2991
3319
  */
2992
3320
  maxResults?: number;
2993
3321
  /**
3322
+ * @public
2994
3323
  * <p>The <code>nextToken</code> value returned from a previous paginated
2995
3324
  * <code>IdentityProviderConfigsRequest</code> where <code>maxResults</code> was used
2996
3325
  * and the results exceeded the value of that parameter. Pagination continues from the end
@@ -3003,10 +3332,12 @@ export interface ListIdentityProviderConfigsRequest {
3003
3332
  */
3004
3333
  export interface ListIdentityProviderConfigsResponse {
3005
3334
  /**
3335
+ * @public
3006
3336
  * <p>The identity provider configurations for the cluster.</p>
3007
3337
  */
3008
3338
  identityProviderConfigs?: IdentityProviderConfig[];
3009
3339
  /**
3340
+ * @public
3010
3341
  * <p>The <code>nextToken</code> value returned from a previous paginated
3011
3342
  * <code>ListIdentityProviderConfigsResponse</code> where <code>maxResults</code> was
3012
3343
  * used and the results exceeded the value of that parameter. Pagination continues from the
@@ -3019,11 +3350,13 @@ export interface ListIdentityProviderConfigsResponse {
3019
3350
  */
3020
3351
  export interface ListNodegroupsRequest {
3021
3352
  /**
3353
+ * @public
3022
3354
  * <p>The name of the Amazon EKS cluster that you would like to list node groups
3023
3355
  * in.</p>
3024
3356
  */
3025
3357
  clusterName: string | undefined;
3026
3358
  /**
3359
+ * @public
3027
3360
  * <p>The maximum number of node group results returned by <code>ListNodegroups</code> in
3028
3361
  * paginated output. When you use this parameter, <code>ListNodegroups</code> returns only
3029
3362
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code>
@@ -3035,6 +3368,7 @@ export interface ListNodegroupsRequest {
3035
3368
  */
3036
3369
  maxResults?: number;
3037
3370
  /**
3371
+ * @public
3038
3372
  * <p>The <code>nextToken</code> value returned from a previous paginated
3039
3373
  * <code>ListNodegroups</code> request where <code>maxResults</code> was used and the
3040
3374
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -3047,10 +3381,12 @@ export interface ListNodegroupsRequest {
3047
3381
  */
3048
3382
  export interface ListNodegroupsResponse {
3049
3383
  /**
3384
+ * @public
3050
3385
  * <p>A list of all of the node groups associated with the specified cluster.</p>
3051
3386
  */
3052
3387
  nodegroups?: string[];
3053
3388
  /**
3389
+ * @public
3054
3390
  * <p>The <code>nextToken</code> value to include in a future <code>ListNodegroups</code>
3055
3391
  * request. When the results of a <code>ListNodegroups</code> request exceed
3056
3392
  * <code>maxResults</code>, you can use this value to retrieve the next page of
@@ -3077,6 +3413,7 @@ export declare class BadRequestException extends __BaseException {
3077
3413
  */
3078
3414
  export interface ListTagsForResourceRequest {
3079
3415
  /**
3416
+ * @public
3080
3417
  * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the
3081
3418
  * supported resources are Amazon EKS clusters and managed node groups.</p>
3082
3419
  */
@@ -3087,6 +3424,7 @@ export interface ListTagsForResourceRequest {
3087
3424
  */
3088
3425
  export interface ListTagsForResourceResponse {
3089
3426
  /**
3427
+ * @public
3090
3428
  * <p>The tags for the resource.</p>
3091
3429
  */
3092
3430
  tags?: Record<string, string>;
@@ -3109,18 +3447,22 @@ export declare class NotFoundException extends __BaseException {
3109
3447
  */
3110
3448
  export interface ListUpdatesRequest {
3111
3449
  /**
3450
+ * @public
3112
3451
  * <p>The name of the Amazon EKS cluster to list updates for.</p>
3113
3452
  */
3114
3453
  name: string | undefined;
3115
3454
  /**
3455
+ * @public
3116
3456
  * <p>The name of the Amazon EKS managed node group to list updates for.</p>
3117
3457
  */
3118
3458
  nodegroupName?: string;
3119
3459
  /**
3460
+ * @public
3120
3461
  * <p>The names of the installed add-ons that have available updates.</p>
3121
3462
  */
3122
3463
  addonName?: string;
3123
3464
  /**
3465
+ * @public
3124
3466
  * <p>The <code>nextToken</code> value returned from a previous paginated
3125
3467
  * <code>ListUpdates</code> request where <code>maxResults</code> was used and the
3126
3468
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -3128,6 +3470,7 @@ export interface ListUpdatesRequest {
3128
3470
  */
3129
3471
  nextToken?: string;
3130
3472
  /**
3473
+ * @public
3131
3474
  * <p>The maximum number of update results returned by <code>ListUpdates</code> in paginated
3132
3475
  * output. When you use this parameter, <code>ListUpdates</code> returns only
3133
3476
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code>
@@ -3144,10 +3487,12 @@ export interface ListUpdatesRequest {
3144
3487
  */
3145
3488
  export interface ListUpdatesResponse {
3146
3489
  /**
3490
+ * @public
3147
3491
  * <p>A list of all the updates for the specified cluster and Region.</p>
3148
3492
  */
3149
3493
  updateIds?: string[];
3150
3494
  /**
3495
+ * @public
3151
3496
  * <p>The <code>nextToken</code> value to include in a future <code>ListUpdates</code>
3152
3497
  * request. When the results of a <code>ListUpdates</code> request exceed
3153
3498
  * <code>maxResults</code>, you can use this value to retrieve the next page of
@@ -3181,11 +3526,13 @@ export type ConnectorConfigProvider = (typeof ConnectorConfigProvider)[keyof typ
3181
3526
  */
3182
3527
  export interface ConnectorConfigRequest {
3183
3528
  /**
3529
+ * @public
3184
3530
  * <p>The Amazon Resource Name (ARN) of the role that is authorized to request the connector
3185
3531
  * configuration.</p>
3186
3532
  */
3187
3533
  roleArn: string | undefined;
3188
3534
  /**
3535
+ * @public
3189
3536
  * <p>The cloud provider for the target cluster to connect.</p>
3190
3537
  */
3191
3538
  provider: ConnectorConfigProvider | string | undefined;
@@ -3195,19 +3542,23 @@ export interface ConnectorConfigRequest {
3195
3542
  */
3196
3543
  export interface RegisterClusterRequest {
3197
3544
  /**
3545
+ * @public
3198
3546
  * <p>Define a unique name for this cluster for your Region.</p>
3199
3547
  */
3200
3548
  name: string | undefined;
3201
3549
  /**
3550
+ * @public
3202
3551
  * <p>The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.</p>
3203
3552
  */
3204
3553
  connectorConfig: ConnectorConfigRequest | undefined;
3205
3554
  /**
3555
+ * @public
3206
3556
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3207
3557
  * request.</p>
3208
3558
  */
3209
3559
  clientRequestToken?: string;
3210
3560
  /**
3561
+ * @public
3211
3562
  * <p>The metadata that you apply to the cluster to assist with categorization and
3212
3563
  * organization. Each tag consists of a key and an optional value, both of which you
3213
3564
  * define. Cluster tags do not propagate to any other resources associated with the
@@ -3220,6 +3571,7 @@ export interface RegisterClusterRequest {
3220
3571
  */
3221
3572
  export interface RegisterClusterResponse {
3222
3573
  /**
3574
+ * @public
3223
3575
  * <p>An object representing an Amazon EKS cluster.</p>
3224
3576
  */
3225
3577
  cluster?: Cluster;
@@ -3242,11 +3594,13 @@ export declare class ResourcePropagationDelayException extends __BaseException {
3242
3594
  */
3243
3595
  export interface TagResourceRequest {
3244
3596
  /**
3597
+ * @public
3245
3598
  * <p>The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources
3246
3599
  * are Amazon EKS clusters and managed node groups.</p>
3247
3600
  */
3248
3601
  resourceArn: string | undefined;
3249
3602
  /**
3603
+ * @public
3250
3604
  * <p>The tags to add to the resource. A tag is an array of key-value pairs.</p>
3251
3605
  */
3252
3606
  tags: Record<string, string> | undefined;
@@ -3261,11 +3615,13 @@ export interface TagResourceResponse {
3261
3615
  */
3262
3616
  export interface UntagResourceRequest {
3263
3617
  /**
3618
+ * @public
3264
3619
  * <p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported
3265
3620
  * resources are Amazon EKS clusters and managed node groups.</p>
3266
3621
  */
3267
3622
  resourceArn: string | undefined;
3268
3623
  /**
3624
+ * @public
3269
3625
  * <p>The keys of the tags to be removed.</p>
3270
3626
  */
3271
3627
  tagKeys: string[] | undefined;
@@ -3280,22 +3636,26 @@ export interface UntagResourceResponse {
3280
3636
  */
3281
3637
  export interface UpdateAddonRequest {
3282
3638
  /**
3639
+ * @public
3283
3640
  * <p>The name of the cluster.</p>
3284
3641
  */
3285
3642
  clusterName: string | undefined;
3286
3643
  /**
3644
+ * @public
3287
3645
  * <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html">
3288
3646
  * <code>ListAddons</code>
3289
3647
  * </a>.</p>
3290
3648
  */
3291
3649
  addonName: string | undefined;
3292
3650
  /**
3651
+ * @public
3293
3652
  * <p>The version of the add-on. The version must match one of the versions returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html">
3294
3653
  * <code>DescribeAddonVersions</code>
3295
3654
  * </a>.</p>
3296
3655
  */
3297
3656
  addonVersion?: string;
3298
3657
  /**
3658
+ * @public
3299
3659
  * <p>The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the
3300
3660
  * permissions assigned to the node IAM role. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html">Amazon EKS node IAM role</a> in the <i>Amazon EKS User Guide</i>.</p>
3301
3661
  * <note>
@@ -3307,6 +3667,7 @@ export interface UpdateAddonRequest {
3307
3667
  */
3308
3668
  serviceAccountRoleArn?: string;
3309
3669
  /**
3670
+ * @public
3310
3671
  * <p>How to resolve field value conflicts for an Amazon EKS add-on if you've
3311
3672
  * changed a value from the Amazon EKS default value. Conflicts are handled based
3312
3673
  * on the option you choose:</p>
@@ -3333,11 +3694,13 @@ export interface UpdateAddonRequest {
3333
3694
  */
3334
3695
  resolveConflicts?: ResolveConflicts | string;
3335
3696
  /**
3697
+ * @public
3336
3698
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3337
3699
  * request.</p>
3338
3700
  */
3339
3701
  clientRequestToken?: string;
3340
3702
  /**
3703
+ * @public
3341
3704
  * <p>The set of configuration values for the add-on that's created. The values that you
3342
3705
  * provide are validated against the schema in <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html">DescribeAddonConfiguration</a>.</p>
3343
3706
  */
@@ -3348,6 +3711,7 @@ export interface UpdateAddonRequest {
3348
3711
  */
3349
3712
  export interface UpdateAddonResponse {
3350
3713
  /**
3714
+ * @public
3351
3715
  * <p>An object representing an asynchronous update.</p>
3352
3716
  */
3353
3717
  update?: Update;
@@ -3357,15 +3721,18 @@ export interface UpdateAddonResponse {
3357
3721
  */
3358
3722
  export interface UpdateClusterConfigRequest {
3359
3723
  /**
3724
+ * @public
3360
3725
  * <p>The name of the Amazon EKS cluster to update.</p>
3361
3726
  */
3362
3727
  name: string | undefined;
3363
3728
  /**
3729
+ * @public
3364
3730
  * <p>An object representing the VPC configuration to use for an Amazon EKS
3365
3731
  * cluster.</p>
3366
3732
  */
3367
3733
  resourcesVpcConfig?: VpcConfigRequest;
3368
3734
  /**
3735
+ * @public
3369
3736
  * <p>Enable or disable exporting the Kubernetes control plane logs for your cluster to
3370
3737
  * CloudWatch Logs. By default, cluster control plane logs aren't exported to
3371
3738
  * 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
@@ -3380,6 +3747,7 @@ export interface UpdateClusterConfigRequest {
3380
3747
  */
3381
3748
  logging?: Logging;
3382
3749
  /**
3750
+ * @public
3383
3751
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3384
3752
  * request.</p>
3385
3753
  */
@@ -3390,6 +3758,7 @@ export interface UpdateClusterConfigRequest {
3390
3758
  */
3391
3759
  export interface UpdateClusterConfigResponse {
3392
3760
  /**
3761
+ * @public
3393
3762
  * <p>An object representing an asynchronous update.</p>
3394
3763
  */
3395
3764
  update?: Update;
@@ -3399,14 +3768,17 @@ export interface UpdateClusterConfigResponse {
3399
3768
  */
3400
3769
  export interface UpdateClusterVersionRequest {
3401
3770
  /**
3771
+ * @public
3402
3772
  * <p>The name of the Amazon EKS cluster to update.</p>
3403
3773
  */
3404
3774
  name: string | undefined;
3405
3775
  /**
3776
+ * @public
3406
3777
  * <p>The desired Kubernetes version following a successful update.</p>
3407
3778
  */
3408
3779
  version: string | undefined;
3409
3780
  /**
3781
+ * @public
3410
3782
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3411
3783
  * request.</p>
3412
3784
  */
@@ -3417,6 +3789,7 @@ export interface UpdateClusterVersionRequest {
3417
3789
  */
3418
3790
  export interface UpdateClusterVersionResponse {
3419
3791
  /**
3792
+ * @public
3420
3793
  * <p>The full description of the specified update</p>
3421
3794
  */
3422
3795
  update?: Update;
@@ -3427,10 +3800,12 @@ export interface UpdateClusterVersionResponse {
3427
3800
  */
3428
3801
  export interface UpdateLabelsPayload {
3429
3802
  /**
3803
+ * @public
3430
3804
  * <p>Kubernetes labels to be added or updated.</p>
3431
3805
  */
3432
3806
  addOrUpdateLabels?: Record<string, string>;
3433
3807
  /**
3808
+ * @public
3434
3809
  * <p>Kubernetes labels to be removed.</p>
3435
3810
  */
3436
3811
  removeLabels?: string[];
@@ -3443,10 +3818,12 @@ export interface UpdateLabelsPayload {
3443
3818
  */
3444
3819
  export interface UpdateTaintsPayload {
3445
3820
  /**
3821
+ * @public
3446
3822
  * <p>Kubernetes taints to be added or updated.</p>
3447
3823
  */
3448
3824
  addOrUpdateTaints?: Taint[];
3449
3825
  /**
3826
+ * @public
3450
3827
  * <p>Kubernetes taints to remove.</p>
3451
3828
  */
3452
3829
  removeTaints?: Taint[];
@@ -3456,34 +3833,41 @@ export interface UpdateTaintsPayload {
3456
3833
  */
3457
3834
  export interface UpdateNodegroupConfigRequest {
3458
3835
  /**
3836
+ * @public
3459
3837
  * <p>The name of the Amazon EKS cluster that the managed node group resides
3460
3838
  * in.</p>
3461
3839
  */
3462
3840
  clusterName: string | undefined;
3463
3841
  /**
3842
+ * @public
3464
3843
  * <p>The name of the managed node group to update.</p>
3465
3844
  */
3466
3845
  nodegroupName: string | undefined;
3467
3846
  /**
3847
+ * @public
3468
3848
  * <p>The Kubernetes labels to be applied to the nodes in the node group after the
3469
3849
  * update.</p>
3470
3850
  */
3471
3851
  labels?: UpdateLabelsPayload;
3472
3852
  /**
3853
+ * @public
3473
3854
  * <p>The Kubernetes taints to be applied to the nodes in the node group after the update.
3474
3855
  * For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html">Node taints on
3475
3856
  * managed node groups</a>.</p>
3476
3857
  */
3477
3858
  taints?: UpdateTaintsPayload;
3478
3859
  /**
3860
+ * @public
3479
3861
  * <p>The scaling configuration details for the Auto Scaling group after the update.</p>
3480
3862
  */
3481
3863
  scalingConfig?: NodegroupScalingConfig;
3482
3864
  /**
3865
+ * @public
3483
3866
  * <p>The node group update configuration.</p>
3484
3867
  */
3485
3868
  updateConfig?: NodegroupUpdateConfig;
3486
3869
  /**
3870
+ * @public
3487
3871
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3488
3872
  * request.</p>
3489
3873
  */
@@ -3494,6 +3878,7 @@ export interface UpdateNodegroupConfigRequest {
3494
3878
  */
3495
3879
  export interface UpdateNodegroupConfigResponse {
3496
3880
  /**
3881
+ * @public
3497
3882
  * <p>An object representing an asynchronous update.</p>
3498
3883
  */
3499
3884
  update?: Update;
@@ -3503,15 +3888,18 @@ export interface UpdateNodegroupConfigResponse {
3503
3888
  */
3504
3889
  export interface UpdateNodegroupVersionRequest {
3505
3890
  /**
3891
+ * @public
3506
3892
  * <p>The name of the Amazon EKS cluster that is associated with the managed node
3507
3893
  * group to update.</p>
3508
3894
  */
3509
3895
  clusterName: string | undefined;
3510
3896
  /**
3897
+ * @public
3511
3898
  * <p>The name of the managed node group to update.</p>
3512
3899
  */
3513
3900
  nodegroupName: string | undefined;
3514
3901
  /**
3902
+ * @public
3515
3903
  * <p>The Kubernetes version to update to. If no version is specified, then the Kubernetes
3516
3904
  * version of the node group does not change. You can specify the Kubernetes version of the
3517
3905
  * cluster to update the node group to the latest AMI version of the cluster's Kubernetes
@@ -3521,6 +3909,7 @@ export interface UpdateNodegroupVersionRequest {
3521
3909
  */
3522
3910
  version?: string;
3523
3911
  /**
3912
+ * @public
3524
3913
  * <p>The AMI version of the Amazon EKS optimized AMI to use for the update. By
3525
3914
  * default, the latest available AMI version for the node group's Kubernetes version is used.
3526
3915
  * For information about 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 <i>Amazon EKS User Guide</i>. Amazon EKS managed node groups support the November 2022 and later releases of the
@@ -3532,12 +3921,14 @@ export interface UpdateNodegroupVersionRequest {
3532
3921
  */
3533
3922
  releaseVersion?: string;
3534
3923
  /**
3924
+ * @public
3535
3925
  * <p>An object representing a node group's launch template specification. You can only
3536
3926
  * update a node group using a launch template if the node group was originally deployed
3537
3927
  * with a launch template.</p>
3538
3928
  */
3539
3929
  launchTemplate?: LaunchTemplateSpecification;
3540
3930
  /**
3931
+ * @public
3541
3932
  * <p>Force the update if the existing node group's pods are unable to be drained due to a
3542
3933
  * pod disruption budget issue. If an update fails because pods could not be drained, you
3543
3934
  * can force the update after it fails to terminate the old node whether or not any pods
@@ -3545,6 +3936,7 @@ export interface UpdateNodegroupVersionRequest {
3545
3936
  */
3546
3937
  force?: boolean;
3547
3938
  /**
3939
+ * @public
3548
3940
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3549
3941
  * request.</p>
3550
3942
  */
@@ -3555,6 +3947,7 @@ export interface UpdateNodegroupVersionRequest {
3555
3947
  */
3556
3948
  export interface UpdateNodegroupVersionResponse {
3557
3949
  /**
3950
+ * @public
3558
3951
  * <p>An object representing an asynchronous update.</p>
3559
3952
  */
3560
3953
  update?: Update;