@aws-sdk/client-elasticsearch-service 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.
- package/dist-types/models/models_0.d.ts +487 -0
- package/package.json +5 -5
|
@@ -6,6 +6,7 @@ import { ElasticsearchServiceServiceException as __BaseException } from "./Elast
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AcceptInboundCrossClusterSearchConnectionRequest {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The id of the inbound connection that you want to accept.</p>
|
|
10
11
|
*/
|
|
11
12
|
CrossClusterSearchConnectionId: string | undefined;
|
|
@@ -32,6 +33,7 @@ export type InboundCrossClusterSearchConnectionStatusCode = (typeof InboundCross
|
|
|
32
33
|
*/
|
|
33
34
|
export interface InboundCrossClusterSearchConnectionStatus {
|
|
34
35
|
/**
|
|
36
|
+
* @public
|
|
35
37
|
* <p>The state code for inbound connection. This can be one of the following:</p>
|
|
36
38
|
* <ul>
|
|
37
39
|
* <li>PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.</li>
|
|
@@ -44,6 +46,7 @@ export interface InboundCrossClusterSearchConnectionStatus {
|
|
|
44
46
|
*/
|
|
45
47
|
StatusCode?: InboundCrossClusterSearchConnectionStatusCode | string;
|
|
46
48
|
/**
|
|
49
|
+
* @public
|
|
47
50
|
* <p>Specifies verbose information for the inbound connection status.</p>
|
|
48
51
|
*/
|
|
49
52
|
Message?: string;
|
|
@@ -54,6 +57,7 @@ export interface InboundCrossClusterSearchConnectionStatus {
|
|
|
54
57
|
export interface DomainInformation {
|
|
55
58
|
OwnerId?: string;
|
|
56
59
|
/**
|
|
60
|
+
* @public
|
|
57
61
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
58
62
|
*/
|
|
59
63
|
DomainName: string | undefined;
|
|
@@ -65,18 +69,22 @@ export interface DomainInformation {
|
|
|
65
69
|
*/
|
|
66
70
|
export interface InboundCrossClusterSearchConnection {
|
|
67
71
|
/**
|
|
72
|
+
* @public
|
|
68
73
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the source Elasticsearch domain.</p>
|
|
69
74
|
*/
|
|
70
75
|
SourceDomainInfo?: DomainInformation;
|
|
71
76
|
/**
|
|
77
|
+
* @public
|
|
72
78
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the destination Elasticsearch domain.</p>
|
|
73
79
|
*/
|
|
74
80
|
DestinationDomainInfo?: DomainInformation;
|
|
75
81
|
/**
|
|
82
|
+
* @public
|
|
76
83
|
* <p>Specifies the connection id for the inbound cross-cluster search connection.</p>
|
|
77
84
|
*/
|
|
78
85
|
CrossClusterSearchConnectionId?: string;
|
|
79
86
|
/**
|
|
87
|
+
* @public
|
|
80
88
|
* <p>Specifies the <code><a>InboundCrossClusterSearchConnectionStatus</a></code> for the outbound connection.</p>
|
|
81
89
|
*/
|
|
82
90
|
ConnectionStatus?: InboundCrossClusterSearchConnectionStatus;
|
|
@@ -87,6 +95,7 @@ export interface InboundCrossClusterSearchConnection {
|
|
|
87
95
|
*/
|
|
88
96
|
export interface AcceptInboundCrossClusterSearchConnectionResponse {
|
|
89
97
|
/**
|
|
98
|
+
* @public
|
|
90
99
|
* <p>Specifies the <code><a>InboundCrossClusterSearchConnection</a></code> of accepted inbound connection. </p>
|
|
91
100
|
*/
|
|
92
101
|
CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
|
|
@@ -158,22 +167,27 @@ export type OptionState = (typeof OptionState)[keyof typeof OptionState];
|
|
|
158
167
|
*/
|
|
159
168
|
export interface OptionStatus {
|
|
160
169
|
/**
|
|
170
|
+
* @public
|
|
161
171
|
* <p>Timestamp which tells the creation date for the entity.</p>
|
|
162
172
|
*/
|
|
163
173
|
CreationDate: Date | undefined;
|
|
164
174
|
/**
|
|
175
|
+
* @public
|
|
165
176
|
* <p>Timestamp which tells the last updated time for the entity.</p>
|
|
166
177
|
*/
|
|
167
178
|
UpdateDate: Date | undefined;
|
|
168
179
|
/**
|
|
180
|
+
* @public
|
|
169
181
|
* <p>Specifies the latest version for the entity.</p>
|
|
170
182
|
*/
|
|
171
183
|
UpdateVersion?: number;
|
|
172
184
|
/**
|
|
185
|
+
* @public
|
|
173
186
|
* <p>Provides the <code>OptionState</code> for the Elasticsearch domain.</p>
|
|
174
187
|
*/
|
|
175
188
|
State: OptionState | string | undefined;
|
|
176
189
|
/**
|
|
190
|
+
* @public
|
|
177
191
|
* <p>Indicates whether the Elasticsearch domain is being deleted.</p>
|
|
178
192
|
*/
|
|
179
193
|
PendingDeletion?: boolean;
|
|
@@ -184,11 +198,13 @@ export interface OptionStatus {
|
|
|
184
198
|
*/
|
|
185
199
|
export interface AccessPoliciesStatus {
|
|
186
200
|
/**
|
|
201
|
+
* @public
|
|
187
202
|
* <p>The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies" target="_blank">
|
|
188
203
|
* Configuring Access Policies</a>for more information.</p>
|
|
189
204
|
*/
|
|
190
205
|
Options: string | undefined;
|
|
191
206
|
/**
|
|
207
|
+
* @public
|
|
192
208
|
* <p>The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>
|
|
193
209
|
*/
|
|
194
210
|
Status: OptionStatus | undefined;
|
|
@@ -205,6 +221,7 @@ export interface AccessPoliciesStatus {
|
|
|
205
221
|
*/
|
|
206
222
|
export interface AdditionalLimit {
|
|
207
223
|
/**
|
|
224
|
+
* @public
|
|
208
225
|
* <p>
|
|
209
226
|
* Name of Additional Limit is specific to a given InstanceType and for each of it's
|
|
210
227
|
* <code>
|
|
@@ -234,6 +251,7 @@ export interface AdditionalLimit {
|
|
|
234
251
|
*/
|
|
235
252
|
LimitName?: string;
|
|
236
253
|
/**
|
|
254
|
+
* @public
|
|
237
255
|
* <p>
|
|
238
256
|
* Value for given
|
|
239
257
|
* <code>
|
|
@@ -250,10 +268,12 @@ export interface AdditionalLimit {
|
|
|
250
268
|
*/
|
|
251
269
|
export interface Tag {
|
|
252
270
|
/**
|
|
271
|
+
* @public
|
|
253
272
|
* <p>Specifies the <code>TagKey</code>, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.</p>
|
|
254
273
|
*/
|
|
255
274
|
Key: string | undefined;
|
|
256
275
|
/**
|
|
276
|
+
* @public
|
|
257
277
|
* <p>Specifies the <code>TagValue</code>, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value
|
|
258
278
|
* pair in a tag set of <code>project : Trinity</code> and <code>cost-center : Trinity</code></p>
|
|
259
279
|
*/
|
|
@@ -265,10 +285,12 @@ export interface Tag {
|
|
|
265
285
|
*/
|
|
266
286
|
export interface AddTagsRequest {
|
|
267
287
|
/**
|
|
288
|
+
* @public
|
|
268
289
|
* <p> Specify the <code>ARN</code> for which you want to add the tags.</p>
|
|
269
290
|
*/
|
|
270
291
|
ARN: string | undefined;
|
|
271
292
|
/**
|
|
293
|
+
* @public
|
|
272
294
|
* <p> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </p>
|
|
273
295
|
*/
|
|
274
296
|
TagList: Tag[] | undefined;
|
|
@@ -321,10 +343,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
321
343
|
*/
|
|
322
344
|
export interface AdvancedOptionsStatus {
|
|
323
345
|
/**
|
|
346
|
+
* @public
|
|
324
347
|
* <p> Specifies the status of advanced options for the specified Elasticsearch domain.</p>
|
|
325
348
|
*/
|
|
326
349
|
Options: Record<string, string> | undefined;
|
|
327
350
|
/**
|
|
351
|
+
* @public
|
|
328
352
|
* <p> Specifies the status of <code>OptionStatus</code> for advanced options for the specified Elasticsearch domain.</p>
|
|
329
353
|
*/
|
|
330
354
|
Status: OptionStatus | undefined;
|
|
@@ -335,10 +359,12 @@ export interface AdvancedOptionsStatus {
|
|
|
335
359
|
*/
|
|
336
360
|
export interface SAMLIdp {
|
|
337
361
|
/**
|
|
362
|
+
* @public
|
|
338
363
|
* <p>The Metadata of the SAML application in xml format.</p>
|
|
339
364
|
*/
|
|
340
365
|
MetadataContent: string | undefined;
|
|
341
366
|
/**
|
|
367
|
+
* @public
|
|
342
368
|
* <p>The unique Entity ID of the application in SAML Identity Provider.</p>
|
|
343
369
|
*/
|
|
344
370
|
EntityId: string | undefined;
|
|
@@ -349,22 +375,27 @@ export interface SAMLIdp {
|
|
|
349
375
|
*/
|
|
350
376
|
export interface SAMLOptionsOutput {
|
|
351
377
|
/**
|
|
378
|
+
* @public
|
|
352
379
|
* <p>True if SAML is enabled.</p>
|
|
353
380
|
*/
|
|
354
381
|
Enabled?: boolean;
|
|
355
382
|
/**
|
|
383
|
+
* @public
|
|
356
384
|
* <p>Describes the SAML Identity Provider's information.</p>
|
|
357
385
|
*/
|
|
358
386
|
Idp?: SAMLIdp;
|
|
359
387
|
/**
|
|
388
|
+
* @public
|
|
360
389
|
* <p>The key used for matching the SAML Subject attribute.</p>
|
|
361
390
|
*/
|
|
362
391
|
SubjectKey?: string;
|
|
363
392
|
/**
|
|
393
|
+
* @public
|
|
364
394
|
* <p>The key used for matching the SAML Roles attribute.</p>
|
|
365
395
|
*/
|
|
366
396
|
RolesKey?: string;
|
|
367
397
|
/**
|
|
398
|
+
* @public
|
|
368
399
|
* <p>The duration, in minutes, after which a user session becomes inactive.</p>
|
|
369
400
|
*/
|
|
370
401
|
SessionTimeoutMinutes?: number;
|
|
@@ -375,22 +406,27 @@ export interface SAMLOptionsOutput {
|
|
|
375
406
|
*/
|
|
376
407
|
export interface AdvancedSecurityOptions {
|
|
377
408
|
/**
|
|
409
|
+
* @public
|
|
378
410
|
* <p>True if advanced security is enabled.</p>
|
|
379
411
|
*/
|
|
380
412
|
Enabled?: boolean;
|
|
381
413
|
/**
|
|
414
|
+
* @public
|
|
382
415
|
* <p>True if the internal user database is enabled.</p>
|
|
383
416
|
*/
|
|
384
417
|
InternalUserDatabaseEnabled?: boolean;
|
|
385
418
|
/**
|
|
419
|
+
* @public
|
|
386
420
|
* <p>Describes the SAML application configured for a domain.</p>
|
|
387
421
|
*/
|
|
388
422
|
SAMLOptions?: SAMLOptionsOutput;
|
|
389
423
|
/**
|
|
424
|
+
* @public
|
|
390
425
|
* <p>Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.</p>
|
|
391
426
|
*/
|
|
392
427
|
AnonymousAuthDisableDate?: Date;
|
|
393
428
|
/**
|
|
429
|
+
* @public
|
|
394
430
|
* <p>True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.</p>
|
|
395
431
|
*/
|
|
396
432
|
AnonymousAuthEnabled?: boolean;
|
|
@@ -401,14 +437,17 @@ export interface AdvancedSecurityOptions {
|
|
|
401
437
|
*/
|
|
402
438
|
export interface MasterUserOptions {
|
|
403
439
|
/**
|
|
440
|
+
* @public
|
|
404
441
|
* <p>ARN for the master user (if IAM is enabled).</p>
|
|
405
442
|
*/
|
|
406
443
|
MasterUserARN?: string;
|
|
407
444
|
/**
|
|
445
|
+
* @public
|
|
408
446
|
* <p>The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>
|
|
409
447
|
*/
|
|
410
448
|
MasterUserName?: string;
|
|
411
449
|
/**
|
|
450
|
+
* @public
|
|
412
451
|
* <p>The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>
|
|
413
452
|
*/
|
|
414
453
|
MasterUserPassword?: string;
|
|
@@ -419,30 +458,37 @@ export interface MasterUserOptions {
|
|
|
419
458
|
*/
|
|
420
459
|
export interface SAMLOptionsInput {
|
|
421
460
|
/**
|
|
461
|
+
* @public
|
|
422
462
|
* <p>True if SAML is enabled.</p>
|
|
423
463
|
*/
|
|
424
464
|
Enabled?: boolean;
|
|
425
465
|
/**
|
|
466
|
+
* @public
|
|
426
467
|
* <p>Specifies the SAML Identity Provider's information.</p>
|
|
427
468
|
*/
|
|
428
469
|
Idp?: SAMLIdp;
|
|
429
470
|
/**
|
|
471
|
+
* @public
|
|
430
472
|
* <p>The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>
|
|
431
473
|
*/
|
|
432
474
|
MasterUserName?: string;
|
|
433
475
|
/**
|
|
476
|
+
* @public
|
|
434
477
|
* <p>The backend role to which the SAML master user is mapped to.</p>
|
|
435
478
|
*/
|
|
436
479
|
MasterBackendRole?: string;
|
|
437
480
|
/**
|
|
481
|
+
* @public
|
|
438
482
|
* <p>The key to use for matching the SAML Subject attribute.</p>
|
|
439
483
|
*/
|
|
440
484
|
SubjectKey?: string;
|
|
441
485
|
/**
|
|
486
|
+
* @public
|
|
442
487
|
* <p>The key to use for matching the SAML Roles attribute.</p>
|
|
443
488
|
*/
|
|
444
489
|
RolesKey?: string;
|
|
445
490
|
/**
|
|
491
|
+
* @public
|
|
446
492
|
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.</p>
|
|
447
493
|
*/
|
|
448
494
|
SessionTimeoutMinutes?: number;
|
|
@@ -453,22 +499,27 @@ export interface SAMLOptionsInput {
|
|
|
453
499
|
*/
|
|
454
500
|
export interface AdvancedSecurityOptionsInput {
|
|
455
501
|
/**
|
|
502
|
+
* @public
|
|
456
503
|
* <p>True if advanced security is enabled.</p>
|
|
457
504
|
*/
|
|
458
505
|
Enabled?: boolean;
|
|
459
506
|
/**
|
|
507
|
+
* @public
|
|
460
508
|
* <p>True if the internal user database is enabled.</p>
|
|
461
509
|
*/
|
|
462
510
|
InternalUserDatabaseEnabled?: boolean;
|
|
463
511
|
/**
|
|
512
|
+
* @public
|
|
464
513
|
* <p>Credentials for the master user: username and password, ARN, or both.</p>
|
|
465
514
|
*/
|
|
466
515
|
MasterUserOptions?: MasterUserOptions;
|
|
467
516
|
/**
|
|
517
|
+
* @public
|
|
468
518
|
* <p>Specifies the SAML application configuration for the domain.</p>
|
|
469
519
|
*/
|
|
470
520
|
SAMLOptions?: SAMLOptionsInput;
|
|
471
521
|
/**
|
|
522
|
+
* @public
|
|
472
523
|
* <p>True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.</p>
|
|
473
524
|
*/
|
|
474
525
|
AnonymousAuthEnabled?: boolean;
|
|
@@ -479,10 +530,12 @@ export interface AdvancedSecurityOptionsInput {
|
|
|
479
530
|
*/
|
|
480
531
|
export interface AdvancedSecurityOptionsStatus {
|
|
481
532
|
/**
|
|
533
|
+
* @public
|
|
482
534
|
* <p> Specifies advanced security options for the specified Elasticsearch domain.</p>
|
|
483
535
|
*/
|
|
484
536
|
Options: AdvancedSecurityOptions | undefined;
|
|
485
537
|
/**
|
|
538
|
+
* @public
|
|
486
539
|
* <p> Status of the advanced security options for the specified Elasticsearch domain.</p>
|
|
487
540
|
*/
|
|
488
541
|
Status: OptionStatus | undefined;
|
|
@@ -499,10 +552,12 @@ export interface AdvancedSecurityOptionsStatus {
|
|
|
499
552
|
*/
|
|
500
553
|
export interface AssociatePackageRequest {
|
|
501
554
|
/**
|
|
555
|
+
* @public
|
|
502
556
|
* <p>Internal ID of the package that you want to associate with a domain. Use <code>DescribePackages</code> to find this value.</p>
|
|
503
557
|
*/
|
|
504
558
|
PackageID: string | undefined;
|
|
505
559
|
/**
|
|
560
|
+
* @public
|
|
506
561
|
* <p>Name of the domain that you want to associate the package with.</p>
|
|
507
562
|
*/
|
|
508
563
|
DomainName: string | undefined;
|
|
@@ -546,35 +601,43 @@ export type PackageType = (typeof PackageType)[keyof typeof PackageType];
|
|
|
546
601
|
*/
|
|
547
602
|
export interface DomainPackageDetails {
|
|
548
603
|
/**
|
|
604
|
+
* @public
|
|
549
605
|
* <p>Internal ID of the package.</p>
|
|
550
606
|
*/
|
|
551
607
|
PackageID?: string;
|
|
552
608
|
/**
|
|
609
|
+
* @public
|
|
553
610
|
* <p>User specified name of the package.</p>
|
|
554
611
|
*/
|
|
555
612
|
PackageName?: string;
|
|
556
613
|
/**
|
|
614
|
+
* @public
|
|
557
615
|
* <p>Currently supports only TXT-DICTIONARY.</p>
|
|
558
616
|
*/
|
|
559
617
|
PackageType?: PackageType | string;
|
|
560
618
|
/**
|
|
619
|
+
* @public
|
|
561
620
|
* <p>Timestamp of the most-recent update to the association status.</p>
|
|
562
621
|
*/
|
|
563
622
|
LastUpdated?: Date;
|
|
564
623
|
/**
|
|
624
|
+
* @public
|
|
565
625
|
* <p>Name of the domain you've associated a package with.</p>
|
|
566
626
|
*/
|
|
567
627
|
DomainName?: string;
|
|
568
628
|
/**
|
|
629
|
+
* @public
|
|
569
630
|
* <p>State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.</p>
|
|
570
631
|
*/
|
|
571
632
|
DomainPackageStatus?: DomainPackageStatus | string;
|
|
572
633
|
PackageVersion?: string;
|
|
573
634
|
/**
|
|
635
|
+
* @public
|
|
574
636
|
* <p>The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.</p>
|
|
575
637
|
*/
|
|
576
638
|
ReferencePath?: string;
|
|
577
639
|
/**
|
|
640
|
+
* @public
|
|
578
641
|
* <p>Additional information if the package is in an error state. Null otherwise.</p>
|
|
579
642
|
*/
|
|
580
643
|
ErrorDetails?: ErrorDetails;
|
|
@@ -591,6 +654,7 @@ export interface DomainPackageDetails {
|
|
|
591
654
|
*/
|
|
592
655
|
export interface AssociatePackageResponse {
|
|
593
656
|
/**
|
|
657
|
+
* @public
|
|
594
658
|
* <p><code>DomainPackageDetails</code></p>
|
|
595
659
|
*/
|
|
596
660
|
DomainPackageDetails?: DomainPackageDetails;
|
|
@@ -614,10 +678,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
614
678
|
*/
|
|
615
679
|
export interface AuthorizeVpcEndpointAccessRequest {
|
|
616
680
|
/**
|
|
681
|
+
* @public
|
|
617
682
|
* <p>The name of the OpenSearch Service domain to provide access to.</p>
|
|
618
683
|
*/
|
|
619
684
|
DomainName: string | undefined;
|
|
620
685
|
/**
|
|
686
|
+
* @public
|
|
621
687
|
* <p>The account ID to grant access to.</p>
|
|
622
688
|
*/
|
|
623
689
|
Account: string | undefined;
|
|
@@ -641,10 +707,12 @@ export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
|
641
707
|
*/
|
|
642
708
|
export interface AuthorizedPrincipal {
|
|
643
709
|
/**
|
|
710
|
+
* @public
|
|
644
711
|
* <p>The type of principal.</p>
|
|
645
712
|
*/
|
|
646
713
|
PrincipalType?: PrincipalType | string;
|
|
647
714
|
/**
|
|
715
|
+
* @public
|
|
648
716
|
* <p>The IAM principal that is allowed access to the domain.</p>
|
|
649
717
|
*/
|
|
650
718
|
Principal?: string;
|
|
@@ -656,6 +724,7 @@ export interface AuthorizedPrincipal {
|
|
|
656
724
|
*/
|
|
657
725
|
export interface AuthorizeVpcEndpointAccessResponse {
|
|
658
726
|
/**
|
|
727
|
+
* @public
|
|
659
728
|
* <p>Information about the account or service that was provided access to the
|
|
660
729
|
* domain.</p>
|
|
661
730
|
*/
|
|
@@ -667,6 +736,7 @@ export interface AuthorizeVpcEndpointAccessResponse {
|
|
|
667
736
|
*/
|
|
668
737
|
export interface CancelElasticsearchServiceSoftwareUpdateRequest {
|
|
669
738
|
/**
|
|
739
|
+
* @public
|
|
670
740
|
* <p>The name of the domain that you want to stop the latest service software update on.</p>
|
|
671
741
|
*/
|
|
672
742
|
DomainName: string | undefined;
|
|
@@ -692,34 +762,42 @@ export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof Deployment
|
|
|
692
762
|
*/
|
|
693
763
|
export interface ServiceSoftwareOptions {
|
|
694
764
|
/**
|
|
765
|
+
* @public
|
|
695
766
|
* <p>The current service software version that is present on the domain.</p>
|
|
696
767
|
*/
|
|
697
768
|
CurrentVersion?: string;
|
|
698
769
|
/**
|
|
770
|
+
* @public
|
|
699
771
|
* <p>The new service software version if one is available.</p>
|
|
700
772
|
*/
|
|
701
773
|
NewVersion?: string;
|
|
702
774
|
/**
|
|
775
|
+
* @public
|
|
703
776
|
* <p><code>True</code> if you are able to update you service software version. <code>False</code> if you are not able to update your service software version. </p>
|
|
704
777
|
*/
|
|
705
778
|
UpdateAvailable?: boolean;
|
|
706
779
|
/**
|
|
780
|
+
* @public
|
|
707
781
|
* <p><code>True</code> if you are able to cancel your service software version update. <code>False</code> if you are not able to cancel your service software version. </p>
|
|
708
782
|
*/
|
|
709
783
|
Cancellable?: boolean;
|
|
710
784
|
/**
|
|
785
|
+
* @public
|
|
711
786
|
* <p>The status of your service software update. This field can take the following values: <code>ELIGIBLE</code>, <code>PENDING_UPDATE</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>NOT_ELIGIBLE</code>.</p>
|
|
712
787
|
*/
|
|
713
788
|
UpdateStatus?: DeploymentStatus | string;
|
|
714
789
|
/**
|
|
790
|
+
* @public
|
|
715
791
|
* <p>The description of the <code>UpdateStatus</code>.</p>
|
|
716
792
|
*/
|
|
717
793
|
Description?: string;
|
|
718
794
|
/**
|
|
795
|
+
* @public
|
|
719
796
|
* <p>Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>
|
|
720
797
|
*/
|
|
721
798
|
AutomatedUpdateDate?: Date;
|
|
722
799
|
/**
|
|
800
|
+
* @public
|
|
723
801
|
* <p><code>True</code> if a service software is never automatically updated. <code>False</code> if a service software is automatically updated after <code>AutomatedUpdateDate</code>. </p>
|
|
724
802
|
*/
|
|
725
803
|
OptionalDeployment?: boolean;
|
|
@@ -730,6 +808,7 @@ export interface ServiceSoftwareOptions {
|
|
|
730
808
|
*/
|
|
731
809
|
export interface CancelElasticsearchServiceSoftwareUpdateResponse {
|
|
732
810
|
/**
|
|
811
|
+
* @public
|
|
733
812
|
* <p>The current status of the Elasticsearch service software update.</p>
|
|
734
813
|
*/
|
|
735
814
|
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
@@ -763,10 +842,12 @@ export type TimeUnit = (typeof TimeUnit)[keyof typeof TimeUnit];
|
|
|
763
842
|
*/
|
|
764
843
|
export interface Duration {
|
|
765
844
|
/**
|
|
845
|
+
* @public
|
|
766
846
|
* <p> Integer to specify the value of a maintenance schedule duration. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
767
847
|
*/
|
|
768
848
|
Value?: number;
|
|
769
849
|
/**
|
|
850
|
+
* @public
|
|
770
851
|
* <p>Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
771
852
|
*/
|
|
772
853
|
Unit?: TimeUnit | string;
|
|
@@ -777,14 +858,17 @@ export interface Duration {
|
|
|
777
858
|
*/
|
|
778
859
|
export interface AutoTuneMaintenanceSchedule {
|
|
779
860
|
/**
|
|
861
|
+
* @public
|
|
780
862
|
* <p>Specifies timestamp at which Auto-Tune maintenance schedule start. </p>
|
|
781
863
|
*/
|
|
782
864
|
StartAt?: Date;
|
|
783
865
|
/**
|
|
866
|
+
* @public
|
|
784
867
|
* <p>Specifies maintenance schedule duration: duration value and duration unit. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
785
868
|
*/
|
|
786
869
|
Duration?: Duration;
|
|
787
870
|
/**
|
|
871
|
+
* @public
|
|
788
872
|
* <p>Specifies cron expression for a recurring maintenance schedule. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
789
873
|
*/
|
|
790
874
|
CronExpressionForRecurrence?: string;
|
|
@@ -795,10 +879,12 @@ export interface AutoTuneMaintenanceSchedule {
|
|
|
795
879
|
*/
|
|
796
880
|
export interface AutoTuneOptionsInput {
|
|
797
881
|
/**
|
|
882
|
+
* @public
|
|
798
883
|
* <p>Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. </p>
|
|
799
884
|
*/
|
|
800
885
|
DesiredState?: AutoTuneDesiredState | string;
|
|
801
886
|
/**
|
|
887
|
+
* @public
|
|
802
888
|
* <p>Specifies list of maitenance schedules. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
803
889
|
*/
|
|
804
890
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[];
|
|
@@ -809,18 +895,22 @@ export interface AutoTuneOptionsInput {
|
|
|
809
895
|
*/
|
|
810
896
|
export interface CognitoOptions {
|
|
811
897
|
/**
|
|
898
|
+
* @public
|
|
812
899
|
* <p>Specifies the option to enable Cognito for Kibana authentication.</p>
|
|
813
900
|
*/
|
|
814
901
|
Enabled?: boolean;
|
|
815
902
|
/**
|
|
903
|
+
* @public
|
|
816
904
|
* <p>Specifies the Cognito user pool ID for Kibana authentication.</p>
|
|
817
905
|
*/
|
|
818
906
|
UserPoolId?: string;
|
|
819
907
|
/**
|
|
908
|
+
* @public
|
|
820
909
|
* <p>Specifies the Cognito identity pool ID for Kibana authentication.</p>
|
|
821
910
|
*/
|
|
822
911
|
IdentityPoolId?: string;
|
|
823
912
|
/**
|
|
913
|
+
* @public
|
|
824
914
|
* <p>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</p>
|
|
825
915
|
*/
|
|
826
916
|
RoleArn?: string;
|
|
@@ -843,10 +933,12 @@ export type TLSSecurityPolicy = (typeof TLSSecurityPolicy)[keyof typeof TLSSecur
|
|
|
843
933
|
*/
|
|
844
934
|
export interface DomainEndpointOptions {
|
|
845
935
|
/**
|
|
936
|
+
* @public
|
|
846
937
|
* <p>Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.</p>
|
|
847
938
|
*/
|
|
848
939
|
EnforceHTTPS?: boolean;
|
|
849
940
|
/**
|
|
941
|
+
* @public
|
|
850
942
|
* <p>Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
|
|
851
943
|
* <br></br> It can be one of the following values:
|
|
852
944
|
* <ul>
|
|
@@ -857,14 +949,17 @@ export interface DomainEndpointOptions {
|
|
|
857
949
|
*/
|
|
858
950
|
TLSSecurityPolicy?: TLSSecurityPolicy | string;
|
|
859
951
|
/**
|
|
952
|
+
* @public
|
|
860
953
|
* <p>Specify if custom endpoint should be enabled for the Elasticsearch domain.</p>
|
|
861
954
|
*/
|
|
862
955
|
CustomEndpointEnabled?: boolean;
|
|
863
956
|
/**
|
|
957
|
+
* @public
|
|
864
958
|
* <p>Specify the fully qualified domain for your custom endpoint.</p>
|
|
865
959
|
*/
|
|
866
960
|
CustomEndpoint?: string;
|
|
867
961
|
/**
|
|
962
|
+
* @public
|
|
868
963
|
* <p>Specify ACM certificate ARN for your custom endpoint.</p>
|
|
869
964
|
*/
|
|
870
965
|
CustomEndpointCertificateArn?: string;
|
|
@@ -889,22 +984,27 @@ export type VolumeType = (typeof VolumeType)[keyof typeof VolumeType];
|
|
|
889
984
|
*/
|
|
890
985
|
export interface EBSOptions {
|
|
891
986
|
/**
|
|
987
|
+
* @public
|
|
892
988
|
* <p>Specifies whether EBS-based storage is enabled.</p>
|
|
893
989
|
*/
|
|
894
990
|
EBSEnabled?: boolean;
|
|
895
991
|
/**
|
|
992
|
+
* @public
|
|
896
993
|
* <p> Specifies the volume type for EBS-based storage.</p>
|
|
897
994
|
*/
|
|
898
995
|
VolumeType?: VolumeType | string;
|
|
899
996
|
/**
|
|
997
|
+
* @public
|
|
900
998
|
* <p> Integer to specify the size of an EBS volume.</p>
|
|
901
999
|
*/
|
|
902
1000
|
VolumeSize?: number;
|
|
903
1001
|
/**
|
|
1002
|
+
* @public
|
|
904
1003
|
* <p>Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).</p>
|
|
905
1004
|
*/
|
|
906
1005
|
Iops?: number;
|
|
907
1006
|
/**
|
|
1007
|
+
* @public
|
|
908
1008
|
* <p>Specifies the Throughput for GP3 EBS volume (SSD).</p>
|
|
909
1009
|
*/
|
|
910
1010
|
Throughput?: number;
|
|
@@ -915,6 +1015,7 @@ export interface EBSOptions {
|
|
|
915
1015
|
*/
|
|
916
1016
|
export interface ColdStorageOptions {
|
|
917
1017
|
/**
|
|
1018
|
+
* @public
|
|
918
1019
|
* <p>Enable cold storage option. Accepted values true or false</p>
|
|
919
1020
|
*/
|
|
920
1021
|
Enabled: boolean | undefined;
|
|
@@ -1005,6 +1106,7 @@ export type ESWarmPartitionInstanceType = (typeof ESWarmPartitionInstanceType)[k
|
|
|
1005
1106
|
*/
|
|
1006
1107
|
export interface ZoneAwarenessConfig {
|
|
1007
1108
|
/**
|
|
1109
|
+
* @public
|
|
1008
1110
|
* <p>An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled</p>
|
|
1009
1111
|
*/
|
|
1010
1112
|
AvailabilityZoneCount?: number;
|
|
@@ -1015,46 +1117,57 @@ export interface ZoneAwarenessConfig {
|
|
|
1015
1117
|
*/
|
|
1016
1118
|
export interface ElasticsearchClusterConfig {
|
|
1017
1119
|
/**
|
|
1120
|
+
* @public
|
|
1018
1121
|
* <p>The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.</p>
|
|
1019
1122
|
*/
|
|
1020
1123
|
InstanceType?: ESPartitionInstanceType | string;
|
|
1021
1124
|
/**
|
|
1125
|
+
* @public
|
|
1022
1126
|
* <p>The number of instances in the specified domain cluster.</p>
|
|
1023
1127
|
*/
|
|
1024
1128
|
InstanceCount?: number;
|
|
1025
1129
|
/**
|
|
1130
|
+
* @public
|
|
1026
1131
|
* <p>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</p>
|
|
1027
1132
|
*/
|
|
1028
1133
|
DedicatedMasterEnabled?: boolean;
|
|
1029
1134
|
/**
|
|
1135
|
+
* @public
|
|
1030
1136
|
* <p>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</p>
|
|
1031
1137
|
*/
|
|
1032
1138
|
ZoneAwarenessEnabled?: boolean;
|
|
1033
1139
|
/**
|
|
1140
|
+
* @public
|
|
1034
1141
|
* <p>Specifies the zone awareness configuration for a domain when zone awareness is enabled.</p>
|
|
1035
1142
|
*/
|
|
1036
1143
|
ZoneAwarenessConfig?: ZoneAwarenessConfig;
|
|
1037
1144
|
/**
|
|
1145
|
+
* @public
|
|
1038
1146
|
* <p>The instance type for a dedicated master node.</p>
|
|
1039
1147
|
*/
|
|
1040
1148
|
DedicatedMasterType?: ESPartitionInstanceType | string;
|
|
1041
1149
|
/**
|
|
1150
|
+
* @public
|
|
1042
1151
|
* <p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>
|
|
1043
1152
|
*/
|
|
1044
1153
|
DedicatedMasterCount?: number;
|
|
1045
1154
|
/**
|
|
1155
|
+
* @public
|
|
1046
1156
|
* <p>True to enable warm storage.</p>
|
|
1047
1157
|
*/
|
|
1048
1158
|
WarmEnabled?: boolean;
|
|
1049
1159
|
/**
|
|
1160
|
+
* @public
|
|
1050
1161
|
* <p>The instance type for the Elasticsearch cluster's warm nodes.</p>
|
|
1051
1162
|
*/
|
|
1052
1163
|
WarmType?: ESWarmPartitionInstanceType | string;
|
|
1053
1164
|
/**
|
|
1165
|
+
* @public
|
|
1054
1166
|
* <p>The number of warm nodes in the cluster.</p>
|
|
1055
1167
|
*/
|
|
1056
1168
|
WarmCount?: number;
|
|
1057
1169
|
/**
|
|
1170
|
+
* @public
|
|
1058
1171
|
* <p>Specifies the <code>ColdStorageOptions</code> config for Elasticsearch Domain</p>
|
|
1059
1172
|
*/
|
|
1060
1173
|
ColdStorageOptions?: ColdStorageOptions;
|
|
@@ -1065,10 +1178,12 @@ export interface ElasticsearchClusterConfig {
|
|
|
1065
1178
|
*/
|
|
1066
1179
|
export interface EncryptionAtRestOptions {
|
|
1067
1180
|
/**
|
|
1181
|
+
* @public
|
|
1068
1182
|
* <p>Specifies the option to enable Encryption At Rest.</p>
|
|
1069
1183
|
*/
|
|
1070
1184
|
Enabled?: boolean;
|
|
1071
1185
|
/**
|
|
1186
|
+
* @public
|
|
1072
1187
|
* <p> Specifies the KMS Key ID for Encryption At Rest options.</p>
|
|
1073
1188
|
*/
|
|
1074
1189
|
KmsKeyId?: string;
|
|
@@ -1099,10 +1214,12 @@ export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
|
1099
1214
|
*/
|
|
1100
1215
|
export interface LogPublishingOption {
|
|
1101
1216
|
/**
|
|
1217
|
+
* @public
|
|
1102
1218
|
* <p>ARN of the Cloudwatch log group to which log needs to be published.</p>
|
|
1103
1219
|
*/
|
|
1104
1220
|
CloudWatchLogsLogGroupArn?: string;
|
|
1105
1221
|
/**
|
|
1222
|
+
* @public
|
|
1106
1223
|
* <p> Specifies whether given log publishing option is enabled or not.</p>
|
|
1107
1224
|
*/
|
|
1108
1225
|
Enabled?: boolean;
|
|
@@ -1113,6 +1230,7 @@ export interface LogPublishingOption {
|
|
|
1113
1230
|
*/
|
|
1114
1231
|
export interface NodeToNodeEncryptionOptions {
|
|
1115
1232
|
/**
|
|
1233
|
+
* @public
|
|
1116
1234
|
* <p>Specify true to enable node-to-node encryption.</p>
|
|
1117
1235
|
*/
|
|
1118
1236
|
Enabled?: boolean;
|
|
@@ -1123,6 +1241,7 @@ export interface NodeToNodeEncryptionOptions {
|
|
|
1123
1241
|
*/
|
|
1124
1242
|
export interface SnapshotOptions {
|
|
1125
1243
|
/**
|
|
1244
|
+
* @public
|
|
1126
1245
|
* <p>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</p>
|
|
1127
1246
|
*/
|
|
1128
1247
|
AutomatedSnapshotStartHour?: number;
|
|
@@ -1133,10 +1252,12 @@ export interface SnapshotOptions {
|
|
|
1133
1252
|
*/
|
|
1134
1253
|
export interface VPCOptions {
|
|
1135
1254
|
/**
|
|
1255
|
+
* @public
|
|
1136
1256
|
* <p>Specifies the subnets for VPC endpoint.</p>
|
|
1137
1257
|
*/
|
|
1138
1258
|
SubnetIds?: string[];
|
|
1139
1259
|
/**
|
|
1260
|
+
* @public
|
|
1140
1261
|
* <p>Specifies the security groups for VPC endpoint.</p>
|
|
1141
1262
|
*/
|
|
1142
1263
|
SecurityGroupIds?: string[];
|
|
@@ -1146,68 +1267,84 @@ export interface VPCOptions {
|
|
|
1146
1267
|
*/
|
|
1147
1268
|
export interface CreateElasticsearchDomainRequest {
|
|
1148
1269
|
/**
|
|
1270
|
+
* @public
|
|
1149
1271
|
* <p>The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
1150
1272
|
*/
|
|
1151
1273
|
DomainName: string | undefined;
|
|
1152
1274
|
/**
|
|
1275
|
+
* @public
|
|
1153
1276
|
* <p>String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information,
|
|
1154
1277
|
* see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>
|
|
1155
1278
|
*/
|
|
1156
1279
|
ElasticsearchVersion?: string;
|
|
1157
1280
|
/**
|
|
1281
|
+
* @public
|
|
1158
1282
|
* <p>Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. </p>
|
|
1159
1283
|
*/
|
|
1160
1284
|
ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
|
|
1161
1285
|
/**
|
|
1286
|
+
* @public
|
|
1162
1287
|
* <p>Options to enable, disable and specify the type and size of EBS storage volumes. </p>
|
|
1163
1288
|
*/
|
|
1164
1289
|
EBSOptions?: EBSOptions;
|
|
1165
1290
|
/**
|
|
1291
|
+
* @public
|
|
1166
1292
|
* <p> IAM access policy as a JSON-formatted string.</p>
|
|
1167
1293
|
*/
|
|
1168
1294
|
AccessPolicies?: string;
|
|
1169
1295
|
/**
|
|
1296
|
+
* @public
|
|
1170
1297
|
* <p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. </p>
|
|
1171
1298
|
*/
|
|
1172
1299
|
SnapshotOptions?: SnapshotOptions;
|
|
1173
1300
|
/**
|
|
1301
|
+
* @public
|
|
1174
1302
|
* <p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc" target="_blank">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>
|
|
1175
1303
|
*/
|
|
1176
1304
|
VPCOptions?: VPCOptions;
|
|
1177
1305
|
/**
|
|
1306
|
+
* @public
|
|
1178
1307
|
* <p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>
|
|
1179
1308
|
*/
|
|
1180
1309
|
CognitoOptions?: CognitoOptions;
|
|
1181
1310
|
/**
|
|
1311
|
+
* @public
|
|
1182
1312
|
* <p>Specifies the Encryption At Rest Options.</p>
|
|
1183
1313
|
*/
|
|
1184
1314
|
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
1185
1315
|
/**
|
|
1316
|
+
* @public
|
|
1186
1317
|
* <p>Specifies the NodeToNodeEncryptionOptions.</p>
|
|
1187
1318
|
*/
|
|
1188
1319
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
1189
1320
|
/**
|
|
1321
|
+
* @public
|
|
1190
1322
|
* <p> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>.
|
|
1191
1323
|
* See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</p>
|
|
1192
1324
|
*/
|
|
1193
1325
|
AdvancedOptions?: Record<string, string>;
|
|
1194
1326
|
/**
|
|
1327
|
+
* @public
|
|
1195
1328
|
* <p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>
|
|
1196
1329
|
*/
|
|
1197
1330
|
LogPublishingOptions?: Record<string, LogPublishingOption>;
|
|
1198
1331
|
/**
|
|
1332
|
+
* @public
|
|
1199
1333
|
* <p>Options to specify configuration that will be applied to the domain endpoint.</p>
|
|
1200
1334
|
*/
|
|
1201
1335
|
DomainEndpointOptions?: DomainEndpointOptions;
|
|
1202
1336
|
/**
|
|
1337
|
+
* @public
|
|
1203
1338
|
* <p>Specifies advanced security options.</p>
|
|
1204
1339
|
*/
|
|
1205
1340
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
|
|
1206
1341
|
/**
|
|
1342
|
+
* @public
|
|
1207
1343
|
* <p>Specifies Auto-Tune options.</p>
|
|
1208
1344
|
*/
|
|
1209
1345
|
AutoTuneOptions?: AutoTuneOptionsInput;
|
|
1210
1346
|
/**
|
|
1347
|
+
* @public
|
|
1211
1348
|
* <p>A list of <code>Tag</code> added during domain creation.</p>
|
|
1212
1349
|
*/
|
|
1213
1350
|
TagList?: Tag[];
|
|
@@ -1237,10 +1374,12 @@ export type AutoTuneState = (typeof AutoTuneState)[keyof typeof AutoTuneState];
|
|
|
1237
1374
|
*/
|
|
1238
1375
|
export interface AutoTuneOptionsOutput {
|
|
1239
1376
|
/**
|
|
1377
|
+
* @public
|
|
1240
1378
|
* <p>Specifies the <code>AutoTuneState</code> for the Elasticsearch domain.</p>
|
|
1241
1379
|
*/
|
|
1242
1380
|
State?: AutoTuneState | string;
|
|
1243
1381
|
/**
|
|
1382
|
+
* @public
|
|
1244
1383
|
* <p>Specifies the error message while enabling or disabling the Auto-Tune.</p>
|
|
1245
1384
|
*/
|
|
1246
1385
|
ErrorMessage?: string;
|
|
@@ -1251,10 +1390,12 @@ export interface AutoTuneOptionsOutput {
|
|
|
1251
1390
|
*/
|
|
1252
1391
|
export interface ChangeProgressDetails {
|
|
1253
1392
|
/**
|
|
1393
|
+
* @public
|
|
1254
1394
|
* <p>The unique change identifier associated with a specific domain configuration change.</p>
|
|
1255
1395
|
*/
|
|
1256
1396
|
ChangeId?: string;
|
|
1257
1397
|
/**
|
|
1398
|
+
* @public
|
|
1258
1399
|
* <p>Contains an optional message associated with the domain configuration change.</p>
|
|
1259
1400
|
*/
|
|
1260
1401
|
Message?: string;
|
|
@@ -1265,18 +1406,22 @@ export interface ChangeProgressDetails {
|
|
|
1265
1406
|
*/
|
|
1266
1407
|
export interface VPCDerivedInfo {
|
|
1267
1408
|
/**
|
|
1409
|
+
* @public
|
|
1268
1410
|
* <p>The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.</p>
|
|
1269
1411
|
*/
|
|
1270
1412
|
VPCId?: string;
|
|
1271
1413
|
/**
|
|
1414
|
+
* @public
|
|
1272
1415
|
* <p>Specifies the subnets for VPC endpoint.</p>
|
|
1273
1416
|
*/
|
|
1274
1417
|
SubnetIds?: string[];
|
|
1275
1418
|
/**
|
|
1419
|
+
* @public
|
|
1276
1420
|
* <p>The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.</p>
|
|
1277
1421
|
*/
|
|
1278
1422
|
AvailabilityZones?: string[];
|
|
1279
1423
|
/**
|
|
1424
|
+
* @public
|
|
1280
1425
|
* <p>Specifies the security groups for VPC endpoint.</p>
|
|
1281
1426
|
*/
|
|
1282
1427
|
SecurityGroupIds?: string[];
|
|
@@ -1287,99 +1432,123 @@ export interface VPCDerivedInfo {
|
|
|
1287
1432
|
*/
|
|
1288
1433
|
export interface ElasticsearchDomainStatus {
|
|
1289
1434
|
/**
|
|
1435
|
+
* @public
|
|
1290
1436
|
* <p>The unique identifier for the specified Elasticsearch domain.</p>
|
|
1291
1437
|
*/
|
|
1292
1438
|
DomainId: string | undefined;
|
|
1293
1439
|
/**
|
|
1440
|
+
* @public
|
|
1294
1441
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
1295
1442
|
*/
|
|
1296
1443
|
DomainName: string | undefined;
|
|
1297
1444
|
/**
|
|
1445
|
+
* @public
|
|
1298
1446
|
* <p>The Amazon resource name (ARN) of an Elasticsearch domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>
|
|
1299
1447
|
*/
|
|
1300
1448
|
ARN: string | undefined;
|
|
1301
1449
|
/**
|
|
1450
|
+
* @public
|
|
1302
1451
|
* <p>The domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.</p>
|
|
1303
1452
|
*/
|
|
1304
1453
|
Created?: boolean;
|
|
1305
1454
|
/**
|
|
1455
|
+
* @public
|
|
1306
1456
|
* <p>The domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.</p>
|
|
1307
1457
|
*/
|
|
1308
1458
|
Deleted?: boolean;
|
|
1309
1459
|
/**
|
|
1460
|
+
* @public
|
|
1310
1461
|
* <p>The Elasticsearch domain endpoint that you use to submit index and search requests.</p>
|
|
1311
1462
|
*/
|
|
1312
1463
|
Endpoint?: string;
|
|
1313
1464
|
/**
|
|
1465
|
+
* @public
|
|
1314
1466
|
* <p>Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>
|
|
1315
1467
|
*/
|
|
1316
1468
|
Endpoints?: Record<string, string>;
|
|
1317
1469
|
/**
|
|
1470
|
+
* @public
|
|
1318
1471
|
* <p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>
|
|
1319
1472
|
*/
|
|
1320
1473
|
Processing?: boolean;
|
|
1321
1474
|
/**
|
|
1475
|
+
* @public
|
|
1322
1476
|
* <p>The status of an Elasticsearch domain version upgrade. <code>True</code> if Amazon Elasticsearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active.</p>
|
|
1323
1477
|
*/
|
|
1324
1478
|
UpgradeProcessing?: boolean;
|
|
1325
1479
|
ElasticsearchVersion?: string;
|
|
1326
1480
|
/**
|
|
1481
|
+
* @public
|
|
1327
1482
|
* <p>The type and number of instances in the domain cluster.</p>
|
|
1328
1483
|
*/
|
|
1329
1484
|
ElasticsearchClusterConfig: ElasticsearchClusterConfig | undefined;
|
|
1330
1485
|
/**
|
|
1486
|
+
* @public
|
|
1331
1487
|
* <p>The <code>EBSOptions</code> for the specified domain. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs" target="_blank">Configuring EBS-based Storage</a> for more information.</p>
|
|
1332
1488
|
*/
|
|
1333
1489
|
EBSOptions?: EBSOptions;
|
|
1334
1490
|
/**
|
|
1491
|
+
* @public
|
|
1335
1492
|
* <p> IAM access policy as a JSON-formatted string.</p>
|
|
1336
1493
|
*/
|
|
1337
1494
|
AccessPolicies?: string;
|
|
1338
1495
|
/**
|
|
1496
|
+
* @public
|
|
1339
1497
|
* <p>Specifies the status of the <code>SnapshotOptions</code></p>
|
|
1340
1498
|
*/
|
|
1341
1499
|
SnapshotOptions?: SnapshotOptions;
|
|
1342
1500
|
/**
|
|
1501
|
+
* @public
|
|
1343
1502
|
* <p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html" target="_blank">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>
|
|
1344
1503
|
*/
|
|
1345
1504
|
VPCOptions?: VPCDerivedInfo;
|
|
1346
1505
|
/**
|
|
1506
|
+
* @public
|
|
1347
1507
|
* <p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>
|
|
1348
1508
|
*/
|
|
1349
1509
|
CognitoOptions?: CognitoOptions;
|
|
1350
1510
|
/**
|
|
1511
|
+
* @public
|
|
1351
1512
|
* <p> Specifies the status of the <code>EncryptionAtRestOptions</code>.</p>
|
|
1352
1513
|
*/
|
|
1353
1514
|
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
1354
1515
|
/**
|
|
1516
|
+
* @public
|
|
1355
1517
|
* <p>Specifies the status of the <code>NodeToNodeEncryptionOptions</code>.</p>
|
|
1356
1518
|
*/
|
|
1357
1519
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
1358
1520
|
/**
|
|
1521
|
+
* @public
|
|
1359
1522
|
* <p>Specifies the status of the <code>AdvancedOptions</code></p>
|
|
1360
1523
|
*/
|
|
1361
1524
|
AdvancedOptions?: Record<string, string>;
|
|
1362
1525
|
/**
|
|
1526
|
+
* @public
|
|
1363
1527
|
* <p>Log publishing options for the given domain.</p>
|
|
1364
1528
|
*/
|
|
1365
1529
|
LogPublishingOptions?: Record<string, LogPublishingOption>;
|
|
1366
1530
|
/**
|
|
1531
|
+
* @public
|
|
1367
1532
|
* <p>The current status of the Elasticsearch domain's service software.</p>
|
|
1368
1533
|
*/
|
|
1369
1534
|
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
1370
1535
|
/**
|
|
1536
|
+
* @public
|
|
1371
1537
|
* <p>The current status of the Elasticsearch domain's endpoint options.</p>
|
|
1372
1538
|
*/
|
|
1373
1539
|
DomainEndpointOptions?: DomainEndpointOptions;
|
|
1374
1540
|
/**
|
|
1541
|
+
* @public
|
|
1375
1542
|
* <p>The current status of the Elasticsearch domain's advanced security options.</p>
|
|
1376
1543
|
*/
|
|
1377
1544
|
AdvancedSecurityOptions?: AdvancedSecurityOptions;
|
|
1378
1545
|
/**
|
|
1546
|
+
* @public
|
|
1379
1547
|
* <p>The current status of the Elasticsearch domain's Auto-Tune options.</p>
|
|
1380
1548
|
*/
|
|
1381
1549
|
AutoTuneOptions?: AutoTuneOptionsOutput;
|
|
1382
1550
|
/**
|
|
1551
|
+
* @public
|
|
1383
1552
|
* <p>Specifies change details of the domain configuration change.</p>
|
|
1384
1553
|
*/
|
|
1385
1554
|
ChangeProgressDetails?: ChangeProgressDetails;
|
|
@@ -1390,6 +1559,7 @@ export interface ElasticsearchDomainStatus {
|
|
|
1390
1559
|
*/
|
|
1391
1560
|
export interface CreateElasticsearchDomainResponse {
|
|
1392
1561
|
/**
|
|
1562
|
+
* @public
|
|
1393
1563
|
* <p>The status of the newly created Elasticsearch domain. </p>
|
|
1394
1564
|
*/
|
|
1395
1565
|
DomainStatus?: ElasticsearchDomainStatus;
|
|
@@ -1424,14 +1594,17 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1424
1594
|
*/
|
|
1425
1595
|
export interface CreateOutboundCrossClusterSearchConnectionRequest {
|
|
1426
1596
|
/**
|
|
1597
|
+
* @public
|
|
1427
1598
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the source Elasticsearch domain.</p>
|
|
1428
1599
|
*/
|
|
1429
1600
|
SourceDomainInfo: DomainInformation | undefined;
|
|
1430
1601
|
/**
|
|
1602
|
+
* @public
|
|
1431
1603
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the destination Elasticsearch domain.</p>
|
|
1432
1604
|
*/
|
|
1433
1605
|
DestinationDomainInfo: DomainInformation | undefined;
|
|
1434
1606
|
/**
|
|
1607
|
+
* @public
|
|
1435
1608
|
* <p>Specifies the connection alias that will be used by the customer for this connection.</p>
|
|
1436
1609
|
*/
|
|
1437
1610
|
ConnectionAlias: string | undefined;
|
|
@@ -1460,6 +1633,7 @@ export type OutboundCrossClusterSearchConnectionStatusCode = (typeof OutboundCro
|
|
|
1460
1633
|
*/
|
|
1461
1634
|
export interface OutboundCrossClusterSearchConnectionStatus {
|
|
1462
1635
|
/**
|
|
1636
|
+
* @public
|
|
1463
1637
|
* <p>The state code for outbound connection. This can be one of the following:</p>
|
|
1464
1638
|
* <ul>
|
|
1465
1639
|
* <li>VALIDATING: The outbound connection request is being validated.</li>
|
|
@@ -1474,6 +1648,7 @@ export interface OutboundCrossClusterSearchConnectionStatus {
|
|
|
1474
1648
|
*/
|
|
1475
1649
|
StatusCode?: OutboundCrossClusterSearchConnectionStatusCode | string;
|
|
1476
1650
|
/**
|
|
1651
|
+
* @public
|
|
1477
1652
|
* <p>Specifies verbose information for the outbound connection status.</p>
|
|
1478
1653
|
*/
|
|
1479
1654
|
Message?: string;
|
|
@@ -1484,22 +1659,27 @@ export interface OutboundCrossClusterSearchConnectionStatus {
|
|
|
1484
1659
|
*/
|
|
1485
1660
|
export interface CreateOutboundCrossClusterSearchConnectionResponse {
|
|
1486
1661
|
/**
|
|
1662
|
+
* @public
|
|
1487
1663
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the source Elasticsearch domain.</p>
|
|
1488
1664
|
*/
|
|
1489
1665
|
SourceDomainInfo?: DomainInformation;
|
|
1490
1666
|
/**
|
|
1667
|
+
* @public
|
|
1491
1668
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the destination Elasticsearch domain.</p>
|
|
1492
1669
|
*/
|
|
1493
1670
|
DestinationDomainInfo?: DomainInformation;
|
|
1494
1671
|
/**
|
|
1672
|
+
* @public
|
|
1495
1673
|
* <p>Specifies the connection alias provided during the create connection request.</p>
|
|
1496
1674
|
*/
|
|
1497
1675
|
ConnectionAlias?: string;
|
|
1498
1676
|
/**
|
|
1677
|
+
* @public
|
|
1499
1678
|
* <p>Specifies the <code><a>OutboundCrossClusterSearchConnectionStatus</a></code> for the newly created connection.</p>
|
|
1500
1679
|
*/
|
|
1501
1680
|
ConnectionStatus?: OutboundCrossClusterSearchConnectionStatus;
|
|
1502
1681
|
/**
|
|
1682
|
+
* @public
|
|
1503
1683
|
* <p>Unique id for the created outbound connection, which is used for subsequent operations on connection.</p>
|
|
1504
1684
|
*/
|
|
1505
1685
|
CrossClusterSearchConnectionId?: string;
|
|
@@ -1510,10 +1690,12 @@ export interface CreateOutboundCrossClusterSearchConnectionResponse {
|
|
|
1510
1690
|
*/
|
|
1511
1691
|
export interface PackageSource {
|
|
1512
1692
|
/**
|
|
1693
|
+
* @public
|
|
1513
1694
|
* <p>Name of the bucket containing the package.</p>
|
|
1514
1695
|
*/
|
|
1515
1696
|
S3BucketName?: string;
|
|
1516
1697
|
/**
|
|
1698
|
+
* @public
|
|
1517
1699
|
* <p>Key (file name) of the package.</p>
|
|
1518
1700
|
*/
|
|
1519
1701
|
S3Key?: string;
|
|
@@ -1530,18 +1712,22 @@ export interface PackageSource {
|
|
|
1530
1712
|
*/
|
|
1531
1713
|
export interface CreatePackageRequest {
|
|
1532
1714
|
/**
|
|
1715
|
+
* @public
|
|
1533
1716
|
* <p>Unique identifier for the package.</p>
|
|
1534
1717
|
*/
|
|
1535
1718
|
PackageName: string | undefined;
|
|
1536
1719
|
/**
|
|
1720
|
+
* @public
|
|
1537
1721
|
* <p>Type of package. Currently supports only TXT-DICTIONARY.</p>
|
|
1538
1722
|
*/
|
|
1539
1723
|
PackageType: PackageType | string | undefined;
|
|
1540
1724
|
/**
|
|
1725
|
+
* @public
|
|
1541
1726
|
* <p>Description of the package.</p>
|
|
1542
1727
|
*/
|
|
1543
1728
|
PackageDescription?: string;
|
|
1544
1729
|
/**
|
|
1730
|
+
* @public
|
|
1545
1731
|
* <p>The customer S3 location <code>PackageSource</code> for importing the package.</p>
|
|
1546
1732
|
*/
|
|
1547
1733
|
PackageSource: PackageSource | undefined;
|
|
@@ -1570,32 +1756,39 @@ export type PackageStatus = (typeof PackageStatus)[keyof typeof PackageStatus];
|
|
|
1570
1756
|
*/
|
|
1571
1757
|
export interface PackageDetails {
|
|
1572
1758
|
/**
|
|
1759
|
+
* @public
|
|
1573
1760
|
* <p>Internal ID of the package.</p>
|
|
1574
1761
|
*/
|
|
1575
1762
|
PackageID?: string;
|
|
1576
1763
|
/**
|
|
1764
|
+
* @public
|
|
1577
1765
|
* <p>User specified name of the package.</p>
|
|
1578
1766
|
*/
|
|
1579
1767
|
PackageName?: string;
|
|
1580
1768
|
/**
|
|
1769
|
+
* @public
|
|
1581
1770
|
* <p>Currently supports only TXT-DICTIONARY.</p>
|
|
1582
1771
|
*/
|
|
1583
1772
|
PackageType?: PackageType | string;
|
|
1584
1773
|
/**
|
|
1774
|
+
* @public
|
|
1585
1775
|
* <p>User-specified description of the package.</p>
|
|
1586
1776
|
*/
|
|
1587
1777
|
PackageDescription?: string;
|
|
1588
1778
|
/**
|
|
1779
|
+
* @public
|
|
1589
1780
|
* <p>Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED</p>
|
|
1590
1781
|
*/
|
|
1591
1782
|
PackageStatus?: PackageStatus | string;
|
|
1592
1783
|
/**
|
|
1784
|
+
* @public
|
|
1593
1785
|
* <p>Timestamp which tells creation date of the package.</p>
|
|
1594
1786
|
*/
|
|
1595
1787
|
CreatedAt?: Date;
|
|
1596
1788
|
LastUpdatedAt?: Date;
|
|
1597
1789
|
AvailablePackageVersion?: string;
|
|
1598
1790
|
/**
|
|
1791
|
+
* @public
|
|
1599
1792
|
* <p>Additional information if the package is in an error state. Null otherwise.</p>
|
|
1600
1793
|
*/
|
|
1601
1794
|
ErrorDetails?: ErrorDetails;
|
|
@@ -1612,6 +1805,7 @@ export interface PackageDetails {
|
|
|
1612
1805
|
*/
|
|
1613
1806
|
export interface CreatePackageResponse {
|
|
1614
1807
|
/**
|
|
1808
|
+
* @public
|
|
1615
1809
|
* <p>Information about the package <code>PackageDetails</code>.</p>
|
|
1616
1810
|
*/
|
|
1617
1811
|
PackageDetails?: PackageDetails;
|
|
@@ -1622,14 +1816,17 @@ export interface CreatePackageResponse {
|
|
|
1622
1816
|
*/
|
|
1623
1817
|
export interface CreateVpcEndpointRequest {
|
|
1624
1818
|
/**
|
|
1819
|
+
* @public
|
|
1625
1820
|
* <p>The Amazon Resource Name (ARN) of the domain to grant access to.</p>
|
|
1626
1821
|
*/
|
|
1627
1822
|
DomainArn: string | undefined;
|
|
1628
1823
|
/**
|
|
1824
|
+
* @public
|
|
1629
1825
|
* <p>Options to specify the subnets and security groups for the endpoint.</p>
|
|
1630
1826
|
*/
|
|
1631
1827
|
VpcOptions: VPCOptions | undefined;
|
|
1632
1828
|
/**
|
|
1829
|
+
* @public
|
|
1633
1830
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
1634
1831
|
*/
|
|
1635
1832
|
ClientToken?: string;
|
|
@@ -1658,27 +1855,33 @@ export type VpcEndpointStatus = (typeof VpcEndpointStatus)[keyof typeof VpcEndpo
|
|
|
1658
1855
|
*/
|
|
1659
1856
|
export interface VpcEndpoint {
|
|
1660
1857
|
/**
|
|
1858
|
+
* @public
|
|
1661
1859
|
* <p>The unique identifier of the endpoint.</p>
|
|
1662
1860
|
*/
|
|
1663
1861
|
VpcEndpointId?: string;
|
|
1664
1862
|
/**
|
|
1863
|
+
* @public
|
|
1665
1864
|
* <p>The creator of the endpoint.</p>
|
|
1666
1865
|
*/
|
|
1667
1866
|
VpcEndpointOwner?: string;
|
|
1668
1867
|
/**
|
|
1868
|
+
* @public
|
|
1669
1869
|
* <p>The Amazon Resource Name (ARN) of the domain associated with the endpoint.</p>
|
|
1670
1870
|
*/
|
|
1671
1871
|
DomainArn?: string;
|
|
1672
1872
|
/**
|
|
1873
|
+
* @public
|
|
1673
1874
|
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC
|
|
1674
1875
|
* endpoint.</p>
|
|
1675
1876
|
*/
|
|
1676
1877
|
VpcOptions?: VPCDerivedInfo;
|
|
1677
1878
|
/**
|
|
1879
|
+
* @public
|
|
1678
1880
|
* <p>The current status of the endpoint.</p>
|
|
1679
1881
|
*/
|
|
1680
1882
|
Status?: VpcEndpointStatus | string;
|
|
1681
1883
|
/**
|
|
1884
|
+
* @public
|
|
1682
1885
|
* <p>The connection endpoint ID for connecting to the domain.</p>
|
|
1683
1886
|
*/
|
|
1684
1887
|
Endpoint?: string;
|
|
@@ -1689,6 +1892,7 @@ export interface VpcEndpoint {
|
|
|
1689
1892
|
*/
|
|
1690
1893
|
export interface CreateVpcEndpointResponse {
|
|
1691
1894
|
/**
|
|
1895
|
+
* @public
|
|
1692
1896
|
* <p>Information about the newly created VPC endpoint.</p>
|
|
1693
1897
|
*/
|
|
1694
1898
|
VpcEndpoint: VpcEndpoint | undefined;
|
|
@@ -1699,6 +1903,7 @@ export interface CreateVpcEndpointResponse {
|
|
|
1699
1903
|
*/
|
|
1700
1904
|
export interface DeleteElasticsearchDomainRequest {
|
|
1701
1905
|
/**
|
|
1906
|
+
* @public
|
|
1702
1907
|
* <p>The name of the Elasticsearch domain that you want to permanently delete.</p>
|
|
1703
1908
|
*/
|
|
1704
1909
|
DomainName: string | undefined;
|
|
@@ -1709,6 +1914,7 @@ export interface DeleteElasticsearchDomainRequest {
|
|
|
1709
1914
|
*/
|
|
1710
1915
|
export interface DeleteElasticsearchDomainResponse {
|
|
1711
1916
|
/**
|
|
1917
|
+
* @public
|
|
1712
1918
|
* <p>The status of the Elasticsearch domain being deleted.</p>
|
|
1713
1919
|
*/
|
|
1714
1920
|
DomainStatus?: ElasticsearchDomainStatus;
|
|
@@ -1719,6 +1925,7 @@ export interface DeleteElasticsearchDomainResponse {
|
|
|
1719
1925
|
*/
|
|
1720
1926
|
export interface DeleteInboundCrossClusterSearchConnectionRequest {
|
|
1721
1927
|
/**
|
|
1928
|
+
* @public
|
|
1722
1929
|
* <p>The id of the inbound connection that you want to permanently delete.</p>
|
|
1723
1930
|
*/
|
|
1724
1931
|
CrossClusterSearchConnectionId: string | undefined;
|
|
@@ -1729,6 +1936,7 @@ export interface DeleteInboundCrossClusterSearchConnectionRequest {
|
|
|
1729
1936
|
*/
|
|
1730
1937
|
export interface DeleteInboundCrossClusterSearchConnectionResponse {
|
|
1731
1938
|
/**
|
|
1939
|
+
* @public
|
|
1732
1940
|
* <p>Specifies the <code><a>InboundCrossClusterSearchConnection</a></code> of deleted inbound connection. </p>
|
|
1733
1941
|
*/
|
|
1734
1942
|
CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
|
|
@@ -1739,6 +1947,7 @@ export interface DeleteInboundCrossClusterSearchConnectionResponse {
|
|
|
1739
1947
|
*/
|
|
1740
1948
|
export interface DeleteOutboundCrossClusterSearchConnectionRequest {
|
|
1741
1949
|
/**
|
|
1950
|
+
* @public
|
|
1742
1951
|
* <p>The id of the outbound connection that you want to permanently delete.</p>
|
|
1743
1952
|
*/
|
|
1744
1953
|
CrossClusterSearchConnectionId: string | undefined;
|
|
@@ -1749,22 +1958,27 @@ export interface DeleteOutboundCrossClusterSearchConnectionRequest {
|
|
|
1749
1958
|
*/
|
|
1750
1959
|
export interface OutboundCrossClusterSearchConnection {
|
|
1751
1960
|
/**
|
|
1961
|
+
* @public
|
|
1752
1962
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the source Elasticsearch domain.</p>
|
|
1753
1963
|
*/
|
|
1754
1964
|
SourceDomainInfo?: DomainInformation;
|
|
1755
1965
|
/**
|
|
1966
|
+
* @public
|
|
1756
1967
|
* <p>Specifies the <code><a>DomainInformation</a></code> for the destination Elasticsearch domain.</p>
|
|
1757
1968
|
*/
|
|
1758
1969
|
DestinationDomainInfo?: DomainInformation;
|
|
1759
1970
|
/**
|
|
1971
|
+
* @public
|
|
1760
1972
|
* <p>Specifies the connection id for the outbound cross-cluster search connection.</p>
|
|
1761
1973
|
*/
|
|
1762
1974
|
CrossClusterSearchConnectionId?: string;
|
|
1763
1975
|
/**
|
|
1976
|
+
* @public
|
|
1764
1977
|
* <p>Specifies the connection alias for the outbound cross-cluster search connection.</p>
|
|
1765
1978
|
*/
|
|
1766
1979
|
ConnectionAlias?: string;
|
|
1767
1980
|
/**
|
|
1981
|
+
* @public
|
|
1768
1982
|
* <p>Specifies the <code><a>OutboundCrossClusterSearchConnectionStatus</a></code> for the outbound connection.</p>
|
|
1769
1983
|
*/
|
|
1770
1984
|
ConnectionStatus?: OutboundCrossClusterSearchConnectionStatus;
|
|
@@ -1775,6 +1989,7 @@ export interface OutboundCrossClusterSearchConnection {
|
|
|
1775
1989
|
*/
|
|
1776
1990
|
export interface DeleteOutboundCrossClusterSearchConnectionResponse {
|
|
1777
1991
|
/**
|
|
1992
|
+
* @public
|
|
1778
1993
|
* <p>Specifies the <code><a>OutboundCrossClusterSearchConnection</a></code> of deleted outbound connection. </p>
|
|
1779
1994
|
*/
|
|
1780
1995
|
CrossClusterSearchConnection?: OutboundCrossClusterSearchConnection;
|
|
@@ -1791,6 +2006,7 @@ export interface DeleteOutboundCrossClusterSearchConnectionResponse {
|
|
|
1791
2006
|
*/
|
|
1792
2007
|
export interface DeletePackageRequest {
|
|
1793
2008
|
/**
|
|
2009
|
+
* @public
|
|
1794
2010
|
* <p>Internal ID of the package that you want to delete. Use <code>DescribePackages</code> to find this value.</p>
|
|
1795
2011
|
*/
|
|
1796
2012
|
PackageID: string | undefined;
|
|
@@ -1807,6 +2023,7 @@ export interface DeletePackageRequest {
|
|
|
1807
2023
|
*/
|
|
1808
2024
|
export interface DeletePackageResponse {
|
|
1809
2025
|
/**
|
|
2026
|
+
* @public
|
|
1810
2027
|
* <p><code>PackageDetails</code></p>
|
|
1811
2028
|
*/
|
|
1812
2029
|
PackageDetails?: PackageDetails;
|
|
@@ -1817,6 +2034,7 @@ export interface DeletePackageResponse {
|
|
|
1817
2034
|
*/
|
|
1818
2035
|
export interface DeleteVpcEndpointRequest {
|
|
1819
2036
|
/**
|
|
2037
|
+
* @public
|
|
1820
2038
|
* <p>The unique identifier of the endpoint to be deleted.</p>
|
|
1821
2039
|
*/
|
|
1822
2040
|
VpcEndpointId: string | undefined;
|
|
@@ -1827,18 +2045,22 @@ export interface DeleteVpcEndpointRequest {
|
|
|
1827
2045
|
*/
|
|
1828
2046
|
export interface VpcEndpointSummary {
|
|
1829
2047
|
/**
|
|
2048
|
+
* @public
|
|
1830
2049
|
* <p>The unique identifier of the endpoint.</p>
|
|
1831
2050
|
*/
|
|
1832
2051
|
VpcEndpointId?: string;
|
|
1833
2052
|
/**
|
|
2053
|
+
* @public
|
|
1834
2054
|
* <p>The creator of the endpoint.</p>
|
|
1835
2055
|
*/
|
|
1836
2056
|
VpcEndpointOwner?: string;
|
|
1837
2057
|
/**
|
|
2058
|
+
* @public
|
|
1838
2059
|
* <p>The Amazon Resource Name (ARN) of the domain associated with the endpoint.</p>
|
|
1839
2060
|
*/
|
|
1840
2061
|
DomainArn?: string;
|
|
1841
2062
|
/**
|
|
2063
|
+
* @public
|
|
1842
2064
|
* <p>The current status of the endpoint.</p>
|
|
1843
2065
|
*/
|
|
1844
2066
|
Status?: VpcEndpointStatus | string;
|
|
@@ -1849,6 +2071,7 @@ export interface VpcEndpointSummary {
|
|
|
1849
2071
|
*/
|
|
1850
2072
|
export interface DeleteVpcEndpointResponse {
|
|
1851
2073
|
/**
|
|
2074
|
+
* @public
|
|
1852
2075
|
* <p>Information about the deleted endpoint, including its current status (<code>DELETING</code>
|
|
1853
2076
|
* or <code>DELETE_FAILED</code>).</p>
|
|
1854
2077
|
*/
|
|
@@ -1860,14 +2083,17 @@ export interface DeleteVpcEndpointResponse {
|
|
|
1860
2083
|
*/
|
|
1861
2084
|
export interface DescribeDomainAutoTunesRequest {
|
|
1862
2085
|
/**
|
|
2086
|
+
* @public
|
|
1863
2087
|
* <p>Specifies the domain name for which you want Auto-Tune action details.</p>
|
|
1864
2088
|
*/
|
|
1865
2089
|
DomainName: string | undefined;
|
|
1866
2090
|
/**
|
|
2091
|
+
* @public
|
|
1867
2092
|
* <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
|
|
1868
2093
|
*/
|
|
1869
2094
|
MaxResults?: number;
|
|
1870
2095
|
/**
|
|
2096
|
+
* @public
|
|
1871
2097
|
* <p>NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>
|
|
1872
2098
|
*/
|
|
1873
2099
|
NextToken?: string;
|
|
@@ -1903,18 +2129,22 @@ export type ScheduledAutoTuneSeverityType = (typeof ScheduledAutoTuneSeverityTyp
|
|
|
1903
2129
|
*/
|
|
1904
2130
|
export interface ScheduledAutoTuneDetails {
|
|
1905
2131
|
/**
|
|
2132
|
+
* @public
|
|
1906
2133
|
* <p>Specifies timestamp for the Auto-Tune action scheduled for the domain. </p>
|
|
1907
2134
|
*/
|
|
1908
2135
|
Date?: Date;
|
|
1909
2136
|
/**
|
|
2137
|
+
* @public
|
|
1910
2138
|
* <p>Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING. </p>
|
|
1911
2139
|
*/
|
|
1912
2140
|
ActionType?: ScheduledAutoTuneActionType | string;
|
|
1913
2141
|
/**
|
|
2142
|
+
* @public
|
|
1914
2143
|
* <p>Specifies Auto-Tune action description. </p>
|
|
1915
2144
|
*/
|
|
1916
2145
|
Action?: string;
|
|
1917
2146
|
/**
|
|
2147
|
+
* @public
|
|
1918
2148
|
* <p>Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH. </p>
|
|
1919
2149
|
*/
|
|
1920
2150
|
Severity?: ScheduledAutoTuneSeverityType | string;
|
|
@@ -1925,6 +2155,7 @@ export interface ScheduledAutoTuneDetails {
|
|
|
1925
2155
|
*/
|
|
1926
2156
|
export interface AutoTuneDetails {
|
|
1927
2157
|
/**
|
|
2158
|
+
* @public
|
|
1928
2159
|
* <p>Specifies details of the scheduled Auto-Tune action. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information. </p>
|
|
1929
2160
|
*/
|
|
1930
2161
|
ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails;
|
|
@@ -1946,10 +2177,12 @@ export type AutoTuneType = (typeof AutoTuneType)[keyof typeof AutoTuneType];
|
|
|
1946
2177
|
*/
|
|
1947
2178
|
export interface AutoTune {
|
|
1948
2179
|
/**
|
|
2180
|
+
* @public
|
|
1949
2181
|
* <p>Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. </p>
|
|
1950
2182
|
*/
|
|
1951
2183
|
AutoTuneType?: AutoTuneType | string;
|
|
1952
2184
|
/**
|
|
2185
|
+
* @public
|
|
1953
2186
|
* <p>Specifies details of the Auto-Tune action. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information. </p>
|
|
1954
2187
|
*/
|
|
1955
2188
|
AutoTuneDetails?: AutoTuneDetails;
|
|
@@ -1960,10 +2193,12 @@ export interface AutoTune {
|
|
|
1960
2193
|
*/
|
|
1961
2194
|
export interface DescribeDomainAutoTunesResponse {
|
|
1962
2195
|
/**
|
|
2196
|
+
* @public
|
|
1963
2197
|
* <p>Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
1964
2198
|
*/
|
|
1965
2199
|
AutoTunes?: AutoTune[];
|
|
1966
2200
|
/**
|
|
2201
|
+
* @public
|
|
1967
2202
|
* <p>Specifies an identifier to allow retrieval of paginated results.</p>
|
|
1968
2203
|
*/
|
|
1969
2204
|
NextToken?: string;
|
|
@@ -1976,10 +2211,12 @@ export interface DescribeDomainAutoTunesResponse {
|
|
|
1976
2211
|
*/
|
|
1977
2212
|
export interface DescribeDomainChangeProgressRequest {
|
|
1978
2213
|
/**
|
|
2214
|
+
* @public
|
|
1979
2215
|
* <p>The domain you want to get the progress information about.</p>
|
|
1980
2216
|
*/
|
|
1981
2217
|
DomainName: string | undefined;
|
|
1982
2218
|
/**
|
|
2219
|
+
* @public
|
|
1983
2220
|
* <p>The specific change ID for which you want to get progress information. This is an optional parameter.
|
|
1984
2221
|
* If omitted, the service returns information about the most recent configuration change.
|
|
1985
2222
|
* </p>
|
|
@@ -1992,18 +2229,22 @@ export interface DescribeDomainChangeProgressRequest {
|
|
|
1992
2229
|
*/
|
|
1993
2230
|
export interface ChangeProgressStage {
|
|
1994
2231
|
/**
|
|
2232
|
+
* @public
|
|
1995
2233
|
* <p>The name of the specific progress stage.</p>
|
|
1996
2234
|
*/
|
|
1997
2235
|
Name?: string;
|
|
1998
2236
|
/**
|
|
2237
|
+
* @public
|
|
1999
2238
|
* <p>The overall status of a specific progress stage.</p>
|
|
2000
2239
|
*/
|
|
2001
2240
|
Status?: string;
|
|
2002
2241
|
/**
|
|
2242
|
+
* @public
|
|
2003
2243
|
* <p>The description of the progress stage.</p>
|
|
2004
2244
|
*/
|
|
2005
2245
|
Description?: string;
|
|
2006
2246
|
/**
|
|
2247
|
+
* @public
|
|
2007
2248
|
* <p>The last updated timestamp of the progress stage.</p>
|
|
2008
2249
|
*/
|
|
2009
2250
|
LastUpdated?: Date;
|
|
@@ -2028,30 +2269,37 @@ export type OverallChangeStatus = (typeof OverallChangeStatus)[keyof typeof Over
|
|
|
2028
2269
|
*/
|
|
2029
2270
|
export interface ChangeProgressStatusDetails {
|
|
2030
2271
|
/**
|
|
2272
|
+
* @public
|
|
2031
2273
|
* <p>The unique change identifier associated with a specific domain configuration change.</p>
|
|
2032
2274
|
*/
|
|
2033
2275
|
ChangeId?: string;
|
|
2034
2276
|
/**
|
|
2277
|
+
* @public
|
|
2035
2278
|
* <p>The time at which the configuration change is made on the domain.</p>
|
|
2036
2279
|
*/
|
|
2037
2280
|
StartTime?: Date;
|
|
2038
2281
|
/**
|
|
2282
|
+
* @public
|
|
2039
2283
|
* <p>The overall status of the domain configuration change. This field can take the following values: <code>PENDING</code>, <code>PROCESSING</code>, <code>COMPLETED</code> and <code>FAILED</code></p>
|
|
2040
2284
|
*/
|
|
2041
2285
|
Status?: OverallChangeStatus | string;
|
|
2042
2286
|
/**
|
|
2287
|
+
* @public
|
|
2043
2288
|
* <p>The list of properties involved in the domain configuration change that are still in pending.</p>
|
|
2044
2289
|
*/
|
|
2045
2290
|
PendingProperties?: string[];
|
|
2046
2291
|
/**
|
|
2292
|
+
* @public
|
|
2047
2293
|
* <p>The list of properties involved in the domain configuration change that are completed.</p>
|
|
2048
2294
|
*/
|
|
2049
2295
|
CompletedProperties?: string[];
|
|
2050
2296
|
/**
|
|
2297
|
+
* @public
|
|
2051
2298
|
* <p>The total number of stages required for the configuration change.</p>
|
|
2052
2299
|
*/
|
|
2053
2300
|
TotalNumberOfStages?: number;
|
|
2054
2301
|
/**
|
|
2302
|
+
* @public
|
|
2055
2303
|
* <p>The specific stages that the domain is going through to perform the configuration change.</p>
|
|
2056
2304
|
*/
|
|
2057
2305
|
ChangeProgressStages?: ChangeProgressStage[];
|
|
@@ -2064,6 +2312,7 @@ export interface ChangeProgressStatusDetails {
|
|
|
2064
2312
|
*/
|
|
2065
2313
|
export interface DescribeDomainChangeProgressResponse {
|
|
2066
2314
|
/**
|
|
2315
|
+
* @public
|
|
2067
2316
|
* <p>Progress information for the configuration change that is requested in the <code>DescribeDomainChangeProgress</code> request.
|
|
2068
2317
|
* </p>
|
|
2069
2318
|
*/
|
|
@@ -2075,6 +2324,7 @@ export interface DescribeDomainChangeProgressResponse {
|
|
|
2075
2324
|
*/
|
|
2076
2325
|
export interface DescribeElasticsearchDomainRequest {
|
|
2077
2326
|
/**
|
|
2327
|
+
* @public
|
|
2078
2328
|
* <p>The name of the Elasticsearch domain for which you want information.</p>
|
|
2079
2329
|
*/
|
|
2080
2330
|
DomainName: string | undefined;
|
|
@@ -2085,6 +2335,7 @@ export interface DescribeElasticsearchDomainRequest {
|
|
|
2085
2335
|
*/
|
|
2086
2336
|
export interface DescribeElasticsearchDomainResponse {
|
|
2087
2337
|
/**
|
|
2338
|
+
* @public
|
|
2088
2339
|
* <p>The current status of the Elasticsearch domain.</p>
|
|
2089
2340
|
*/
|
|
2090
2341
|
DomainStatus: ElasticsearchDomainStatus | undefined;
|
|
@@ -2095,6 +2346,7 @@ export interface DescribeElasticsearchDomainResponse {
|
|
|
2095
2346
|
*/
|
|
2096
2347
|
export interface DescribeElasticsearchDomainConfigRequest {
|
|
2097
2348
|
/**
|
|
2349
|
+
* @public
|
|
2098
2350
|
* <p>The Elasticsearch domain that you want to get information about.</p>
|
|
2099
2351
|
*/
|
|
2100
2352
|
DomainName: string | undefined;
|
|
@@ -2117,14 +2369,17 @@ export type RollbackOnDisable = (typeof RollbackOnDisable)[keyof typeof Rollback
|
|
|
2117
2369
|
*/
|
|
2118
2370
|
export interface AutoTuneOptions {
|
|
2119
2371
|
/**
|
|
2372
|
+
* @public
|
|
2120
2373
|
* <p>Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. </p>
|
|
2121
2374
|
*/
|
|
2122
2375
|
DesiredState?: AutoTuneDesiredState | string;
|
|
2123
2376
|
/**
|
|
2377
|
+
* @public
|
|
2124
2378
|
* <p>Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK. </p>
|
|
2125
2379
|
*/
|
|
2126
2380
|
RollbackOnDisable?: RollbackOnDisable | string;
|
|
2127
2381
|
/**
|
|
2382
|
+
* @public
|
|
2128
2383
|
* <p>Specifies list of maitenance schedules. See the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html" target="_blank">Developer Guide</a> for more information.</p>
|
|
2129
2384
|
*/
|
|
2130
2385
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[];
|
|
@@ -2135,26 +2390,32 @@ export interface AutoTuneOptions {
|
|
|
2135
2390
|
*/
|
|
2136
2391
|
export interface AutoTuneStatus {
|
|
2137
2392
|
/**
|
|
2393
|
+
* @public
|
|
2138
2394
|
* <p>Timestamp which tells Auto-Tune options creation date .</p>
|
|
2139
2395
|
*/
|
|
2140
2396
|
CreationDate: Date | undefined;
|
|
2141
2397
|
/**
|
|
2398
|
+
* @public
|
|
2142
2399
|
* <p>Timestamp which tells Auto-Tune options last updated time.</p>
|
|
2143
2400
|
*/
|
|
2144
2401
|
UpdateDate: Date | undefined;
|
|
2145
2402
|
/**
|
|
2403
|
+
* @public
|
|
2146
2404
|
* <p>Specifies the Auto-Tune options latest version.</p>
|
|
2147
2405
|
*/
|
|
2148
2406
|
UpdateVersion?: number;
|
|
2149
2407
|
/**
|
|
2408
|
+
* @public
|
|
2150
2409
|
* <p>Specifies the <code>AutoTuneState</code> for the Elasticsearch domain.</p>
|
|
2151
2410
|
*/
|
|
2152
2411
|
State: AutoTuneState | string | undefined;
|
|
2153
2412
|
/**
|
|
2413
|
+
* @public
|
|
2154
2414
|
* <p>Specifies the error message while enabling or disabling the Auto-Tune options.</p>
|
|
2155
2415
|
*/
|
|
2156
2416
|
ErrorMessage?: string;
|
|
2157
2417
|
/**
|
|
2418
|
+
* @public
|
|
2158
2419
|
* <p>Indicates whether the Elasticsearch domain is being deleted.</p>
|
|
2159
2420
|
*/
|
|
2160
2421
|
PendingDeletion?: boolean;
|
|
@@ -2165,10 +2426,12 @@ export interface AutoTuneStatus {
|
|
|
2165
2426
|
*/
|
|
2166
2427
|
export interface AutoTuneOptionsStatus {
|
|
2167
2428
|
/**
|
|
2429
|
+
* @public
|
|
2168
2430
|
* <p> Specifies Auto-Tune options for the specified Elasticsearch domain.</p>
|
|
2169
2431
|
*/
|
|
2170
2432
|
Options?: AutoTuneOptions;
|
|
2171
2433
|
/**
|
|
2434
|
+
* @public
|
|
2172
2435
|
* <p> Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.</p>
|
|
2173
2436
|
*/
|
|
2174
2437
|
Status?: AutoTuneStatus;
|
|
@@ -2179,10 +2442,12 @@ export interface AutoTuneOptionsStatus {
|
|
|
2179
2442
|
*/
|
|
2180
2443
|
export interface CognitoOptionsStatus {
|
|
2181
2444
|
/**
|
|
2445
|
+
* @public
|
|
2182
2446
|
* <p>Specifies the Cognito options for the specified Elasticsearch domain.</p>
|
|
2183
2447
|
*/
|
|
2184
2448
|
Options: CognitoOptions | undefined;
|
|
2185
2449
|
/**
|
|
2450
|
+
* @public
|
|
2186
2451
|
* <p>Specifies the status of the Cognito options for the specified Elasticsearch domain.</p>
|
|
2187
2452
|
*/
|
|
2188
2453
|
Status: OptionStatus | undefined;
|
|
@@ -2193,10 +2458,12 @@ export interface CognitoOptionsStatus {
|
|
|
2193
2458
|
*/
|
|
2194
2459
|
export interface DomainEndpointOptionsStatus {
|
|
2195
2460
|
/**
|
|
2461
|
+
* @public
|
|
2196
2462
|
* <p>Options to configure endpoint for the Elasticsearch domain.</p>
|
|
2197
2463
|
*/
|
|
2198
2464
|
Options: DomainEndpointOptions | undefined;
|
|
2199
2465
|
/**
|
|
2466
|
+
* @public
|
|
2200
2467
|
* <p>The status of the endpoint options for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>
|
|
2201
2468
|
*/
|
|
2202
2469
|
Status: OptionStatus | undefined;
|
|
@@ -2207,10 +2474,12 @@ export interface DomainEndpointOptionsStatus {
|
|
|
2207
2474
|
*/
|
|
2208
2475
|
export interface EBSOptionsStatus {
|
|
2209
2476
|
/**
|
|
2477
|
+
* @public
|
|
2210
2478
|
* <p> Specifies the EBS options for the specified Elasticsearch domain.</p>
|
|
2211
2479
|
*/
|
|
2212
2480
|
Options: EBSOptions | undefined;
|
|
2213
2481
|
/**
|
|
2482
|
+
* @public
|
|
2214
2483
|
* <p> Specifies the status of the EBS options for the specified Elasticsearch domain.</p>
|
|
2215
2484
|
*/
|
|
2216
2485
|
Status: OptionStatus | undefined;
|
|
@@ -2221,10 +2490,12 @@ export interface EBSOptionsStatus {
|
|
|
2221
2490
|
*/
|
|
2222
2491
|
export interface ElasticsearchClusterConfigStatus {
|
|
2223
2492
|
/**
|
|
2493
|
+
* @public
|
|
2224
2494
|
* <p> Specifies the cluster configuration for the specified Elasticsearch domain.</p>
|
|
2225
2495
|
*/
|
|
2226
2496
|
Options: ElasticsearchClusterConfig | undefined;
|
|
2227
2497
|
/**
|
|
2498
|
+
* @public
|
|
2228
2499
|
* <p> Specifies the status of the configuration for the specified Elasticsearch domain.</p>
|
|
2229
2500
|
*/
|
|
2230
2501
|
Status: OptionStatus | undefined;
|
|
@@ -2235,10 +2506,12 @@ export interface ElasticsearchClusterConfigStatus {
|
|
|
2235
2506
|
*/
|
|
2236
2507
|
export interface ElasticsearchVersionStatus {
|
|
2237
2508
|
/**
|
|
2509
|
+
* @public
|
|
2238
2510
|
* <p> Specifies the Elasticsearch version for the specified Elasticsearch domain.</p>
|
|
2239
2511
|
*/
|
|
2240
2512
|
Options: string | undefined;
|
|
2241
2513
|
/**
|
|
2514
|
+
* @public
|
|
2242
2515
|
* <p> Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.</p>
|
|
2243
2516
|
*/
|
|
2244
2517
|
Status: OptionStatus | undefined;
|
|
@@ -2249,10 +2522,12 @@ export interface ElasticsearchVersionStatus {
|
|
|
2249
2522
|
*/
|
|
2250
2523
|
export interface EncryptionAtRestOptionsStatus {
|
|
2251
2524
|
/**
|
|
2525
|
+
* @public
|
|
2252
2526
|
* <p> Specifies the Encryption At Rest options for the specified Elasticsearch domain.</p>
|
|
2253
2527
|
*/
|
|
2254
2528
|
Options: EncryptionAtRestOptions | undefined;
|
|
2255
2529
|
/**
|
|
2530
|
+
* @public
|
|
2256
2531
|
* <p> Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.</p>
|
|
2257
2532
|
*/
|
|
2258
2533
|
Status: OptionStatus | undefined;
|
|
@@ -2263,10 +2538,12 @@ export interface EncryptionAtRestOptionsStatus {
|
|
|
2263
2538
|
*/
|
|
2264
2539
|
export interface LogPublishingOptionsStatus {
|
|
2265
2540
|
/**
|
|
2541
|
+
* @public
|
|
2266
2542
|
* <p>The log publishing options configured for the Elasticsearch domain.</p>
|
|
2267
2543
|
*/
|
|
2268
2544
|
Options?: Record<string, LogPublishingOption>;
|
|
2269
2545
|
/**
|
|
2546
|
+
* @public
|
|
2270
2547
|
* <p>The status of the log publishing options for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>
|
|
2271
2548
|
*/
|
|
2272
2549
|
Status?: OptionStatus;
|
|
@@ -2277,10 +2554,12 @@ export interface LogPublishingOptionsStatus {
|
|
|
2277
2554
|
*/
|
|
2278
2555
|
export interface NodeToNodeEncryptionOptionsStatus {
|
|
2279
2556
|
/**
|
|
2557
|
+
* @public
|
|
2280
2558
|
* <p>Specifies the node-to-node encryption options for the specified Elasticsearch domain.</p>
|
|
2281
2559
|
*/
|
|
2282
2560
|
Options: NodeToNodeEncryptionOptions | undefined;
|
|
2283
2561
|
/**
|
|
2562
|
+
* @public
|
|
2284
2563
|
* <p>Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.</p>
|
|
2285
2564
|
*/
|
|
2286
2565
|
Status: OptionStatus | undefined;
|
|
@@ -2291,10 +2570,12 @@ export interface NodeToNodeEncryptionOptionsStatus {
|
|
|
2291
2570
|
*/
|
|
2292
2571
|
export interface SnapshotOptionsStatus {
|
|
2293
2572
|
/**
|
|
2573
|
+
* @public
|
|
2294
2574
|
* <p>Specifies the daily snapshot options specified for the Elasticsearch domain.</p>
|
|
2295
2575
|
*/
|
|
2296
2576
|
Options: SnapshotOptions | undefined;
|
|
2297
2577
|
/**
|
|
2578
|
+
* @public
|
|
2298
2579
|
* <p>Specifies the status of a daily automated snapshot.</p>
|
|
2299
2580
|
*/
|
|
2300
2581
|
Status: OptionStatus | undefined;
|
|
@@ -2305,10 +2586,12 @@ export interface SnapshotOptionsStatus {
|
|
|
2305
2586
|
*/
|
|
2306
2587
|
export interface VPCDerivedInfoStatus {
|
|
2307
2588
|
/**
|
|
2589
|
+
* @public
|
|
2308
2590
|
* <p> Specifies the VPC options for the specified Elasticsearch domain.</p>
|
|
2309
2591
|
*/
|
|
2310
2592
|
Options: VPCDerivedInfo | undefined;
|
|
2311
2593
|
/**
|
|
2594
|
+
* @public
|
|
2312
2595
|
* <p> Specifies the status of the VPC options for the specified Elasticsearch domain.</p>
|
|
2313
2596
|
*/
|
|
2314
2597
|
Status: OptionStatus | undefined;
|
|
@@ -2319,62 +2602,77 @@ export interface VPCDerivedInfoStatus {
|
|
|
2319
2602
|
*/
|
|
2320
2603
|
export interface ElasticsearchDomainConfig {
|
|
2321
2604
|
/**
|
|
2605
|
+
* @public
|
|
2322
2606
|
* <p>String of format X.Y to specify version for the Elasticsearch domain.</p>
|
|
2323
2607
|
*/
|
|
2324
2608
|
ElasticsearchVersion?: ElasticsearchVersionStatus;
|
|
2325
2609
|
/**
|
|
2610
|
+
* @public
|
|
2326
2611
|
* <p>Specifies the <code>ElasticsearchClusterConfig</code> for the Elasticsearch domain.</p>
|
|
2327
2612
|
*/
|
|
2328
2613
|
ElasticsearchClusterConfig?: ElasticsearchClusterConfigStatus;
|
|
2329
2614
|
/**
|
|
2615
|
+
* @public
|
|
2330
2616
|
* <p>Specifies the <code>EBSOptions</code> for the Elasticsearch domain.</p>
|
|
2331
2617
|
*/
|
|
2332
2618
|
EBSOptions?: EBSOptionsStatus;
|
|
2333
2619
|
/**
|
|
2620
|
+
* @public
|
|
2334
2621
|
* <p>IAM access policy as a JSON-formatted string.</p>
|
|
2335
2622
|
*/
|
|
2336
2623
|
AccessPolicies?: AccessPoliciesStatus;
|
|
2337
2624
|
/**
|
|
2625
|
+
* @public
|
|
2338
2626
|
* <p>Specifies the <code>SnapshotOptions</code> for the Elasticsearch domain.</p>
|
|
2339
2627
|
*/
|
|
2340
2628
|
SnapshotOptions?: SnapshotOptionsStatus;
|
|
2341
2629
|
/**
|
|
2630
|
+
* @public
|
|
2342
2631
|
* <p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html" target="_blank">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>
|
|
2343
2632
|
*/
|
|
2344
2633
|
VPCOptions?: VPCDerivedInfoStatus;
|
|
2345
2634
|
/**
|
|
2635
|
+
* @public
|
|
2346
2636
|
* <p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>
|
|
2347
2637
|
*/
|
|
2348
2638
|
CognitoOptions?: CognitoOptionsStatus;
|
|
2349
2639
|
/**
|
|
2640
|
+
* @public
|
|
2350
2641
|
* <p>Specifies the <code>EncryptionAtRestOptions</code> for the Elasticsearch domain.</p>
|
|
2351
2642
|
*/
|
|
2352
2643
|
EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus;
|
|
2353
2644
|
/**
|
|
2645
|
+
* @public
|
|
2354
2646
|
* <p>Specifies the <code>NodeToNodeEncryptionOptions</code> for the Elasticsearch domain.</p>
|
|
2355
2647
|
*/
|
|
2356
2648
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus;
|
|
2357
2649
|
/**
|
|
2650
|
+
* @public
|
|
2358
2651
|
* <p>Specifies the <code>AdvancedOptions</code> for the domain. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuring Advanced Options</a> for more information.</p>
|
|
2359
2652
|
*/
|
|
2360
2653
|
AdvancedOptions?: AdvancedOptionsStatus;
|
|
2361
2654
|
/**
|
|
2655
|
+
* @public
|
|
2362
2656
|
* <p>Log publishing options for the given domain.</p>
|
|
2363
2657
|
*/
|
|
2364
2658
|
LogPublishingOptions?: LogPublishingOptionsStatus;
|
|
2365
2659
|
/**
|
|
2660
|
+
* @public
|
|
2366
2661
|
* <p>Specifies the <code>DomainEndpointOptions</code> for the Elasticsearch domain.</p>
|
|
2367
2662
|
*/
|
|
2368
2663
|
DomainEndpointOptions?: DomainEndpointOptionsStatus;
|
|
2369
2664
|
/**
|
|
2665
|
+
* @public
|
|
2370
2666
|
* <p>Specifies <code>AdvancedSecurityOptions</code> for the domain. </p>
|
|
2371
2667
|
*/
|
|
2372
2668
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
|
|
2373
2669
|
/**
|
|
2670
|
+
* @public
|
|
2374
2671
|
* <p>Specifies <code>AutoTuneOptions</code> for the domain. </p>
|
|
2375
2672
|
*/
|
|
2376
2673
|
AutoTuneOptions?: AutoTuneOptionsStatus;
|
|
2377
2674
|
/**
|
|
2675
|
+
* @public
|
|
2378
2676
|
* <p>Specifies change details of the domain configuration change.</p>
|
|
2379
2677
|
*/
|
|
2380
2678
|
ChangeProgressDetails?: ChangeProgressDetails;
|
|
@@ -2385,6 +2683,7 @@ export interface ElasticsearchDomainConfig {
|
|
|
2385
2683
|
*/
|
|
2386
2684
|
export interface DescribeElasticsearchDomainConfigResponse {
|
|
2387
2685
|
/**
|
|
2686
|
+
* @public
|
|
2388
2687
|
* <p>The configuration information of the domain requested in the <code>DescribeElasticsearchDomainConfig</code> request.</p>
|
|
2389
2688
|
*/
|
|
2390
2689
|
DomainConfig: ElasticsearchDomainConfig | undefined;
|
|
@@ -2395,6 +2694,7 @@ export interface DescribeElasticsearchDomainConfigResponse {
|
|
|
2395
2694
|
*/
|
|
2396
2695
|
export interface DescribeElasticsearchDomainsRequest {
|
|
2397
2696
|
/**
|
|
2697
|
+
* @public
|
|
2398
2698
|
* <p>The Elasticsearch domains for which you want information.</p>
|
|
2399
2699
|
*/
|
|
2400
2700
|
DomainNames: string[] | undefined;
|
|
@@ -2405,6 +2705,7 @@ export interface DescribeElasticsearchDomainsRequest {
|
|
|
2405
2705
|
*/
|
|
2406
2706
|
export interface DescribeElasticsearchDomainsResponse {
|
|
2407
2707
|
/**
|
|
2708
|
+
* @public
|
|
2408
2709
|
* <p>The status of the domains requested in the <code>DescribeElasticsearchDomains</code> request.</p>
|
|
2409
2710
|
*/
|
|
2410
2711
|
DomainStatusList: ElasticsearchDomainStatus[] | undefined;
|
|
@@ -2421,6 +2722,7 @@ export interface DescribeElasticsearchDomainsResponse {
|
|
|
2421
2722
|
*/
|
|
2422
2723
|
export interface DescribeElasticsearchInstanceTypeLimitsRequest {
|
|
2423
2724
|
/**
|
|
2725
|
+
* @public
|
|
2424
2726
|
* <p>
|
|
2425
2727
|
* DomainName represents the name of the Domain that we are trying to
|
|
2426
2728
|
* modify. This should be present only if we are
|
|
@@ -2433,6 +2735,7 @@ export interface DescribeElasticsearchInstanceTypeLimitsRequest {
|
|
|
2433
2735
|
*/
|
|
2434
2736
|
DomainName?: string;
|
|
2435
2737
|
/**
|
|
2738
|
+
* @public
|
|
2436
2739
|
* <p>
|
|
2437
2740
|
* The instance type for an Elasticsearch cluster for which Elasticsearch
|
|
2438
2741
|
* <code>
|
|
@@ -2443,6 +2746,7 @@ export interface DescribeElasticsearchInstanceTypeLimitsRequest {
|
|
|
2443
2746
|
*/
|
|
2444
2747
|
InstanceType: ESPartitionInstanceType | string | undefined;
|
|
2445
2748
|
/**
|
|
2749
|
+
* @public
|
|
2446
2750
|
* <p>
|
|
2447
2751
|
* Version of Elasticsearch for which
|
|
2448
2752
|
* <code>
|
|
@@ -2462,12 +2766,14 @@ export interface DescribeElasticsearchInstanceTypeLimitsRequest {
|
|
|
2462
2766
|
*/
|
|
2463
2767
|
export interface InstanceCountLimits {
|
|
2464
2768
|
/**
|
|
2769
|
+
* @public
|
|
2465
2770
|
* <p>
|
|
2466
2771
|
* Minimum number of Instances that can be instantiated for given InstanceType.
|
|
2467
2772
|
* </p>
|
|
2468
2773
|
*/
|
|
2469
2774
|
MinimumInstanceCount?: number;
|
|
2470
2775
|
/**
|
|
2776
|
+
* @public
|
|
2471
2777
|
* <p>
|
|
2472
2778
|
* Maximum number of Instances that can be instantiated for given InstanceType.
|
|
2473
2779
|
* </p>
|
|
@@ -2481,6 +2787,7 @@ export interface InstanceCountLimits {
|
|
|
2481
2787
|
*/
|
|
2482
2788
|
export interface InstanceLimits {
|
|
2483
2789
|
/**
|
|
2790
|
+
* @public
|
|
2484
2791
|
* <p>
|
|
2485
2792
|
* InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for
|
|
2486
2793
|
* given InstanceType.
|
|
@@ -2495,6 +2802,7 @@ export interface InstanceLimits {
|
|
|
2495
2802
|
*/
|
|
2496
2803
|
export interface StorageTypeLimit {
|
|
2497
2804
|
/**
|
|
2805
|
+
* @public
|
|
2498
2806
|
* <p>
|
|
2499
2807
|
* Name of storage limits that are applicable for given storage type.
|
|
2500
2808
|
* If
|
|
@@ -2520,6 +2828,7 @@ export interface StorageTypeLimit {
|
|
|
2520
2828
|
*/
|
|
2521
2829
|
LimitName?: string;
|
|
2522
2830
|
/**
|
|
2831
|
+
* @public
|
|
2523
2832
|
* <p>
|
|
2524
2833
|
* Values for the
|
|
2525
2834
|
* <code>
|
|
@@ -2538,6 +2847,7 @@ export interface StorageTypeLimit {
|
|
|
2538
2847
|
*/
|
|
2539
2848
|
export interface StorageType {
|
|
2540
2849
|
/**
|
|
2850
|
+
* @public
|
|
2541
2851
|
* <p>
|
|
2542
2852
|
* Type of the storage.
|
|
2543
2853
|
* List of available storage options:
|
|
@@ -2549,6 +2859,7 @@ export interface StorageType {
|
|
|
2549
2859
|
*/
|
|
2550
2860
|
StorageTypeName?: string;
|
|
2551
2861
|
/**
|
|
2862
|
+
* @public
|
|
2552
2863
|
* <p>
|
|
2553
2864
|
* SubType of the given storage type.
|
|
2554
2865
|
* List of available sub-storage options:
|
|
@@ -2565,6 +2876,7 @@ export interface StorageType {
|
|
|
2565
2876
|
*/
|
|
2566
2877
|
StorageSubTypeName?: string;
|
|
2567
2878
|
/**
|
|
2879
|
+
* @public
|
|
2568
2880
|
* <p>List of limits that are applicable for given storage type.
|
|
2569
2881
|
* </p>
|
|
2570
2882
|
*/
|
|
@@ -2590,17 +2902,20 @@ export interface StorageType {
|
|
|
2590
2902
|
*/
|
|
2591
2903
|
export interface Limits {
|
|
2592
2904
|
/**
|
|
2905
|
+
* @public
|
|
2593
2906
|
* <p>StorageType represents the list of storage related types and attributes
|
|
2594
2907
|
* that are available for given InstanceType.
|
|
2595
2908
|
* </p>
|
|
2596
2909
|
*/
|
|
2597
2910
|
StorageTypes?: StorageType[];
|
|
2598
2911
|
/**
|
|
2912
|
+
* @public
|
|
2599
2913
|
* <p>InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
|
|
2600
2914
|
* </p>
|
|
2601
2915
|
*/
|
|
2602
2916
|
InstanceLimits?: InstanceLimits;
|
|
2603
2917
|
/**
|
|
2918
|
+
* @public
|
|
2604
2919
|
* <p>
|
|
2605
2920
|
* List of additional limits that are specific to a given InstanceType and for each of it's
|
|
2606
2921
|
* <code>
|
|
@@ -2623,6 +2938,7 @@ export interface Limits {
|
|
|
2623
2938
|
*/
|
|
2624
2939
|
export interface DescribeElasticsearchInstanceTypeLimitsResponse {
|
|
2625
2940
|
/**
|
|
2941
|
+
* @public
|
|
2626
2942
|
* <p>
|
|
2627
2943
|
* Map of Role of the Instance and Limits that are applicable.
|
|
2628
2944
|
* Role performed by given Instance in Elasticsearch
|
|
@@ -2647,12 +2963,14 @@ export interface DescribeElasticsearchInstanceTypeLimitsResponse {
|
|
|
2647
2963
|
*/
|
|
2648
2964
|
export interface Filter {
|
|
2649
2965
|
/**
|
|
2966
|
+
* @public
|
|
2650
2967
|
* <p>
|
|
2651
2968
|
* Specifies the name of the filter.
|
|
2652
2969
|
* </p>
|
|
2653
2970
|
*/
|
|
2654
2971
|
Name?: string;
|
|
2655
2972
|
/**
|
|
2973
|
+
* @public
|
|
2656
2974
|
* <p>
|
|
2657
2975
|
* Contains one or more values for the filter.
|
|
2658
2976
|
* </p>
|
|
@@ -2665,6 +2983,7 @@ export interface Filter {
|
|
|
2665
2983
|
*/
|
|
2666
2984
|
export interface DescribeInboundCrossClusterSearchConnectionsRequest {
|
|
2667
2985
|
/**
|
|
2986
|
+
* @public
|
|
2668
2987
|
* <p>
|
|
2669
2988
|
* A list of filters used to match properties for inbound cross-cluster search connection.
|
|
2670
2989
|
* Available <code><a>Filter</a></code> names for this operation are:
|
|
@@ -2679,10 +2998,12 @@ export interface DescribeInboundCrossClusterSearchConnectionsRequest {
|
|
|
2679
2998
|
*/
|
|
2680
2999
|
Filters?: Filter[];
|
|
2681
3000
|
/**
|
|
3001
|
+
* @public
|
|
2682
3002
|
* <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
|
|
2683
3003
|
*/
|
|
2684
3004
|
MaxResults?: number;
|
|
2685
3005
|
/**
|
|
3006
|
+
* @public
|
|
2686
3007
|
* <p> NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>
|
|
2687
3008
|
*/
|
|
2688
3009
|
NextToken?: string;
|
|
@@ -2693,10 +3014,12 @@ export interface DescribeInboundCrossClusterSearchConnectionsRequest {
|
|
|
2693
3014
|
*/
|
|
2694
3015
|
export interface DescribeInboundCrossClusterSearchConnectionsResponse {
|
|
2695
3016
|
/**
|
|
3017
|
+
* @public
|
|
2696
3018
|
* <p>Consists of list of <code><a>InboundCrossClusterSearchConnection</a></code> matching the specified filter criteria.</p>
|
|
2697
3019
|
*/
|
|
2698
3020
|
CrossClusterSearchConnections?: InboundCrossClusterSearchConnection[];
|
|
2699
3021
|
/**
|
|
3022
|
+
* @public
|
|
2700
3023
|
* <p>If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
|
|
2701
3024
|
* </p>
|
|
2702
3025
|
*/
|
|
@@ -2720,6 +3043,7 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
2720
3043
|
*/
|
|
2721
3044
|
export interface DescribeOutboundCrossClusterSearchConnectionsRequest {
|
|
2722
3045
|
/**
|
|
3046
|
+
* @public
|
|
2723
3047
|
* <p>
|
|
2724
3048
|
* A list of filters used to match properties for outbound cross-cluster search connection.
|
|
2725
3049
|
* Available <code><a>Filter</a></code> names for this operation are:
|
|
@@ -2734,10 +3058,12 @@ export interface DescribeOutboundCrossClusterSearchConnectionsRequest {
|
|
|
2734
3058
|
*/
|
|
2735
3059
|
Filters?: Filter[];
|
|
2736
3060
|
/**
|
|
3061
|
+
* @public
|
|
2737
3062
|
* <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
|
|
2738
3063
|
*/
|
|
2739
3064
|
MaxResults?: number;
|
|
2740
3065
|
/**
|
|
3066
|
+
* @public
|
|
2741
3067
|
* <p> NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>
|
|
2742
3068
|
*/
|
|
2743
3069
|
NextToken?: string;
|
|
@@ -2748,10 +3074,12 @@ export interface DescribeOutboundCrossClusterSearchConnectionsRequest {
|
|
|
2748
3074
|
*/
|
|
2749
3075
|
export interface DescribeOutboundCrossClusterSearchConnectionsResponse {
|
|
2750
3076
|
/**
|
|
3077
|
+
* @public
|
|
2751
3078
|
* <p>Consists of list of <code><a>OutboundCrossClusterSearchConnection</a></code> matching the specified filter criteria.</p>
|
|
2752
3079
|
*/
|
|
2753
3080
|
CrossClusterSearchConnections?: OutboundCrossClusterSearchConnection[];
|
|
2754
3081
|
/**
|
|
3082
|
+
* @public
|
|
2755
3083
|
* <p>If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
|
|
2756
3084
|
* </p>
|
|
2757
3085
|
*/
|
|
@@ -2776,10 +3104,12 @@ export type DescribePackagesFilterName = (typeof DescribePackagesFilterName)[key
|
|
|
2776
3104
|
*/
|
|
2777
3105
|
export interface DescribePackagesFilter {
|
|
2778
3106
|
/**
|
|
3107
|
+
* @public
|
|
2779
3108
|
* <p>Any field from <code>PackageDetails</code>.</p>
|
|
2780
3109
|
*/
|
|
2781
3110
|
Name?: DescribePackagesFilterName | string;
|
|
2782
3111
|
/**
|
|
3112
|
+
* @public
|
|
2783
3113
|
* <p>A non-empty list of values for the specified field.</p>
|
|
2784
3114
|
*/
|
|
2785
3115
|
Value?: string[];
|
|
@@ -2796,14 +3126,17 @@ export interface DescribePackagesFilter {
|
|
|
2796
3126
|
*/
|
|
2797
3127
|
export interface DescribePackagesRequest {
|
|
2798
3128
|
/**
|
|
3129
|
+
* @public
|
|
2799
3130
|
* <p>Only returns packages that match the <code>DescribePackagesFilterList</code> values.</p>
|
|
2800
3131
|
*/
|
|
2801
3132
|
Filters?: DescribePackagesFilter[];
|
|
2802
3133
|
/**
|
|
3134
|
+
* @public
|
|
2803
3135
|
* <p>Limits results to a maximum number of packages.</p>
|
|
2804
3136
|
*/
|
|
2805
3137
|
MaxResults?: number;
|
|
2806
3138
|
/**
|
|
3139
|
+
* @public
|
|
2807
3140
|
* <p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>
|
|
2808
3141
|
*/
|
|
2809
3142
|
NextToken?: string;
|
|
@@ -2820,6 +3153,7 @@ export interface DescribePackagesRequest {
|
|
|
2820
3153
|
*/
|
|
2821
3154
|
export interface DescribePackagesResponse {
|
|
2822
3155
|
/**
|
|
3156
|
+
* @public
|
|
2823
3157
|
* <p>List of <code>PackageDetails</code> objects.</p>
|
|
2824
3158
|
*/
|
|
2825
3159
|
PackageDetailsList?: PackageDetails[];
|
|
@@ -2831,14 +3165,17 @@ export interface DescribePackagesResponse {
|
|
|
2831
3165
|
*/
|
|
2832
3166
|
export interface DescribeReservedElasticsearchInstanceOfferingsRequest {
|
|
2833
3167
|
/**
|
|
3168
|
+
* @public
|
|
2834
3169
|
* <p>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.</p>
|
|
2835
3170
|
*/
|
|
2836
3171
|
ReservedElasticsearchInstanceOfferingId?: string;
|
|
2837
3172
|
/**
|
|
3173
|
+
* @public
|
|
2838
3174
|
* <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
|
|
2839
3175
|
*/
|
|
2840
3176
|
MaxResults?: number;
|
|
2841
3177
|
/**
|
|
3178
|
+
* @public
|
|
2842
3179
|
* <p>NextToken should be sent in case if earlier API call produced result
|
|
2843
3180
|
* containing NextToken. It is used for pagination.</p>
|
|
2844
3181
|
*/
|
|
@@ -2863,10 +3200,12 @@ export type ReservedElasticsearchInstancePaymentOption = (typeof ReservedElastic
|
|
|
2863
3200
|
*/
|
|
2864
3201
|
export interface RecurringCharge {
|
|
2865
3202
|
/**
|
|
3203
|
+
* @public
|
|
2866
3204
|
* <p>The monetary amount of the recurring charge.</p>
|
|
2867
3205
|
*/
|
|
2868
3206
|
RecurringChargeAmount?: number;
|
|
2869
3207
|
/**
|
|
3208
|
+
* @public
|
|
2870
3209
|
* <p>The frequency of the recurring charge.</p>
|
|
2871
3210
|
*/
|
|
2872
3211
|
RecurringChargeFrequency?: string;
|
|
@@ -2877,34 +3216,42 @@ export interface RecurringCharge {
|
|
|
2877
3216
|
*/
|
|
2878
3217
|
export interface ReservedElasticsearchInstanceOffering {
|
|
2879
3218
|
/**
|
|
3219
|
+
* @public
|
|
2880
3220
|
* <p>The Elasticsearch reserved instance offering identifier.</p>
|
|
2881
3221
|
*/
|
|
2882
3222
|
ReservedElasticsearchInstanceOfferingId?: string;
|
|
2883
3223
|
/**
|
|
3224
|
+
* @public
|
|
2884
3225
|
* <p>The Elasticsearch instance type offered by the reserved instance offering.</p>
|
|
2885
3226
|
*/
|
|
2886
3227
|
ElasticsearchInstanceType?: ESPartitionInstanceType | string;
|
|
2887
3228
|
/**
|
|
3229
|
+
* @public
|
|
2888
3230
|
* <p>The duration, in seconds, for which the offering will reserve the Elasticsearch instance.</p>
|
|
2889
3231
|
*/
|
|
2890
3232
|
Duration?: number;
|
|
2891
3233
|
/**
|
|
3234
|
+
* @public
|
|
2892
3235
|
* <p>The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering. </p>
|
|
2893
3236
|
*/
|
|
2894
3237
|
FixedPrice?: number;
|
|
2895
3238
|
/**
|
|
3239
|
+
* @public
|
|
2896
3240
|
* <p>The rate you are charged for each hour the domain that is using the offering is running.</p>
|
|
2897
3241
|
*/
|
|
2898
3242
|
UsagePrice?: number;
|
|
2899
3243
|
/**
|
|
3244
|
+
* @public
|
|
2900
3245
|
* <p>The currency code for the reserved Elasticsearch instance offering.</p>
|
|
2901
3246
|
*/
|
|
2902
3247
|
CurrencyCode?: string;
|
|
2903
3248
|
/**
|
|
3249
|
+
* @public
|
|
2904
3250
|
* <p>Payment option for the reserved Elasticsearch instance offering</p>
|
|
2905
3251
|
*/
|
|
2906
3252
|
PaymentOption?: ReservedElasticsearchInstancePaymentOption | string;
|
|
2907
3253
|
/**
|
|
3254
|
+
* @public
|
|
2908
3255
|
* <p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>
|
|
2909
3256
|
*/
|
|
2910
3257
|
RecurringCharges?: RecurringCharge[];
|
|
@@ -2915,10 +3262,12 @@ export interface ReservedElasticsearchInstanceOffering {
|
|
|
2915
3262
|
*/
|
|
2916
3263
|
export interface DescribeReservedElasticsearchInstanceOfferingsResponse {
|
|
2917
3264
|
/**
|
|
3265
|
+
* @public
|
|
2918
3266
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
2919
3267
|
*/
|
|
2920
3268
|
NextToken?: string;
|
|
2921
3269
|
/**
|
|
3270
|
+
* @public
|
|
2922
3271
|
* <p>List of reserved Elasticsearch instance offerings</p>
|
|
2923
3272
|
*/
|
|
2924
3273
|
ReservedElasticsearchInstanceOfferings?: ReservedElasticsearchInstanceOffering[];
|
|
@@ -2929,14 +3278,17 @@ export interface DescribeReservedElasticsearchInstanceOfferingsResponse {
|
|
|
2929
3278
|
*/
|
|
2930
3279
|
export interface DescribeReservedElasticsearchInstancesRequest {
|
|
2931
3280
|
/**
|
|
3281
|
+
* @public
|
|
2932
3282
|
* <p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.</p>
|
|
2933
3283
|
*/
|
|
2934
3284
|
ReservedElasticsearchInstanceId?: string;
|
|
2935
3285
|
/**
|
|
3286
|
+
* @public
|
|
2936
3287
|
* <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
|
|
2937
3288
|
*/
|
|
2938
3289
|
MaxResults?: number;
|
|
2939
3290
|
/**
|
|
3291
|
+
* @public
|
|
2940
3292
|
* <p>NextToken should be sent in case if earlier API call produced result
|
|
2941
3293
|
* containing NextToken. It is used for pagination.</p>
|
|
2942
3294
|
*/
|
|
@@ -2948,54 +3300,67 @@ export interface DescribeReservedElasticsearchInstancesRequest {
|
|
|
2948
3300
|
*/
|
|
2949
3301
|
export interface ReservedElasticsearchInstance {
|
|
2950
3302
|
/**
|
|
3303
|
+
* @public
|
|
2951
3304
|
* <p>The customer-specified identifier to track this reservation.</p>
|
|
2952
3305
|
*/
|
|
2953
3306
|
ReservationName?: string;
|
|
2954
3307
|
/**
|
|
3308
|
+
* @public
|
|
2955
3309
|
* <p>The unique identifier for the reservation.</p>
|
|
2956
3310
|
*/
|
|
2957
3311
|
ReservedElasticsearchInstanceId?: string;
|
|
2958
3312
|
/**
|
|
3313
|
+
* @public
|
|
2959
3314
|
* <p>The offering identifier.</p>
|
|
2960
3315
|
*/
|
|
2961
3316
|
ReservedElasticsearchInstanceOfferingId?: string;
|
|
2962
3317
|
/**
|
|
3318
|
+
* @public
|
|
2963
3319
|
* <p>The Elasticsearch instance type offered by the reserved instance offering.</p>
|
|
2964
3320
|
*/
|
|
2965
3321
|
ElasticsearchInstanceType?: ESPartitionInstanceType | string;
|
|
2966
3322
|
/**
|
|
3323
|
+
* @public
|
|
2967
3324
|
* <p>The time the reservation started.</p>
|
|
2968
3325
|
*/
|
|
2969
3326
|
StartTime?: Date;
|
|
2970
3327
|
/**
|
|
3328
|
+
* @public
|
|
2971
3329
|
* <p>The duration, in seconds, for which the Elasticsearch instance is reserved.</p>
|
|
2972
3330
|
*/
|
|
2973
3331
|
Duration?: number;
|
|
2974
3332
|
/**
|
|
3333
|
+
* @public
|
|
2975
3334
|
* <p>The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering. </p>
|
|
2976
3335
|
*/
|
|
2977
3336
|
FixedPrice?: number;
|
|
2978
3337
|
/**
|
|
3338
|
+
* @public
|
|
2979
3339
|
* <p>The rate you are charged for each hour for the domain that is using this reserved instance.</p>
|
|
2980
3340
|
*/
|
|
2981
3341
|
UsagePrice?: number;
|
|
2982
3342
|
/**
|
|
3343
|
+
* @public
|
|
2983
3344
|
* <p>The currency code for the reserved Elasticsearch instance offering.</p>
|
|
2984
3345
|
*/
|
|
2985
3346
|
CurrencyCode?: string;
|
|
2986
3347
|
/**
|
|
3348
|
+
* @public
|
|
2987
3349
|
* <p>The number of Elasticsearch instances that have been reserved.</p>
|
|
2988
3350
|
*/
|
|
2989
3351
|
ElasticsearchInstanceCount?: number;
|
|
2990
3352
|
/**
|
|
3353
|
+
* @public
|
|
2991
3354
|
* <p>The state of the reserved Elasticsearch instance.</p>
|
|
2992
3355
|
*/
|
|
2993
3356
|
State?: string;
|
|
2994
3357
|
/**
|
|
3358
|
+
* @public
|
|
2995
3359
|
* <p>The payment option as defined in the reserved Elasticsearch instance offering.</p>
|
|
2996
3360
|
*/
|
|
2997
3361
|
PaymentOption?: ReservedElasticsearchInstancePaymentOption | string;
|
|
2998
3362
|
/**
|
|
3363
|
+
* @public
|
|
2999
3364
|
* <p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>
|
|
3000
3365
|
*/
|
|
3001
3366
|
RecurringCharges?: RecurringCharge[];
|
|
@@ -3006,10 +3371,12 @@ export interface ReservedElasticsearchInstance {
|
|
|
3006
3371
|
*/
|
|
3007
3372
|
export interface DescribeReservedElasticsearchInstancesResponse {
|
|
3008
3373
|
/**
|
|
3374
|
+
* @public
|
|
3009
3375
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
3010
3376
|
*/
|
|
3011
3377
|
NextToken?: string;
|
|
3012
3378
|
/**
|
|
3379
|
+
* @public
|
|
3013
3380
|
* <p>List of reserved Elasticsearch instances.</p>
|
|
3014
3381
|
*/
|
|
3015
3382
|
ReservedElasticsearchInstances?: ReservedElasticsearchInstance[];
|
|
@@ -3020,6 +3387,7 @@ export interface DescribeReservedElasticsearchInstancesResponse {
|
|
|
3020
3387
|
*/
|
|
3021
3388
|
export interface DescribeVpcEndpointsRequest {
|
|
3022
3389
|
/**
|
|
3390
|
+
* @public
|
|
3023
3391
|
* <p>The unique identifiers of the endpoints to get information about.</p>
|
|
3024
3392
|
*/
|
|
3025
3393
|
VpcEndpointIds: string[] | undefined;
|
|
@@ -3043,14 +3411,17 @@ export type VpcEndpointErrorCode = (typeof VpcEndpointErrorCode)[keyof typeof Vp
|
|
|
3043
3411
|
*/
|
|
3044
3412
|
export interface VpcEndpointError {
|
|
3045
3413
|
/**
|
|
3414
|
+
* @public
|
|
3046
3415
|
* <p>The unique identifier of the endpoint. </p>
|
|
3047
3416
|
*/
|
|
3048
3417
|
VpcEndpointId?: string;
|
|
3049
3418
|
/**
|
|
3419
|
+
* @public
|
|
3050
3420
|
* <p>The code associated with the error.</p>
|
|
3051
3421
|
*/
|
|
3052
3422
|
ErrorCode?: VpcEndpointErrorCode | string;
|
|
3053
3423
|
/**
|
|
3424
|
+
* @public
|
|
3054
3425
|
* <p>A message describing the error.</p>
|
|
3055
3426
|
*/
|
|
3056
3427
|
ErrorMessage?: string;
|
|
@@ -3062,10 +3433,12 @@ export interface VpcEndpointError {
|
|
|
3062
3433
|
*/
|
|
3063
3434
|
export interface DescribeVpcEndpointsResponse {
|
|
3064
3435
|
/**
|
|
3436
|
+
* @public
|
|
3065
3437
|
* <p>Information about each requested VPC endpoint.</p>
|
|
3066
3438
|
*/
|
|
3067
3439
|
VpcEndpoints: VpcEndpoint[] | undefined;
|
|
3068
3440
|
/**
|
|
3441
|
+
* @public
|
|
3069
3442
|
* <p>Any errors associated with the request.</p>
|
|
3070
3443
|
*/
|
|
3071
3444
|
VpcEndpointErrors: VpcEndpointError[] | undefined;
|
|
@@ -3082,10 +3455,12 @@ export interface DescribeVpcEndpointsResponse {
|
|
|
3082
3455
|
*/
|
|
3083
3456
|
export interface DissociatePackageRequest {
|
|
3084
3457
|
/**
|
|
3458
|
+
* @public
|
|
3085
3459
|
* <p>Internal ID of the package that you want to associate with a domain. Use <code>DescribePackages</code> to find this value.</p>
|
|
3086
3460
|
*/
|
|
3087
3461
|
PackageID: string | undefined;
|
|
3088
3462
|
/**
|
|
3463
|
+
* @public
|
|
3089
3464
|
* <p>Name of the domain that you want to associate the package with.</p>
|
|
3090
3465
|
*/
|
|
3091
3466
|
DomainName: string | undefined;
|
|
@@ -3102,6 +3477,7 @@ export interface DissociatePackageRequest {
|
|
|
3102
3477
|
*/
|
|
3103
3478
|
export interface DissociatePackageResponse {
|
|
3104
3479
|
/**
|
|
3480
|
+
* @public
|
|
3105
3481
|
* <p><code>DomainPackageDetails</code></p>
|
|
3106
3482
|
*/
|
|
3107
3483
|
DomainPackageDetails?: DomainPackageDetails;
|
|
@@ -3118,6 +3494,7 @@ export interface DissociatePackageResponse {
|
|
|
3118
3494
|
*/
|
|
3119
3495
|
export interface GetCompatibleElasticsearchVersionsRequest {
|
|
3120
3496
|
/**
|
|
3497
|
+
* @public
|
|
3121
3498
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
3122
3499
|
*/
|
|
3123
3500
|
DomainName?: string;
|
|
@@ -3138,10 +3515,12 @@ export interface GetCompatibleElasticsearchVersionsRequest {
|
|
|
3138
3515
|
*/
|
|
3139
3516
|
export interface CompatibleVersionsMap {
|
|
3140
3517
|
/**
|
|
3518
|
+
* @public
|
|
3141
3519
|
* <p>The current version of Elasticsearch on which a domain is.</p>
|
|
3142
3520
|
*/
|
|
3143
3521
|
SourceVersion?: string;
|
|
3144
3522
|
/**
|
|
3523
|
+
* @public
|
|
3145
3524
|
* <p>List of supported elastic search versions.
|
|
3146
3525
|
* </p>
|
|
3147
3526
|
*/
|
|
@@ -3159,6 +3538,7 @@ export interface CompatibleVersionsMap {
|
|
|
3159
3538
|
*/
|
|
3160
3539
|
export interface GetCompatibleElasticsearchVersionsResponse {
|
|
3161
3540
|
/**
|
|
3541
|
+
* @public
|
|
3162
3542
|
* <p>
|
|
3163
3543
|
* A map of compatible Elasticsearch versions returned as part of the
|
|
3164
3544
|
* <code>
|
|
@@ -3181,14 +3561,17 @@ export interface GetCompatibleElasticsearchVersionsResponse {
|
|
|
3181
3561
|
*/
|
|
3182
3562
|
export interface GetPackageVersionHistoryRequest {
|
|
3183
3563
|
/**
|
|
3564
|
+
* @public
|
|
3184
3565
|
* <p>Returns an audit history of versions of the package.</p>
|
|
3185
3566
|
*/
|
|
3186
3567
|
PackageID: string | undefined;
|
|
3187
3568
|
/**
|
|
3569
|
+
* @public
|
|
3188
3570
|
* <p>Limits results to a maximum number of versions.</p>
|
|
3189
3571
|
*/
|
|
3190
3572
|
MaxResults?: number;
|
|
3191
3573
|
/**
|
|
3574
|
+
* @public
|
|
3192
3575
|
* <p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>
|
|
3193
3576
|
*/
|
|
3194
3577
|
NextToken?: string;
|
|
@@ -3199,14 +3582,17 @@ export interface GetPackageVersionHistoryRequest {
|
|
|
3199
3582
|
*/
|
|
3200
3583
|
export interface PackageVersionHistory {
|
|
3201
3584
|
/**
|
|
3585
|
+
* @public
|
|
3202
3586
|
* <p>Version of the package.</p>
|
|
3203
3587
|
*/
|
|
3204
3588
|
PackageVersion?: string;
|
|
3205
3589
|
/**
|
|
3590
|
+
* @public
|
|
3206
3591
|
* <p>A message associated with the version.</p>
|
|
3207
3592
|
*/
|
|
3208
3593
|
CommitMessage?: string;
|
|
3209
3594
|
/**
|
|
3595
|
+
* @public
|
|
3210
3596
|
* <p>Timestamp which tells creation time of the package version.</p>
|
|
3211
3597
|
*/
|
|
3212
3598
|
CreatedAt?: Date;
|
|
@@ -3224,6 +3610,7 @@ export interface PackageVersionHistory {
|
|
|
3224
3610
|
export interface GetPackageVersionHistoryResponse {
|
|
3225
3611
|
PackageID?: string;
|
|
3226
3612
|
/**
|
|
3613
|
+
* @public
|
|
3227
3614
|
* <p>List of <code>PackageVersionHistory</code> objects.</p>
|
|
3228
3615
|
*/
|
|
3229
3616
|
PackageVersionHistoryList?: PackageVersionHistory[];
|
|
@@ -3241,16 +3628,19 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
3241
3628
|
*/
|
|
3242
3629
|
export interface GetUpgradeHistoryRequest {
|
|
3243
3630
|
/**
|
|
3631
|
+
* @public
|
|
3244
3632
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
3245
3633
|
*/
|
|
3246
3634
|
DomainName: string | undefined;
|
|
3247
3635
|
/**
|
|
3636
|
+
* @public
|
|
3248
3637
|
* <p>
|
|
3249
3638
|
* Set this value to limit the number of results returned.
|
|
3250
3639
|
* </p>
|
|
3251
3640
|
*/
|
|
3252
3641
|
MaxResults?: number;
|
|
3253
3642
|
/**
|
|
3643
|
+
* @public
|
|
3254
3644
|
* <p>
|
|
3255
3645
|
* Paginated APIs accepts NextToken input to returns next page results and provides
|
|
3256
3646
|
* a NextToken output in the response which can be used by the client to retrieve more results.
|
|
@@ -3291,6 +3681,7 @@ export type UpgradeStatus = (typeof UpgradeStatus)[keyof typeof UpgradeStatus];
|
|
|
3291
3681
|
*/
|
|
3292
3682
|
export interface UpgradeStepItem {
|
|
3293
3683
|
/**
|
|
3684
|
+
* @public
|
|
3294
3685
|
* <p>
|
|
3295
3686
|
* Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
|
|
3296
3687
|
* <ul>
|
|
@@ -3302,6 +3693,7 @@ export interface UpgradeStepItem {
|
|
|
3302
3693
|
*/
|
|
3303
3694
|
UpgradeStep?: UpgradeStep | string;
|
|
3304
3695
|
/**
|
|
3696
|
+
* @public
|
|
3305
3697
|
* <p>
|
|
3306
3698
|
* The status of a particular step during an upgrade. The status can take one of the following values:
|
|
3307
3699
|
* <ul>
|
|
@@ -3314,10 +3706,12 @@ export interface UpgradeStepItem {
|
|
|
3314
3706
|
*/
|
|
3315
3707
|
UpgradeStepStatus?: UpgradeStatus | string;
|
|
3316
3708
|
/**
|
|
3709
|
+
* @public
|
|
3317
3710
|
* <p>A list of strings containing detailed information about the errors encountered in a particular step.</p>
|
|
3318
3711
|
*/
|
|
3319
3712
|
Issues?: string[];
|
|
3320
3713
|
/**
|
|
3714
|
+
* @public
|
|
3321
3715
|
* <p>The Floating point value representing progress percentage of a particular step.</p>
|
|
3322
3716
|
*/
|
|
3323
3717
|
ProgressPercent?: number;
|
|
@@ -3328,14 +3722,17 @@ export interface UpgradeStepItem {
|
|
|
3328
3722
|
*/
|
|
3329
3723
|
export interface UpgradeHistory {
|
|
3330
3724
|
/**
|
|
3725
|
+
* @public
|
|
3331
3726
|
* <p>A string that describes the update briefly</p>
|
|
3332
3727
|
*/
|
|
3333
3728
|
UpgradeName?: string;
|
|
3334
3729
|
/**
|
|
3730
|
+
* @public
|
|
3335
3731
|
* <p>UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
3336
3732
|
*/
|
|
3337
3733
|
StartTimestamp?: Date;
|
|
3338
3734
|
/**
|
|
3735
|
+
* @public
|
|
3339
3736
|
* <p>
|
|
3340
3737
|
* The overall status of the update. The status can take one of the following values:
|
|
3341
3738
|
* <ul>
|
|
@@ -3348,6 +3745,7 @@ export interface UpgradeHistory {
|
|
|
3348
3745
|
*/
|
|
3349
3746
|
UpgradeStatus?: UpgradeStatus | string;
|
|
3350
3747
|
/**
|
|
3748
|
+
* @public
|
|
3351
3749
|
* <p>
|
|
3352
3750
|
* A list of
|
|
3353
3751
|
* <code>
|
|
@@ -3370,6 +3768,7 @@ export interface UpgradeHistory {
|
|
|
3370
3768
|
*/
|
|
3371
3769
|
export interface GetUpgradeHistoryResponse {
|
|
3372
3770
|
/**
|
|
3771
|
+
* @public
|
|
3373
3772
|
* <p>
|
|
3374
3773
|
* A list of
|
|
3375
3774
|
* <code>
|
|
@@ -3384,6 +3783,7 @@ export interface GetUpgradeHistoryResponse {
|
|
|
3384
3783
|
*/
|
|
3385
3784
|
UpgradeHistories?: UpgradeHistory[];
|
|
3386
3785
|
/**
|
|
3786
|
+
* @public
|
|
3387
3787
|
* <p>Pagination token that needs to be supplied to the next call to get the next page of results</p>
|
|
3388
3788
|
*/
|
|
3389
3789
|
NextToken?: string;
|
|
@@ -3400,6 +3800,7 @@ export interface GetUpgradeHistoryResponse {
|
|
|
3400
3800
|
*/
|
|
3401
3801
|
export interface GetUpgradeStatusRequest {
|
|
3402
3802
|
/**
|
|
3803
|
+
* @public
|
|
3403
3804
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
3404
3805
|
*/
|
|
3405
3806
|
DomainName: string | undefined;
|
|
@@ -3416,6 +3817,7 @@ export interface GetUpgradeStatusRequest {
|
|
|
3416
3817
|
*/
|
|
3417
3818
|
export interface GetUpgradeStatusResponse {
|
|
3418
3819
|
/**
|
|
3820
|
+
* @public
|
|
3419
3821
|
* <p>
|
|
3420
3822
|
* Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
|
|
3421
3823
|
* <ul>
|
|
@@ -3427,6 +3829,7 @@ export interface GetUpgradeStatusResponse {
|
|
|
3427
3829
|
*/
|
|
3428
3830
|
UpgradeStep?: UpgradeStep | string;
|
|
3429
3831
|
/**
|
|
3832
|
+
* @public
|
|
3430
3833
|
* <p>
|
|
3431
3834
|
* One of 4 statuses that a step can go through returned as part of the
|
|
3432
3835
|
* <code>
|
|
@@ -3443,6 +3846,7 @@ export interface GetUpgradeStatusResponse {
|
|
|
3443
3846
|
*/
|
|
3444
3847
|
StepStatus?: UpgradeStatus | string;
|
|
3445
3848
|
/**
|
|
3849
|
+
* @public
|
|
3446
3850
|
* <p>A string that describes the update briefly</p>
|
|
3447
3851
|
*/
|
|
3448
3852
|
UpgradeName?: string;
|
|
@@ -3465,6 +3869,7 @@ export type EngineType = (typeof EngineType)[keyof typeof EngineType];
|
|
|
3465
3869
|
*/
|
|
3466
3870
|
export interface ListDomainNamesRequest {
|
|
3467
3871
|
/**
|
|
3872
|
+
* @public
|
|
3468
3873
|
* <p> Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'. </p>
|
|
3469
3874
|
*/
|
|
3470
3875
|
EngineType?: EngineType | string;
|
|
@@ -3474,10 +3879,12 @@ export interface ListDomainNamesRequest {
|
|
|
3474
3879
|
*/
|
|
3475
3880
|
export interface DomainInfo {
|
|
3476
3881
|
/**
|
|
3882
|
+
* @public
|
|
3477
3883
|
* <p> Specifies the <code>DomainName</code>.</p>
|
|
3478
3884
|
*/
|
|
3479
3885
|
DomainName?: string;
|
|
3480
3886
|
/**
|
|
3887
|
+
* @public
|
|
3481
3888
|
* <p> Specifies the <code>EngineType</code> of the domain.</p>
|
|
3482
3889
|
*/
|
|
3483
3890
|
EngineType?: EngineType | string;
|
|
@@ -3488,6 +3895,7 @@ export interface DomainInfo {
|
|
|
3488
3895
|
*/
|
|
3489
3896
|
export interface ListDomainNamesResponse {
|
|
3490
3897
|
/**
|
|
3898
|
+
* @public
|
|
3491
3899
|
* <p>List of domain names and respective engine types.</p>
|
|
3492
3900
|
*/
|
|
3493
3901
|
DomainNames?: DomainInfo[];
|
|
@@ -3504,14 +3912,17 @@ export interface ListDomainNamesResponse {
|
|
|
3504
3912
|
*/
|
|
3505
3913
|
export interface ListDomainsForPackageRequest {
|
|
3506
3914
|
/**
|
|
3915
|
+
* @public
|
|
3507
3916
|
* <p>The package for which to list domains.</p>
|
|
3508
3917
|
*/
|
|
3509
3918
|
PackageID: string | undefined;
|
|
3510
3919
|
/**
|
|
3920
|
+
* @public
|
|
3511
3921
|
* <p>Limits results to a maximum number of domains.</p>
|
|
3512
3922
|
*/
|
|
3513
3923
|
MaxResults?: number;
|
|
3514
3924
|
/**
|
|
3925
|
+
* @public
|
|
3515
3926
|
* <p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>
|
|
3516
3927
|
*/
|
|
3517
3928
|
NextToken?: string;
|
|
@@ -3528,6 +3939,7 @@ export interface ListDomainsForPackageRequest {
|
|
|
3528
3939
|
*/
|
|
3529
3940
|
export interface ListDomainsForPackageResponse {
|
|
3530
3941
|
/**
|
|
3942
|
+
* @public
|
|
3531
3943
|
* <p>List of <code>DomainPackageDetails</code> objects.</p>
|
|
3532
3944
|
*/
|
|
3533
3945
|
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
@@ -3545,18 +3957,21 @@ export interface ListDomainsForPackageResponse {
|
|
|
3545
3957
|
*/
|
|
3546
3958
|
export interface ListElasticsearchInstanceTypesRequest {
|
|
3547
3959
|
/**
|
|
3960
|
+
* @public
|
|
3548
3961
|
* <p>Version of Elasticsearch for which list of supported elasticsearch
|
|
3549
3962
|
* instance types are needed.
|
|
3550
3963
|
* </p>
|
|
3551
3964
|
*/
|
|
3552
3965
|
ElasticsearchVersion: string | undefined;
|
|
3553
3966
|
/**
|
|
3967
|
+
* @public
|
|
3554
3968
|
* <p>DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are
|
|
3555
3969
|
* querying for list of available Elasticsearch instance types when modifying existing domain.
|
|
3556
3970
|
* </p>
|
|
3557
3971
|
*/
|
|
3558
3972
|
DomainName?: string;
|
|
3559
3973
|
/**
|
|
3974
|
+
* @public
|
|
3560
3975
|
* <p>
|
|
3561
3976
|
* Set this value to limit the number of results returned.
|
|
3562
3977
|
* Value provided must be greater than 30 else it wont be honored.
|
|
@@ -3564,6 +3979,7 @@ export interface ListElasticsearchInstanceTypesRequest {
|
|
|
3564
3979
|
*/
|
|
3565
3980
|
MaxResults?: number;
|
|
3566
3981
|
/**
|
|
3982
|
+
* @public
|
|
3567
3983
|
* <p>NextToken should be sent in case if earlier API call produced result
|
|
3568
3984
|
* containing NextToken. It is used for pagination.
|
|
3569
3985
|
* </p>
|
|
@@ -3582,6 +3998,7 @@ export interface ListElasticsearchInstanceTypesRequest {
|
|
|
3582
3998
|
*/
|
|
3583
3999
|
export interface ListElasticsearchInstanceTypesResponse {
|
|
3584
4000
|
/**
|
|
4001
|
+
* @public
|
|
3585
4002
|
* <p>
|
|
3586
4003
|
* List of instance types supported by Amazon Elasticsearch service for
|
|
3587
4004
|
* given
|
|
@@ -3592,6 +4009,7 @@ export interface ListElasticsearchInstanceTypesResponse {
|
|
|
3592
4009
|
*/
|
|
3593
4010
|
ElasticsearchInstanceTypes?: (ESPartitionInstanceType | string)[];
|
|
3594
4011
|
/**
|
|
4012
|
+
* @public
|
|
3595
4013
|
* <p>In case if there are more results available NextToken would be
|
|
3596
4014
|
* present, make further request to the same API with
|
|
3597
4015
|
* received NextToken to paginate remaining results.
|
|
@@ -3627,6 +4045,7 @@ export interface ListElasticsearchInstanceTypesResponse {
|
|
|
3627
4045
|
*/
|
|
3628
4046
|
export interface ListElasticsearchVersionsRequest {
|
|
3629
4047
|
/**
|
|
4048
|
+
* @public
|
|
3630
4049
|
* <p>
|
|
3631
4050
|
* Set this value to limit the number of results returned.
|
|
3632
4051
|
* Value provided must be greater than 10 else it wont be honored.
|
|
@@ -3634,6 +4053,7 @@ export interface ListElasticsearchVersionsRequest {
|
|
|
3634
4053
|
*/
|
|
3635
4054
|
MaxResults?: number;
|
|
3636
4055
|
/**
|
|
4056
|
+
* @public
|
|
3637
4057
|
* <p>
|
|
3638
4058
|
* Paginated APIs accepts NextToken input to returns next page results and provides
|
|
3639
4059
|
* a NextToken output in the response which can be used by the client to retrieve more results.
|
|
@@ -3653,11 +4073,13 @@ export interface ListElasticsearchVersionsRequest {
|
|
|
3653
4073
|
*/
|
|
3654
4074
|
export interface ListElasticsearchVersionsResponse {
|
|
3655
4075
|
/**
|
|
4076
|
+
* @public
|
|
3656
4077
|
* <p>List of supported elastic search versions.
|
|
3657
4078
|
* </p>
|
|
3658
4079
|
*/
|
|
3659
4080
|
ElasticsearchVersions?: string[];
|
|
3660
4081
|
/**
|
|
4082
|
+
* @public
|
|
3661
4083
|
* <p>
|
|
3662
4084
|
* Paginated APIs accepts NextToken input to returns next page results and provides
|
|
3663
4085
|
* a NextToken output in the response which can be used by the client to retrieve more results.
|
|
@@ -3677,14 +4099,17 @@ export interface ListElasticsearchVersionsResponse {
|
|
|
3677
4099
|
*/
|
|
3678
4100
|
export interface ListPackagesForDomainRequest {
|
|
3679
4101
|
/**
|
|
4102
|
+
* @public
|
|
3680
4103
|
* <p>The name of the domain for which you want to list associated packages.</p>
|
|
3681
4104
|
*/
|
|
3682
4105
|
DomainName: string | undefined;
|
|
3683
4106
|
/**
|
|
4107
|
+
* @public
|
|
3684
4108
|
* <p>Limits results to a maximum number of packages.</p>
|
|
3685
4109
|
*/
|
|
3686
4110
|
MaxResults?: number;
|
|
3687
4111
|
/**
|
|
4112
|
+
* @public
|
|
3688
4113
|
* <p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>
|
|
3689
4114
|
*/
|
|
3690
4115
|
NextToken?: string;
|
|
@@ -3701,10 +4126,12 @@ export interface ListPackagesForDomainRequest {
|
|
|
3701
4126
|
*/
|
|
3702
4127
|
export interface ListPackagesForDomainResponse {
|
|
3703
4128
|
/**
|
|
4129
|
+
* @public
|
|
3704
4130
|
* <p>List of <code>DomainPackageDetails</code> objects.</p>
|
|
3705
4131
|
*/
|
|
3706
4132
|
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
3707
4133
|
/**
|
|
4134
|
+
* @public
|
|
3708
4135
|
* <p>Pagination token that needs to be supplied to the next call to get the next page of results.</p>
|
|
3709
4136
|
*/
|
|
3710
4137
|
NextToken?: string;
|
|
@@ -3715,6 +4142,7 @@ export interface ListPackagesForDomainResponse {
|
|
|
3715
4142
|
*/
|
|
3716
4143
|
export interface ListTagsRequest {
|
|
3717
4144
|
/**
|
|
4145
|
+
* @public
|
|
3718
4146
|
* <p> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</p>
|
|
3719
4147
|
*/
|
|
3720
4148
|
ARN: string | undefined;
|
|
@@ -3725,6 +4153,7 @@ export interface ListTagsRequest {
|
|
|
3725
4153
|
*/
|
|
3726
4154
|
export interface ListTagsResponse {
|
|
3727
4155
|
/**
|
|
4156
|
+
* @public
|
|
3728
4157
|
* <p> List of <code>Tag</code> for the requested Elasticsearch domain.</p>
|
|
3729
4158
|
*/
|
|
3730
4159
|
TagList?: Tag[];
|
|
@@ -3736,10 +4165,12 @@ export interface ListTagsResponse {
|
|
|
3736
4165
|
*/
|
|
3737
4166
|
export interface ListVpcEndpointAccessRequest {
|
|
3738
4167
|
/**
|
|
4168
|
+
* @public
|
|
3739
4169
|
* <p>The name of the OpenSearch Service domain to retrieve access information for.</p>
|
|
3740
4170
|
*/
|
|
3741
4171
|
DomainName: string | undefined;
|
|
3742
4172
|
/**
|
|
4173
|
+
* @public
|
|
3743
4174
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
3744
4175
|
*/
|
|
3745
4176
|
NextToken?: string;
|
|
@@ -3751,10 +4182,12 @@ export interface ListVpcEndpointAccessRequest {
|
|
|
3751
4182
|
*/
|
|
3752
4183
|
export interface ListVpcEndpointAccessResponse {
|
|
3753
4184
|
/**
|
|
4185
|
+
* @public
|
|
3754
4186
|
* <p>List of <code>AuthorizedPrincipal</code> describing the details of the permissions to manage VPC endpoints against the specified domain.</p>
|
|
3755
4187
|
*/
|
|
3756
4188
|
AuthorizedPrincipalList: AuthorizedPrincipal[] | undefined;
|
|
3757
4189
|
/**
|
|
4190
|
+
* @public
|
|
3758
4191
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
3759
4192
|
*/
|
|
3760
4193
|
NextToken: string | undefined;
|
|
@@ -3765,6 +4198,7 @@ export interface ListVpcEndpointAccessResponse {
|
|
|
3765
4198
|
*/
|
|
3766
4199
|
export interface ListVpcEndpointsRequest {
|
|
3767
4200
|
/**
|
|
4201
|
+
* @public
|
|
3768
4202
|
* <p>Identifier to allow retrieval of paginated results.</p>
|
|
3769
4203
|
*/
|
|
3770
4204
|
NextToken?: string;
|
|
@@ -3775,10 +4209,12 @@ export interface ListVpcEndpointsRequest {
|
|
|
3775
4209
|
*/
|
|
3776
4210
|
export interface ListVpcEndpointsResponse {
|
|
3777
4211
|
/**
|
|
4212
|
+
* @public
|
|
3778
4213
|
* <p>Information about each endpoint.</p>
|
|
3779
4214
|
*/
|
|
3780
4215
|
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
3781
4216
|
/**
|
|
4217
|
+
* @public
|
|
3782
4218
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
3783
4219
|
*/
|
|
3784
4220
|
NextToken: string | undefined;
|
|
@@ -3789,10 +4225,12 @@ export interface ListVpcEndpointsResponse {
|
|
|
3789
4225
|
*/
|
|
3790
4226
|
export interface ListVpcEndpointsForDomainRequest {
|
|
3791
4227
|
/**
|
|
4228
|
+
* @public
|
|
3792
4229
|
* <p>Name of the ElasticSearch domain whose VPC endpoints are to be listed.</p>
|
|
3793
4230
|
*/
|
|
3794
4231
|
DomainName: string | undefined;
|
|
3795
4232
|
/**
|
|
4233
|
+
* @public
|
|
3796
4234
|
* <p>Provides an identifier to allow retrieval of paginated results.</p>
|
|
3797
4235
|
*/
|
|
3798
4236
|
NextToken?: string;
|
|
@@ -3803,10 +4241,12 @@ export interface ListVpcEndpointsForDomainRequest {
|
|
|
3803
4241
|
*/
|
|
3804
4242
|
export interface ListVpcEndpointsForDomainResponse {
|
|
3805
4243
|
/**
|
|
4244
|
+
* @public
|
|
3806
4245
|
* <p>Provides list of <code>VpcEndpointSummary</code> summarizing details of the VPC endpoints.</p>
|
|
3807
4246
|
*/
|
|
3808
4247
|
VpcEndpointSummaryList: VpcEndpointSummary[] | undefined;
|
|
3809
4248
|
/**
|
|
4249
|
+
* @public
|
|
3810
4250
|
* <p>Information about each endpoint associated with the domain.</p>
|
|
3811
4251
|
*/
|
|
3812
4252
|
NextToken: string | undefined;
|
|
@@ -3817,14 +4257,17 @@ export interface ListVpcEndpointsForDomainResponse {
|
|
|
3817
4257
|
*/
|
|
3818
4258
|
export interface PurchaseReservedElasticsearchInstanceOfferingRequest {
|
|
3819
4259
|
/**
|
|
4260
|
+
* @public
|
|
3820
4261
|
* <p>The ID of the reserved Elasticsearch instance offering to purchase.</p>
|
|
3821
4262
|
*/
|
|
3822
4263
|
ReservedElasticsearchInstanceOfferingId: string | undefined;
|
|
3823
4264
|
/**
|
|
4265
|
+
* @public
|
|
3824
4266
|
* <p>A customer-specified identifier to track this reservation.</p>
|
|
3825
4267
|
*/
|
|
3826
4268
|
ReservationName: string | undefined;
|
|
3827
4269
|
/**
|
|
4270
|
+
* @public
|
|
3828
4271
|
* <p>The number of Elasticsearch instances to reserve.</p>
|
|
3829
4272
|
*/
|
|
3830
4273
|
InstanceCount?: number;
|
|
@@ -3835,10 +4278,12 @@ export interface PurchaseReservedElasticsearchInstanceOfferingRequest {
|
|
|
3835
4278
|
*/
|
|
3836
4279
|
export interface PurchaseReservedElasticsearchInstanceOfferingResponse {
|
|
3837
4280
|
/**
|
|
4281
|
+
* @public
|
|
3838
4282
|
* <p>Details of the reserved Elasticsearch instance which was purchased.</p>
|
|
3839
4283
|
*/
|
|
3840
4284
|
ReservedElasticsearchInstanceId?: string;
|
|
3841
4285
|
/**
|
|
4286
|
+
* @public
|
|
3842
4287
|
* <p>The customer-specified identifier used to track this reservation.</p>
|
|
3843
4288
|
*/
|
|
3844
4289
|
ReservationName?: string;
|
|
@@ -3849,6 +4294,7 @@ export interface PurchaseReservedElasticsearchInstanceOfferingResponse {
|
|
|
3849
4294
|
*/
|
|
3850
4295
|
export interface RejectInboundCrossClusterSearchConnectionRequest {
|
|
3851
4296
|
/**
|
|
4297
|
+
* @public
|
|
3852
4298
|
* <p>The id of the inbound connection that you want to reject.</p>
|
|
3853
4299
|
*/
|
|
3854
4300
|
CrossClusterSearchConnectionId: string | undefined;
|
|
@@ -3859,6 +4305,7 @@ export interface RejectInboundCrossClusterSearchConnectionRequest {
|
|
|
3859
4305
|
*/
|
|
3860
4306
|
export interface RejectInboundCrossClusterSearchConnectionResponse {
|
|
3861
4307
|
/**
|
|
4308
|
+
* @public
|
|
3862
4309
|
* <p>Specifies the <code><a>InboundCrossClusterSearchConnection</a></code> of rejected inbound connection. </p>
|
|
3863
4310
|
*/
|
|
3864
4311
|
CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
|
|
@@ -3869,10 +4316,12 @@ export interface RejectInboundCrossClusterSearchConnectionResponse {
|
|
|
3869
4316
|
*/
|
|
3870
4317
|
export interface RemoveTagsRequest {
|
|
3871
4318
|
/**
|
|
4319
|
+
* @public
|
|
3872
4320
|
* <p>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</p>
|
|
3873
4321
|
*/
|
|
3874
4322
|
ARN: string | undefined;
|
|
3875
4323
|
/**
|
|
4324
|
+
* @public
|
|
3876
4325
|
* <p>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</p>
|
|
3877
4326
|
*/
|
|
3878
4327
|
TagKeys: string[] | undefined;
|
|
@@ -3884,10 +4333,12 @@ export interface RemoveTagsRequest {
|
|
|
3884
4333
|
*/
|
|
3885
4334
|
export interface RevokeVpcEndpointAccessRequest {
|
|
3886
4335
|
/**
|
|
4336
|
+
* @public
|
|
3887
4337
|
* <p>The name of the OpenSearch Service domain.</p>
|
|
3888
4338
|
*/
|
|
3889
4339
|
DomainName: string | undefined;
|
|
3890
4340
|
/**
|
|
4341
|
+
* @public
|
|
3891
4342
|
* <p>The account ID to revoke access from.</p>
|
|
3892
4343
|
*/
|
|
3893
4344
|
Account: string | undefined;
|
|
@@ -3904,6 +4355,7 @@ export interface RevokeVpcEndpointAccessResponse {
|
|
|
3904
4355
|
*/
|
|
3905
4356
|
export interface StartElasticsearchServiceSoftwareUpdateRequest {
|
|
3906
4357
|
/**
|
|
4358
|
+
* @public
|
|
3907
4359
|
* <p>The name of the domain that you want to update to the latest service software.</p>
|
|
3908
4360
|
*/
|
|
3909
4361
|
DomainName: string | undefined;
|
|
@@ -3914,6 +4366,7 @@ export interface StartElasticsearchServiceSoftwareUpdateRequest {
|
|
|
3914
4366
|
*/
|
|
3915
4367
|
export interface StartElasticsearchServiceSoftwareUpdateResponse {
|
|
3916
4368
|
/**
|
|
4369
|
+
* @public
|
|
3917
4370
|
* <p>The current status of the Elasticsearch service software update.</p>
|
|
3918
4371
|
*/
|
|
3919
4372
|
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
@@ -3924,63 +4377,78 @@ export interface StartElasticsearchServiceSoftwareUpdateResponse {
|
|
|
3924
4377
|
*/
|
|
3925
4378
|
export interface UpdateElasticsearchDomainConfigRequest {
|
|
3926
4379
|
/**
|
|
4380
|
+
* @public
|
|
3927
4381
|
* <p>The name of the Elasticsearch domain that you are updating. </p>
|
|
3928
4382
|
*/
|
|
3929
4383
|
DomainName: string | undefined;
|
|
3930
4384
|
/**
|
|
4385
|
+
* @public
|
|
3931
4386
|
* <p>The type and number of instances to instantiate for the domain cluster.</p>
|
|
3932
4387
|
*/
|
|
3933
4388
|
ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
|
|
3934
4389
|
/**
|
|
4390
|
+
* @public
|
|
3935
4391
|
* <p>Specify the type and size of the EBS volume that you want to use. </p>
|
|
3936
4392
|
*/
|
|
3937
4393
|
EBSOptions?: EBSOptions;
|
|
3938
4394
|
/**
|
|
4395
|
+
* @public
|
|
3939
4396
|
* <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>
|
|
3940
4397
|
*/
|
|
3941
4398
|
SnapshotOptions?: SnapshotOptions;
|
|
3942
4399
|
/**
|
|
4400
|
+
* @public
|
|
3943
4401
|
* <p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc" target="_blank">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>
|
|
3944
4402
|
*/
|
|
3945
4403
|
VPCOptions?: VPCOptions;
|
|
3946
4404
|
/**
|
|
4405
|
+
* @public
|
|
3947
4406
|
* <p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html" target="_blank">Amazon Cognito Authentication for Kibana</a>.</p>
|
|
3948
4407
|
*/
|
|
3949
4408
|
CognitoOptions?: CognitoOptions;
|
|
3950
4409
|
/**
|
|
4410
|
+
* @public
|
|
3951
4411
|
* <p>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>.
|
|
3952
4412
|
* See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</p>
|
|
3953
4413
|
*/
|
|
3954
4414
|
AdvancedOptions?: Record<string, string>;
|
|
3955
4415
|
/**
|
|
4416
|
+
* @public
|
|
3956
4417
|
* <p>IAM access policy as a JSON-formatted string.</p>
|
|
3957
4418
|
*/
|
|
3958
4419
|
AccessPolicies?: string;
|
|
3959
4420
|
/**
|
|
4421
|
+
* @public
|
|
3960
4422
|
* <p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>
|
|
3961
4423
|
*/
|
|
3962
4424
|
LogPublishingOptions?: Record<string, LogPublishingOption>;
|
|
3963
4425
|
/**
|
|
4426
|
+
* @public
|
|
3964
4427
|
* <p>Options to specify configuration that will be applied to the domain endpoint.</p>
|
|
3965
4428
|
*/
|
|
3966
4429
|
DomainEndpointOptions?: DomainEndpointOptions;
|
|
3967
4430
|
/**
|
|
4431
|
+
* @public
|
|
3968
4432
|
* <p>Specifies advanced security options.</p>
|
|
3969
4433
|
*/
|
|
3970
4434
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
|
|
3971
4435
|
/**
|
|
4436
|
+
* @public
|
|
3972
4437
|
* <p>Specifies the NodeToNodeEncryptionOptions.</p>
|
|
3973
4438
|
*/
|
|
3974
4439
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
3975
4440
|
/**
|
|
4441
|
+
* @public
|
|
3976
4442
|
* <p>Specifies the Encryption At Rest Options.</p>
|
|
3977
4443
|
*/
|
|
3978
4444
|
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
3979
4445
|
/**
|
|
4446
|
+
* @public
|
|
3980
4447
|
* <p>Specifies Auto-Tune options.</p>
|
|
3981
4448
|
*/
|
|
3982
4449
|
AutoTuneOptions?: AutoTuneOptions;
|
|
3983
4450
|
/**
|
|
4451
|
+
* @public
|
|
3984
4452
|
* <p>
|
|
3985
4453
|
* This flag, when set to True, specifies whether the <code>UpdateElasticsearchDomain</code> request should return the results of validation checks without actually applying the change.
|
|
3986
4454
|
* This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain.
|
|
@@ -3994,6 +4462,7 @@ export interface UpdateElasticsearchDomainConfigRequest {
|
|
|
3994
4462
|
*/
|
|
3995
4463
|
export interface DryRunResults {
|
|
3996
4464
|
/**
|
|
4465
|
+
* @public
|
|
3997
4466
|
* <p>
|
|
3998
4467
|
* Specifies the deployment mechanism through which the update shall be applied on the domain.
|
|
3999
4468
|
* Possible responses are
|
|
@@ -4005,6 +4474,7 @@ export interface DryRunResults {
|
|
|
4005
4474
|
*/
|
|
4006
4475
|
DeploymentType?: string;
|
|
4007
4476
|
/**
|
|
4477
|
+
* @public
|
|
4008
4478
|
* <p>Contains an optional message associated with the DryRunResults.</p>
|
|
4009
4479
|
*/
|
|
4010
4480
|
Message?: string;
|
|
@@ -4015,10 +4485,12 @@ export interface DryRunResults {
|
|
|
4015
4485
|
*/
|
|
4016
4486
|
export interface UpdateElasticsearchDomainConfigResponse {
|
|
4017
4487
|
/**
|
|
4488
|
+
* @public
|
|
4018
4489
|
* <p>The status of the updated Elasticsearch domain. </p>
|
|
4019
4490
|
*/
|
|
4020
4491
|
DomainConfig: ElasticsearchDomainConfig | undefined;
|
|
4021
4492
|
/**
|
|
4493
|
+
* @public
|
|
4022
4494
|
* <p>Contains result of DryRun. </p>
|
|
4023
4495
|
*/
|
|
4024
4496
|
DryRunResults?: DryRunResults;
|
|
@@ -4035,18 +4507,22 @@ export interface UpdateElasticsearchDomainConfigResponse {
|
|
|
4035
4507
|
*/
|
|
4036
4508
|
export interface UpdatePackageRequest {
|
|
4037
4509
|
/**
|
|
4510
|
+
* @public
|
|
4038
4511
|
* <p>Unique identifier for the package.</p>
|
|
4039
4512
|
*/
|
|
4040
4513
|
PackageID: string | undefined;
|
|
4041
4514
|
/**
|
|
4515
|
+
* @public
|
|
4042
4516
|
* <p>The S3 location for importing the package specified as <code>S3BucketName</code> and <code>S3Key</code></p>
|
|
4043
4517
|
*/
|
|
4044
4518
|
PackageSource: PackageSource | undefined;
|
|
4045
4519
|
/**
|
|
4520
|
+
* @public
|
|
4046
4521
|
* <p>New description of the package.</p>
|
|
4047
4522
|
*/
|
|
4048
4523
|
PackageDescription?: string;
|
|
4049
4524
|
/**
|
|
4525
|
+
* @public
|
|
4050
4526
|
* <p>An info message for the new version which will be shown as part of <code>GetPackageVersionHistoryResponse</code>.</p>
|
|
4051
4527
|
*/
|
|
4052
4528
|
CommitMessage?: string;
|
|
@@ -4063,6 +4539,7 @@ export interface UpdatePackageRequest {
|
|
|
4063
4539
|
*/
|
|
4064
4540
|
export interface UpdatePackageResponse {
|
|
4065
4541
|
/**
|
|
4542
|
+
* @public
|
|
4066
4543
|
* <p>Information about the package <code>PackageDetails</code>.</p>
|
|
4067
4544
|
*/
|
|
4068
4545
|
PackageDetails?: PackageDetails;
|
|
@@ -4073,10 +4550,12 @@ export interface UpdatePackageResponse {
|
|
|
4073
4550
|
*/
|
|
4074
4551
|
export interface UpdateVpcEndpointRequest {
|
|
4075
4552
|
/**
|
|
4553
|
+
* @public
|
|
4076
4554
|
* <p>Unique identifier of the VPC endpoint to be updated.</p>
|
|
4077
4555
|
*/
|
|
4078
4556
|
VpcEndpointId: string | undefined;
|
|
4079
4557
|
/**
|
|
4558
|
+
* @public
|
|
4080
4559
|
* <p>The security groups and/or subnets to add, remove, or modify.</p>
|
|
4081
4560
|
*/
|
|
4082
4561
|
VpcOptions: VPCOptions | undefined;
|
|
@@ -4087,6 +4566,7 @@ export interface UpdateVpcEndpointRequest {
|
|
|
4087
4566
|
*/
|
|
4088
4567
|
export interface UpdateVpcEndpointResponse {
|
|
4089
4568
|
/**
|
|
4569
|
+
* @public
|
|
4090
4570
|
* <p>The endpoint to be updated.</p>
|
|
4091
4571
|
*/
|
|
4092
4572
|
VpcEndpoint: VpcEndpoint | undefined;
|
|
@@ -4103,14 +4583,17 @@ export interface UpdateVpcEndpointResponse {
|
|
|
4103
4583
|
*/
|
|
4104
4584
|
export interface UpgradeElasticsearchDomainRequest {
|
|
4105
4585
|
/**
|
|
4586
|
+
* @public
|
|
4106
4587
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
4107
4588
|
*/
|
|
4108
4589
|
DomainName: string | undefined;
|
|
4109
4590
|
/**
|
|
4591
|
+
* @public
|
|
4110
4592
|
* <p>The version of Elasticsearch that you intend to upgrade the domain to.</p>
|
|
4111
4593
|
*/
|
|
4112
4594
|
TargetVersion: string | undefined;
|
|
4113
4595
|
/**
|
|
4596
|
+
* @public
|
|
4114
4597
|
* <p>
|
|
4115
4598
|
* This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.
|
|
4116
4599
|
* This will not actually perform the Upgrade.
|
|
@@ -4130,14 +4613,17 @@ export interface UpgradeElasticsearchDomainRequest {
|
|
|
4130
4613
|
*/
|
|
4131
4614
|
export interface UpgradeElasticsearchDomainResponse {
|
|
4132
4615
|
/**
|
|
4616
|
+
* @public
|
|
4133
4617
|
* <p>The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
|
|
4134
4618
|
*/
|
|
4135
4619
|
DomainName?: string;
|
|
4136
4620
|
/**
|
|
4621
|
+
* @public
|
|
4137
4622
|
* <p>The version of Elasticsearch that you intend to upgrade the domain to.</p>
|
|
4138
4623
|
*/
|
|
4139
4624
|
TargetVersion?: string;
|
|
4140
4625
|
/**
|
|
4626
|
+
* @public
|
|
4141
4627
|
* <p>
|
|
4142
4628
|
* This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.
|
|
4143
4629
|
* This will not actually perform the Upgrade.
|
|
@@ -4145,6 +4631,7 @@ export interface UpgradeElasticsearchDomainResponse {
|
|
|
4145
4631
|
*/
|
|
4146
4632
|
PerformCheckOnly?: boolean;
|
|
4147
4633
|
/**
|
|
4634
|
+
* @public
|
|
4148
4635
|
* <p>Specifies change details of the domain configuration change.</p>
|
|
4149
4636
|
*/
|
|
4150
4637
|
ChangeProgressDetails?: ChangeProgressDetails;
|