/
models_0.ts
4303 lines (3786 loc) · 142 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { EKSServiceException as __BaseException } from "./EKSServiceException";
/**
* <p>You don't have permissions to perform the requested operation. The user or role that
* is making the request must have at least one IAM permissions policy
* attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access
* Management</a> in the <i>IAM User Guide</i>. </p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
}
}
export enum AddonIssueCode {
ACCESS_DENIED = "AccessDenied",
ADMISSION_REQUEST_DENIED = "AdmissionRequestDenied",
CLUSTER_UNREACHABLE = "ClusterUnreachable",
CONFIGURATION_CONFLICT = "ConfigurationConflict",
INSUFFICIENT_NUMBER_OF_REPLICAS = "InsufficientNumberOfReplicas",
INTERNAL_FAILURE = "InternalFailure",
K8S_RESOURCE_NOT_FOUND = "K8sResourceNotFound",
UNSUPPORTED_ADDON_MODIFICATION = "UnsupportedAddonModification",
}
/**
* <p>An issue related to an add-on.</p>
*/
export interface AddonIssue {
/**
* <p>A code that describes the type of issue.</p>
*/
code?: AddonIssueCode | string;
/**
* <p>A message that provides details about the issue and what might cause it.</p>
*/
message?: string;
/**
* <p>The resource IDs of the issue.</p>
*/
resourceIds?: string[];
}
/**
* <p>The health of the add-on.</p>
*/
export interface AddonHealth {
/**
* <p>An object representing the health issues for an add-on.</p>
*/
issues?: AddonIssue[];
}
export type AddonStatus =
| "ACTIVE"
| "CREATE_FAILED"
| "CREATING"
| "DEGRADED"
| "DELETE_FAILED"
| "DELETING"
| "UPDATE_FAILED"
| "UPDATING";
/**
* <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
* the <i>Amazon EKS User Guide</i>.</p>
*/
export interface Addon {
/**
* <p>The name of the add-on.</p>
*/
addonName?: string;
/**
* <p>The name of the cluster.</p>
*/
clusterName?: string;
/**
* <p>The status of the add-on.</p>
*/
status?: AddonStatus | string;
/**
* <p>The version of the add-on.</p>
*/
addonVersion?: string;
/**
* <p>An object representing the health of the add-on.</p>
*/
health?: AddonHealth;
/**
* <p>The Amazon Resource Name (ARN) of the add-on.</p>
*/
addonArn?: string;
/**
* <p>The date and time that the add-on was created.</p>
*/
createdAt?: Date;
/**
* <p>The date and time that the add-on was last modified.</p>
*/
modifiedAt?: Date;
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service
* account used by the add-on.</p>
*/
serviceAccountRoleArn?: string;
/**
* <p>The metadata that you apply to the add-on to assist with categorization and
* organization. Each tag consists of a key and an optional value. You define both. Add-on
* tags do not propagate to any other resources associated with the cluster. </p>
*/
tags?: Record<string, string>;
}
/**
* <p>Compatibility information.</p>
*/
export interface Compatibility {
/**
* <p>The supported Kubernetes version of the cluster.</p>
*/
clusterVersion?: string;
/**
* <p>The supported compute platform.</p>
*/
platformVersions?: string[];
/**
* <p>The supported default version.</p>
*/
defaultVersion?: boolean;
}
/**
* <p>Information about an add-on version.</p>
*/
export interface AddonVersionInfo {
/**
* <p>The version of the add-on.</p>
*/
addonVersion?: string;
/**
* <p>The architectures that the version supports.</p>
*/
architecture?: string[];
/**
* <p>An object representing the compatibilities of a version.</p>
*/
compatibilities?: Compatibility[];
}
/**
* <p>Information about an add-on.</p>
*/
export interface AddonInfo {
/**
* <p>The name of the add-on.</p>
*/
addonName?: string;
/**
* <p>The type of the add-on.</p>
*/
type?: string;
/**
* <p>An object representing information about available add-on versions and compatible
* Kubernetes versions.</p>
*/
addonVersions?: AddonVersionInfo[];
}
export type AMITypes =
| "AL2_ARM_64"
| "AL2_x86_64"
| "AL2_x86_64_GPU"
| "BOTTLEROCKET_ARM_64"
| "BOTTLEROCKET_ARM_64_NVIDIA"
| "BOTTLEROCKET_x86_64"
| "BOTTLEROCKET_x86_64_NVIDIA"
| "CUSTOM";
/**
* <p>Identifies the Key Management Service (KMS) key used to encrypt the
* secrets.</p>
*/
export interface Provider {
/**
* <p>Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same
* region as the cluster, and if the KMS key was created in a different account, the user
* 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
* Users in Other Accounts to Use a KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
*/
keyArn?: string;
}
/**
* <p>The encryption configuration for the cluster.</p>
*/
export interface EncryptionConfig {
/**
* <p>Specifies the resources to be encrypted. The only supported value is "secrets".</p>
*/
resources?: string[];
/**
* <p>Key Management Service (KMS) key. Either the ARN or the alias can be
* used.</p>
*/
provider?: Provider;
}
export interface AssociateEncryptionConfigRequest {
/**
* <p>The name of the cluster that you are associating with encryption configuration.</p>
*/
clusterName: string | undefined;
/**
* <p>The configuration you are using for encryption.</p>
*/
encryptionConfig: EncryptionConfig[] | undefined;
/**
* <p>The client request token you are using with the encryption configuration.</p>
*/
clientRequestToken?: string;
}
export enum ErrorCode {
ACCESS_DENIED = "AccessDenied",
ADMISSION_REQUEST_DENIED = "AdmissionRequestDenied",
CLUSTER_UNREACHABLE = "ClusterUnreachable",
CONFIGURATION_CONFLICT = "ConfigurationConflict",
ENI_LIMIT_REACHED = "EniLimitReached",
INSUFFICIENT_FREE_ADDRESSES = "InsufficientFreeAddresses",
INSUFFICIENT_NUMBER_OF_REPLICAS = "InsufficientNumberOfReplicas",
IP_NOT_AVAILABLE = "IpNotAvailable",
K8S_RESOURCE_NOT_FOUND = "K8sResourceNotFound",
NODE_CREATION_FAILURE = "NodeCreationFailure",
OPERATION_NOT_PERMITTED = "OperationNotPermitted",
POD_EVICTION_FAILURE = "PodEvictionFailure",
SECURITY_GROUP_NOT_FOUND = "SecurityGroupNotFound",
SUBNET_NOT_FOUND = "SubnetNotFound",
UNKNOWN = "Unknown",
UNSUPPORTED_ADDON_MODIFICATION = "UnsupportedAddonModification",
VPC_ID_NOT_FOUND = "VpcIdNotFound",
}
/**
* <p>An object representing an error when an asynchronous operation fails.</p>
*/
export interface ErrorDetail {
/**
* <p>A brief description of the error. </p>
* <ul>
* <li>
* <p>
* <b>SubnetNotFound</b>: We couldn't find one of the
* subnets associated with the cluster.</p>
* </li>
* <li>
* <p>
* <b>SecurityGroupNotFound</b>: We couldn't find one
* of the security groups associated with the cluster.</p>
* </li>
* <li>
* <p>
* <b>EniLimitReached</b>: You have reached the elastic
* network interface limit for your account.</p>
* </li>
* <li>
* <p>
* <b>IpNotAvailable</b>: A subnet associated with the
* cluster doesn't have any free IP addresses.</p>
* </li>
* <li>
* <p>
* <b>AccessDenied</b>: You don't have permissions to
* perform the specified operation.</p>
* </li>
* <li>
* <p>
* <b>OperationNotPermitted</b>: The service role
* associated with the cluster doesn't have the required access permissions for
* Amazon EKS.</p>
* </li>
* <li>
* <p>
* <b>VpcIdNotFound</b>: We couldn't find the VPC
* associated with the cluster.</p>
* </li>
* </ul>
*/
errorCode?: ErrorCode | string;
/**
* <p>A more complete description of the error.</p>
*/
errorMessage?: string;
/**
* <p>An optional field that contains the resource IDs associated with the error.</p>
*/
resourceIds?: string[];
}
export enum UpdateParamType {
ADDON_VERSION = "AddonVersion",
CLUSTER_LOGGING = "ClusterLogging",
DESIRED_SIZE = "DesiredSize",
ENCRYPTION_CONFIG = "EncryptionConfig",
ENDPOINT_PRIVATE_ACCESS = "EndpointPrivateAccess",
ENDPOINT_PUBLIC_ACCESS = "EndpointPublicAccess",
IDENTITY_PROVIDER_CONFIG = "IdentityProviderConfig",
LABELS_TO_ADD = "LabelsToAdd",
LABELS_TO_REMOVE = "LabelsToRemove",
LAUNCH_TEMPLATE_NAME = "LaunchTemplateName",
LAUNCH_TEMPLATE_VERSION = "LaunchTemplateVersion",
MAX_SIZE = "MaxSize",
MAX_UNAVAILABLE = "MaxUnavailable",
MAX_UNAVAILABLE_PERCENTAGE = "MaxUnavailablePercentage",
MIN_SIZE = "MinSize",
PLATFORM_VERSION = "PlatformVersion",
PUBLIC_ACCESS_CIDRS = "PublicAccessCidrs",
RELEASE_VERSION = "ReleaseVersion",
RESOLVE_CONFLICTS = "ResolveConflicts",
SERVICE_ACCOUNT_ROLE_ARN = "ServiceAccountRoleArn",
TAINTS_TO_ADD = "TaintsToAdd",
TAINTS_TO_REMOVE = "TaintsToRemove",
VERSION = "Version",
}
/**
* <p>An object representing the details of an update request.</p>
*/
export interface UpdateParam {
/**
* <p>The keys associated with an update request.</p>
*/
type?: UpdateParamType | string;
/**
* <p>The value of the keys submitted as part of an update request.</p>
*/
value?: string;
}
export enum UpdateStatus {
CANCELLED = "Cancelled",
FAILED = "Failed",
IN_PROGRESS = "InProgress",
SUCCESSFUL = "Successful",
}
export enum UpdateType {
ADDON_UPDATE = "AddonUpdate",
ASSOCIATE_ENCRYPTION_CONFIG = "AssociateEncryptionConfig",
ASSOCIATE_IDENTITY_PROVIDER_CONFIG = "AssociateIdentityProviderConfig",
CONFIG_UPDATE = "ConfigUpdate",
DISASSOCIATE_IDENTITY_PROVIDER_CONFIG = "DisassociateIdentityProviderConfig",
ENDPOINT_ACCESS_UPDATE = "EndpointAccessUpdate",
LOGGING_UPDATE = "LoggingUpdate",
VERSION_UPDATE = "VersionUpdate",
}
/**
* <p>An object representing an asynchronous update.</p>
*/
export interface Update {
/**
* <p>A UUID that is used to track the update.</p>
*/
id?: string;
/**
* <p>The current status of the update.</p>
*/
status?: UpdateStatus | string;
/**
* <p>The type of the update.</p>
*/
type?: UpdateType | string;
/**
* <p>A key-value map that contains the parameters associated with the update.</p>
*/
params?: UpdateParam[];
/**
* <p>The Unix epoch timestamp in seconds for when the update was created.</p>
*/
createdAt?: Date;
/**
* <p>Any errors associated with a <code>Failed</code> update.</p>
*/
errors?: ErrorDetail[];
}
export interface AssociateEncryptionConfigResponse {
/**
* <p>An object representing an asynchronous update.</p>
*/
update?: Update;
}
/**
* <p>These errors are usually caused by a client action. Actions can include using an
* action or resource on behalf of a user that doesn't have permissions to use the action
* or resource or specifying an identifier that is not valid.</p>
*/
export class ClientException extends __BaseException {
readonly name: "ClientException" = "ClientException";
readonly $fault: "client" = "client";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ClientException, __BaseException>) {
super({
name: "ClientException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ClientException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.addonName = opts.addonName;
}
}
/**
* <p>The specified parameter is invalid. Review the available parameters for the API
* request.</p>
*/
export class InvalidParameterException extends __BaseException {
readonly name: "InvalidParameterException" = "InvalidParameterException";
readonly $fault: "client" = "client";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
/**
* <p>The Fargate profile associated with the exception.</p>
*/
fargateProfileName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>) {
super({
name: "InvalidParameterException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidParameterException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.fargateProfileName = opts.fargateProfileName;
this.addonName = opts.addonName;
}
}
/**
* <p>The request is invalid given the state of the cluster. Check the state of the cluster
* and the associated operations.</p>
*/
export class InvalidRequestException extends __BaseException {
readonly name: "InvalidRequestException" = "InvalidRequestException";
readonly $fault: "client" = "client";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>) {
super({
name: "InvalidRequestException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidRequestException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.addonName = opts.addonName;
}
}
/**
* <p>The specified resource is in use.</p>
*/
export class ResourceInUseException extends __BaseException {
readonly name: "ResourceInUseException" = "ResourceInUseException";
readonly $fault: "client" = "client";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>) {
super({
name: "ResourceInUseException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceInUseException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.addonName = opts.addonName;
}
}
/**
* <p>The specified resource could not be found. You can view your available clusters with
* <a>ListClusters</a>. You can view your available managed node groups with
* <a>ListNodegroups</a>. Amazon EKS clusters and node groups are
* Region-specific.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
/**
* <p>The Fargate profile associated with the exception.</p>
*/
fargateProfileName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.fargateProfileName = opts.fargateProfileName;
this.addonName = opts.addonName;
}
}
/**
* <p>These errors are usually caused by a server-side issue.</p>
*/
export class ServerException extends __BaseException {
readonly name: "ServerException" = "ServerException";
readonly $fault: "server" = "server";
/**
* <p>The Amazon EKS cluster associated with the exception.</p>
*/
clusterName?: string;
/**
* <p>The Amazon EKS managed node group associated with the exception.</p>
*/
nodegroupName?: string;
addonName?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServerException, __BaseException>) {
super({
name: "ServerException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, ServerException.prototype);
this.clusterName = opts.clusterName;
this.nodegroupName = opts.nodegroupName;
this.addonName = opts.addonName;
}
}
/**
* <p>An object representing an OpenID Connect (OIDC) configuration. Before associating an
* OIDC identity provider to your cluster, review the considerations in <a href="https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html">Authenticating
* users for your cluster from an OpenID Connect identity provider</a> in the
* <i>Amazon EKS User Guide</i>.</p>
*/
export interface OidcIdentityProviderConfigRequest {
/**
* <p>The name of the OIDC provider configuration.</p>
*/
identityProviderConfigName: string | undefined;
/**
* <p>The URL of the OpenID identity provider that allows the API server to discover public
* signing keys for verifying tokens. The URL must begin with <code>https://</code> and
* should correspond to the <code>iss</code> claim in the provider's OIDC ID tokens. Per
* the OIDC standard, path components are allowed but query parameters are not. Typically
* the URL consists of only a hostname, like <code>https://server.example.org</code> or
* <code>https://example.com</code>. This URL should point to the level below
* <code>.well-known/openid-configuration</code> and must be publicly accessible over
* the internet.</p>
*/
issuerUrl: string | undefined;
/**
* <p>This is also known as <i>audience</i>. The ID for the client application
* that makes authentication requests to the OpenID identity provider.</p>
*/
clientId: string | undefined;
/**
* <p>The JSON Web Token (JWT) claim to use as the username. The default is
* <code>sub</code>, which is expected to be a unique identifier of the end user. You can
* choose other claims, such as <code>email</code> or <code>name</code>, depending on the
* OpenID identity provider. Claims other than <code>email</code> are prefixed with the
* issuer URL to prevent naming clashes with other plug-ins.</p>
*/
usernameClaim?: string;
/**
* <p>The prefix that is prepended to username claims to prevent clashes with existing
* names. If you do not provide this field, and <code>username</code> is a value other than
* <code>email</code>, the prefix defaults to <code>issuerurl#</code>. You can use the
* value <code>-</code> to disable all prefixing.</p>
*/
usernamePrefix?: string;
/**
* <p>The JWT claim that the provider uses to return your groups.</p>
*/
groupsClaim?: string;
/**
* <p>The prefix that is prepended to group claims to prevent clashes with existing names
* (such as <code>system:</code> groups). For example, the value<code> oidc:</code> will
* create group names like <code>oidc:engineering</code> and
* <code>oidc:infra</code>.</p>
*/
groupsPrefix?: string;
/**
* <p>The key value pairs that describe required claims in the identity token. If set, each
* claim is verified to be present in the token with a matching value. For the maximum
* number of claims that you can require, 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>
*/
requiredClaims?: Record<string, string>;
}
export interface AssociateIdentityProviderConfigRequest {
/**
* <p>The name of the cluster to associate the configuration to.</p>
*/
clusterName: string | undefined;
/**
* <p>An object representing an OpenID Connect (OIDC) identity provider
* configuration.</p>
*/
oidc: OidcIdentityProviderConfigRequest | undefined;
/**
* <p>The metadata to apply to the configuration to assist with categorization and
* organization. Each tag consists of a key and an optional value. You define both.</p>
*/
tags?: Record<string, string>;
/**
* <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request.</p>
*/
clientRequestToken?: string;
}
export interface AssociateIdentityProviderConfigResponse {
/**
* <p>An object representing an asynchronous update.</p>
*/
update?: Update;
/**
* <p>The tags for the resource.</p>
*/
tags?: Record<string, string>;
}
/**
* <p>An Auto Scaling group that is associated with an Amazon EKS managed node
* group.</p>
*/
export interface AutoScalingGroup {
/**
* <p>The name of the Auto Scaling group associated with an Amazon EKS managed node
* group.</p>
*/
name?: string;
}
export type ResolveConflicts = "NONE" | "OVERWRITE" | "PRESERVE";
export interface CreateAddonRequest {
/**
* <p>The name of the cluster to create the add-on for.</p>
*/
clusterName: string | undefined;
/**
* <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_DescribeAddonVersions.html">
* <code>DescribeAddonVersions</code>
* </a>.</p>
*/
addonName: string | undefined;
/**
* <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">
* <code>DescribeAddonVersions</code>
* </a>.</p>
*/
addonVersion?: string;
/**
* <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
* 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>
* <note>
* <p>To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for
* your cluster. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html">Enabling
* IAM roles for service accounts on your cluster</a> in the
* <i>Amazon EKS User Guide</i>.</p>
* </note>
*/
serviceAccountRoleArn?: string;
/**
* <p>How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are
* handled based on the value you choose:</p>
* <ul>
* <li>
* <p>
* <b>None</b> – If the self-managed version of
* the add-on is installed on your cluster, Amazon EKS doesn't change the
* value. Creation of the add-on might fail.</p>
* </li>
* <li>
* <p>
* <b>Overwrite</b> – If the self-managed
* version of the add-on is installed on your cluster and the Amazon EKS
* default value is different than the existing value, Amazon EKS changes
* the value to the Amazon EKS default value.</p>
* </li>
* <li>
* <p>
* <b>Preserve</b> – Not supported. You can set
* this value when updating an add-on though. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html">UpdateAddon</a>.</p>
* </li>
* </ul>
* <p>If you don't currently have the self-managed version of the add-on installed on your
* cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values
* to default values, regardless of the option that you specify.</p>
*/
resolveConflicts?: ResolveConflicts | string;
/**
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request.</p>
*/
clientRequestToken?: string;
/**
* <p>The metadata to apply to the cluster to assist with categorization and organization.
* Each tag consists of a key and an optional value. You define both.</p>
*/
tags?: Record<string, string>;
}
export interface CreateAddonResponse {
/**
* <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
* the <i>Amazon EKS User Guide</i>.</p>
*/
addon?: Addon;
}
export enum IpFamily {
IPV4 = "ipv4",
IPV6 = "ipv6",
}
/**
* <p>The Kubernetes network configuration for the cluster.</p>
*/
export interface KubernetesNetworkConfigRequest {
/**
* <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.
* If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16
* or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not
* overlap with resources in other networks that are peered or connected to your VPC. The
* block must meet the following requirements:</p>
* <ul>
* <li>
* <p>Within one of the following private IP address blocks: 10.0.0.0/8,
* 172.16.0.0/12, or 192.168.0.0/16.</p>
* </li>
* <li>
* <p>Doesn't overlap with any CIDR block assigned to the VPC that you selected for
* VPC.</p>
* </li>
* <li>
* <p>Between /24 and /12.</p>
* </li>
* </ul>
* <important>
* <p>You can only specify a custom CIDR block when you create a cluster and can't
* change this value once the cluster is created.</p>
* </important>
*/
serviceIpv4Cidr?: string;
/**
* <p>Specify which IP family is used to assign Kubernetes pod and service IP addresses. If
* you don't specify a value, <code>ipv4</code> is used by default. You can only specify an
* IP family when you create a cluster and can't change this value once the cluster is
* created. If you specify <code>ipv6</code>, the VPC and subnets that you specify for
* cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't
* specify <code>ipv6</code> for clusters in China Regions.</p>
* <p>You can only specify <code>ipv6</code> for 1.21 and later clusters that use version
* 1.10.1 or later of the Amazon VPC CNI add-on. If you specify <code>ipv6</code>, then ensure
* that your VPC meets the requirements listed in the considerations listed in <a href="https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html">Assigning IPv6
* addresses to pods and services</a> in the Amazon EKS User Guide.
* Kubernetes assigns services IPv6 addresses from the unique local address range
* (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from
* the subnet's IPv6 CIDR.</p>
*/
ipFamily?: IpFamily | string;
}
export enum LogType {
API = "api",
AUDIT = "audit",
AUTHENTICATOR = "authenticator",
CONTROLLER_MANAGER = "controllerManager",
SCHEDULER = "scheduler",
}
/**
* <p>An object representing the enabled or disabled Kubernetes control plane logs for your
* cluster.</p>
*/
export interface LogSetup {
/**
* <p>The available cluster control plane log types.</p>
*/
types?: (LogType | string)[];
/**
* <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
* plane logs. Each individual log type can be enabled or disabled independently.</p>
*/
enabled?: boolean;
}
/**
* <p>An object representing the logging configuration for resources in your cluster.</p>
*/
export interface Logging {
/**
* <p>The cluster control plane logging configuration for your cluster.</p>
*/
clusterLogging?: LogSetup[];
}
/**
* <p>The configuration of your local Amazon EKS cluster on an Amazon Web Services
* Outpost. Before creating a cluster on an Outpost, review <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-cluster-outpost.html">Creating a local Amazon EKS cluster on an Amazon Web Services Outpost</a> in the
* <i>Amazon EKS User Guide</i>. This API isn't available for Amazon EKS clusters on the
* Amazon Web Services cloud.</p>
*/
export interface OutpostConfigRequest {
/**
* <p>The ARN of the Outpost that you want to use for your local Amazon EKS
* cluster on Outposts. Only a single Outpost ARN is
* supported.</p>
*/
outpostArns: string[] | undefined;
/**
* <p>The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. The instance type that you specify is used for all
* Kubernetes control plane instances. The instance type can't be changed after cluster
* creation.</p>
* <p>Choose an instance type based on the number of nodes that your cluster will have. If
* your cluster will have:</p>
* <ul>
* <li>
* <p>1–20 nodes, then we recommend specifying a <code>large</code> instance
* type.</p>
* </li>
* <li>
* <p>21–100 nodes, then we recommend specifying an <code>xlarge</code>
* instance type.</p>
* </li>
* <li>
* <p>101–250 nodes, then we recommend specifying a <code>2xlarge</code>
* instance type.</p>
* </li>
* </ul>
* <p>For a list of the available Amazon EC2 instance types, see Compute and storage
* in <a href="http://aws.amazon.com/outposts/rack/features/">Outposts rack
* features</a>. The control plane is not automatically scaled by Amazon EKS.</p>
*/
controlPlaneInstanceType: string | undefined;
}
/**
* <p>An object representing the VPC configuration to use for an Amazon EKS
* cluster.</p>
*/
export interface VpcConfigRequest {
/**
* <p>Specify subnets for your Amazon EKS nodes. Amazon EKS creates
* cross-account elastic network interfaces in these subnets to allow communication between
* your nodes and the Kubernetes control plane.</p>
*/
subnetIds?: string[];
/**
* <p>Specify one or more security groups for the cross-account elastic network interfaces
* that Amazon EKS creates to use that allow communication between your nodes and
* the Kubernetes control plane. If you don't specify any security groups, then familiarize
* yourself with the difference between Amazon EKS defaults for clusters deployed
* with Kubernetes:</p>