-
Notifications
You must be signed in to change notification settings - Fork 569
/
models_0.ts
10947 lines (9897 loc) · 346 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { ElastiCacheServiceException as __BaseException } from "./ElastiCacheServiceException";
/**
* <p>A tag that can be added to an ElastiCache cluster or replication group.
* Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.</p>
*/
export interface Tag {
/**
* <p>The key for the tag. May not be null.</p>
*/
Key?: string;
/**
* <p>The tag's value. May be null.</p>
*/
Value?: string;
}
/**
* <p>Represents the input of an AddTagsToResource operation.</p>
*/
export interface AddTagsToResourceMessage {
/**
* <p>The Amazon Resource Name (ARN) of the resource to which the tags are to be added,
* for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code>
* or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.
* ElastiCache resources are <i>cluster</i> and <i>snapshot</i>.</p>
* <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Service Namespaces</a>.</p>
*/
ResourceName: string | undefined;
/**
* <p>A list of tags to be added to this resource. A tag is a key-value pair.
* A tag key must be accompanied by a tag value, although null is accepted.</p>
*/
Tags: Tag[] | undefined;
}
/**
* <p>The requested cluster ID does not refer to an existing cluster.</p>
*/
export class CacheClusterNotFoundFault extends __BaseException {
readonly name: "CacheClusterNotFoundFault" = "CacheClusterNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<CacheClusterNotFoundFault, __BaseException>) {
super({
name: "CacheClusterNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, CacheClusterNotFoundFault.prototype);
}
}
/**
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
*/
export class CacheParameterGroupNotFoundFault extends __BaseException {
readonly name: "CacheParameterGroupNotFoundFault" = "CacheParameterGroupNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<CacheParameterGroupNotFoundFault, __BaseException>) {
super({
name: "CacheParameterGroupNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, CacheParameterGroupNotFoundFault.prototype);
}
}
/**
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
*/
export class CacheSecurityGroupNotFoundFault extends __BaseException {
readonly name: "CacheSecurityGroupNotFoundFault" = "CacheSecurityGroupNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<CacheSecurityGroupNotFoundFault, __BaseException>) {
super({
name: "CacheSecurityGroupNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, CacheSecurityGroupNotFoundFault.prototype);
}
}
/**
* <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
*/
export class CacheSubnetGroupNotFoundFault extends __BaseException {
readonly name: "CacheSubnetGroupNotFoundFault" = "CacheSubnetGroupNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<CacheSubnetGroupNotFoundFault, __BaseException>) {
super({
name: "CacheSubnetGroupNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, CacheSubnetGroupNotFoundFault.prototype);
}
}
/**
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
*/
export class InvalidARNFault extends __BaseException {
readonly name: "InvalidARNFault" = "InvalidARNFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidARNFault, __BaseException>) {
super({
name: "InvalidARNFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidARNFault.prototype);
}
}
/**
* <p>The requested replication group is not in the <code>available</code> state.</p>
*/
export class InvalidReplicationGroupStateFault extends __BaseException {
readonly name: "InvalidReplicationGroupStateFault" = "InvalidReplicationGroupStateFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidReplicationGroupStateFault, __BaseException>) {
super({
name: "InvalidReplicationGroupStateFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidReplicationGroupStateFault.prototype);
}
}
/**
* <p>The specified replication group does not exist.</p>
*/
export class ReplicationGroupNotFoundFault extends __BaseException {
readonly name: "ReplicationGroupNotFoundFault" = "ReplicationGroupNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ReplicationGroupNotFoundFault, __BaseException>) {
super({
name: "ReplicationGroupNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ReplicationGroupNotFoundFault.prototype);
}
}
/**
* <p>The requested reserved cache node was not found.</p>
*/
export class ReservedCacheNodeNotFoundFault extends __BaseException {
readonly name: "ReservedCacheNodeNotFoundFault" = "ReservedCacheNodeNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ReservedCacheNodeNotFoundFault, __BaseException>) {
super({
name: "ReservedCacheNodeNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ReservedCacheNodeNotFoundFault.prototype);
}
}
/**
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
*/
export class SnapshotNotFoundFault extends __BaseException {
readonly name: "SnapshotNotFoundFault" = "SnapshotNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<SnapshotNotFoundFault, __BaseException>) {
super({
name: "SnapshotNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, SnapshotNotFoundFault.prototype);
}
}
/**
* <p>Represents the output from the <code>AddTagsToResource</code>,
* <code>ListTagsForResource</code>, and <code>RemoveTagsFromResource</code> operations.</p>
*/
export interface TagListMessage {
/**
* <p>A list of tags as key-value pairs.</p>
*/
TagList?: Tag[];
}
/**
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
*/
export class TagQuotaPerResourceExceeded extends __BaseException {
readonly name: "TagQuotaPerResourceExceeded" = "TagQuotaPerResourceExceeded";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<TagQuotaPerResourceExceeded, __BaseException>) {
super({
name: "TagQuotaPerResourceExceeded",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, TagQuotaPerResourceExceeded.prototype);
}
}
/**
* <p>The user group was not found or does not exist</p>
*/
export class UserGroupNotFoundFault extends __BaseException {
readonly name: "UserGroupNotFoundFault" = "UserGroupNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<UserGroupNotFoundFault, __BaseException>) {
super({
name: "UserGroupNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, UserGroupNotFoundFault.prototype);
}
}
/**
* <p>The user does not exist or could not be found.</p>
*/
export class UserNotFoundFault extends __BaseException {
readonly name: "UserNotFoundFault" = "UserNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<UserNotFoundFault, __BaseException>) {
super({
name: "UserNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, UserNotFoundFault.prototype);
}
}
/**
* <p>Represents the allowed node types you can use to modify your cluster or replication group.</p>
*/
export interface AllowedNodeTypeModificationsMessage {
/**
* <p>A string list, each element of which specifies a cache node type which you can use
* to scale your cluster or replication group.</p>
* <p>When scaling up a Redis cluster or replication group using <code>ModifyCacheCluster</code> or
* <code>ModifyReplicationGroup</code>,
* use a value from this list for the <code>CacheNodeType</code> parameter.</p>
*/
ScaleUpModifications?: string[];
/**
* <p>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
*
* When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter. </p>
*/
ScaleDownModifications?: string[];
}
/**
* <p>The specified Amazon EC2 security group is already authorized for the specified cache security group.</p>
*/
export class AuthorizationAlreadyExistsFault extends __BaseException {
readonly name: "AuthorizationAlreadyExistsFault" = "AuthorizationAlreadyExistsFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AuthorizationAlreadyExistsFault, __BaseException>) {
super({
name: "AuthorizationAlreadyExistsFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AuthorizationAlreadyExistsFault.prototype);
}
}
/**
* <p>Represents the input of an AuthorizeCacheSecurityGroupIngress operation.</p>
*/
export interface AuthorizeCacheSecurityGroupIngressMessage {
/**
* <p>The cache security group that allows network ingress.</p>
*/
CacheSecurityGroupName: string | undefined;
/**
* <p>The Amazon EC2 security group to be authorized for ingress to the cache security group.</p>
*/
EC2SecurityGroupName: string | undefined;
/**
* <p>The Amazon account number of the Amazon EC2 security group owner.
* Note that this is not the same thing as an Amazon access key ID -
* you must provide a valid Amazon account number for this parameter.</p>
*/
EC2SecurityGroupOwnerId: string | undefined;
}
/**
* <p>Provides ownership and status information for an Amazon EC2 security group.</p>
*/
export interface EC2SecurityGroup {
/**
* <p>The status of the Amazon EC2 security group.</p>
*/
Status?: string;
/**
* <p>The name of the Amazon EC2 security group.</p>
*/
EC2SecurityGroupName?: string;
/**
* <p>The Amazon account ID of the Amazon EC2 security group owner.</p>
*/
EC2SecurityGroupOwnerId?: string;
}
/**
* <p>Represents the output of one of the following operations:</p>
* <ul>
* <li>
* <p>
* <code>AuthorizeCacheSecurityGroupIngress</code>
* </p>
* </li>
* <li>
* <p>
* <code>CreateCacheSecurityGroup</code>
* </p>
* </li>
* <li>
* <p>
* <code>RevokeCacheSecurityGroupIngress</code>
* </p>
* </li>
* </ul>
*/
export interface CacheSecurityGroup {
/**
* <p>The Amazon account ID of the cache security group owner.</p>
*/
OwnerId?: string;
/**
* <p>The name of the cache security group.</p>
*/
CacheSecurityGroupName?: string;
/**
* <p>The description of the cache security group.</p>
*/
Description?: string;
/**
* <p>A list of Amazon EC2 security groups that are associated with this cache security group.</p>
*/
EC2SecurityGroups?: EC2SecurityGroup[];
/**
* <p>The ARN of the cache security group,</p>
*/
ARN?: string;
}
export interface AuthorizeCacheSecurityGroupIngressResult {
/**
* <p>Represents the output of one of the following operations:</p>
* <ul>
* <li>
* <p>
* <code>AuthorizeCacheSecurityGroupIngress</code>
* </p>
* </li>
* <li>
* <p>
* <code>CreateCacheSecurityGroup</code>
* </p>
* </li>
* <li>
* <p>
* <code>RevokeCacheSecurityGroupIngress</code>
* </p>
* </li>
* </ul>
*/
CacheSecurityGroup?: CacheSecurityGroup;
}
/**
* <p>The current state of the cache security group does not allow deletion.</p>
*/
export class InvalidCacheSecurityGroupStateFault extends __BaseException {
readonly name: "InvalidCacheSecurityGroupStateFault" = "InvalidCacheSecurityGroupStateFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidCacheSecurityGroupStateFault, __BaseException>) {
super({
name: "InvalidCacheSecurityGroupStateFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidCacheSecurityGroupStateFault.prototype);
}
}
/**
* <p>Two or more incompatible parameters were specified.</p>
*/
export class InvalidParameterCombinationException extends __BaseException {
readonly name: "InvalidParameterCombinationException" = "InvalidParameterCombinationException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidParameterCombinationException, __BaseException>) {
super({
name: "InvalidParameterCombinationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidParameterCombinationException.prototype);
}
}
/**
* <p>The value for a parameter is invalid.</p>
*/
export class InvalidParameterValueException extends __BaseException {
readonly name: "InvalidParameterValueException" = "InvalidParameterValueException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>) {
super({
name: "InvalidParameterValueException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidParameterValueException.prototype);
}
}
export interface BatchApplyUpdateActionMessage {
/**
* <p>The replication group IDs</p>
*/
ReplicationGroupIds?: string[];
/**
* <p>The cache cluster IDs</p>
*/
CacheClusterIds?: string[];
/**
* <p>The unique ID of the service update</p>
*/
ServiceUpdateName: string | undefined;
}
/**
* <p>The service update doesn't exist</p>
*/
export class ServiceUpdateNotFoundFault extends __BaseException {
readonly name: "ServiceUpdateNotFoundFault" = "ServiceUpdateNotFoundFault";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceUpdateNotFoundFault, __BaseException>) {
super({
name: "ServiceUpdateNotFoundFault",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceUpdateNotFoundFault.prototype);
}
}
export enum UpdateActionStatus {
COMPLETE = "complete",
IN_PROGRESS = "in-progress",
NOT_APPLICABLE = "not-applicable",
NOT_APPLIED = "not-applied",
SCHEDULED = "scheduled",
SCHEDULING = "scheduling",
STOPPED = "stopped",
STOPPING = "stopping",
WAITING_TO_START = "waiting-to-start",
}
/**
* <p>Update action that has been processed for the corresponding apply/stop request</p>
*/
export interface ProcessedUpdateAction {
/**
* <p>The ID of the replication group</p>
*/
ReplicationGroupId?: string;
/**
* <p>The ID of the cache cluster</p>
*/
CacheClusterId?: string;
/**
* <p>The unique ID of the service update</p>
*/
ServiceUpdateName?: string;
/**
* <p>The status of the update action on the Redis cluster</p>
*/
UpdateActionStatus?: UpdateActionStatus | string;
}
/**
* <p>Update action that has failed to be processed for the corresponding apply/stop request</p>
*/
export interface UnprocessedUpdateAction {
/**
* <p>The replication group ID</p>
*/
ReplicationGroupId?: string;
/**
* <p>The ID of the cache cluster</p>
*/
CacheClusterId?: string;
/**
* <p>The unique ID of the service update</p>
*/
ServiceUpdateName?: string;
/**
* <p>The error type for requests that are not processed</p>
*/
ErrorType?: string;
/**
* <p>The error message that describes the reason the request was not processed</p>
*/
ErrorMessage?: string;
}
export interface UpdateActionResultsMessage {
/**
* <p>Update actions that have been processed successfully</p>
*/
ProcessedUpdateActions?: ProcessedUpdateAction[];
/**
* <p>Update actions that haven't been processed successfully</p>
*/
UnprocessedUpdateActions?: UnprocessedUpdateAction[];
}
export interface BatchStopUpdateActionMessage {
/**
* <p>The replication group IDs</p>
*/
ReplicationGroupIds?: string[];
/**
* <p>The cache cluster IDs</p>
*/
CacheClusterIds?: string[];
/**
* <p>The unique ID of the service update</p>
*/
ServiceUpdateName: string | undefined;
}
export interface CompleteMigrationMessage {
/**
* <p>The ID of the replication group to which data is being migrated.</p>
*/
ReplicationGroupId: string | undefined;
/**
* <p>Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.</p>
*/
Force?: boolean;
}
export enum AutomaticFailoverStatus {
DISABLED = "disabled",
DISABLING = "disabling",
ENABLED = "enabled",
ENABLING = "enabling",
}
/**
* <p>Represents the information required for client programs to connect to a cache node.</p>
*/
export interface Endpoint {
/**
* <p>The DNS hostname of the cache node.</p>
*/
Address?: string;
/**
* <p>The port number that the cache engine is listening on.</p>
*/
Port?: number;
}
export enum DataTieringStatus {
DISABLED = "disabled",
ENABLED = "enabled",
}
/**
* <p>The name of the Global datastore and role of this replication group in the Global datastore.</p>
*/
export interface GlobalReplicationGroupInfo {
/**
* <p>The name of the Global datastore</p>
*/
GlobalReplicationGroupId?: string;
/**
* <p>The role of the replication group in a Global datastore. Can be primary or secondary.</p>
*/
GlobalReplicationGroupMemberRole?: string;
}
export enum IpDiscovery {
IPV4 = "ipv4",
IPV6 = "ipv6",
}
/**
* <p>The configuration details of the CloudWatch Logs destination.</p>
*/
export interface CloudWatchLogsDestinationDetails {
/**
* <p>The name of the CloudWatch Logs log group.</p>
*/
LogGroup?: string;
}
/**
* <p>The configuration details of the Kinesis Data Firehose destination.</p>
*/
export interface KinesisFirehoseDestinationDetails {
/**
* <p>The name of the Kinesis Data Firehose delivery stream.</p>
*/
DeliveryStream?: string;
}
/**
* <p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>
*/
export interface DestinationDetails {
/**
* <p>The configuration details of the CloudWatch Logs destination.</p>
*/
CloudWatchLogsDetails?: CloudWatchLogsDestinationDetails;
/**
* <p>The configuration details of the Kinesis Data Firehose destination.</p>
*/
KinesisFirehoseDetails?: KinesisFirehoseDestinationDetails;
}
export enum DestinationType {
CloudWatchLogs = "cloudwatch-logs",
KinesisFirehose = "kinesis-firehose",
}
export enum LogFormat {
JSON = "json",
TEXT = "text",
}
export enum LogType {
ENGINE_LOG = "engine-log",
SLOW_LOG = "slow-log",
}
export enum LogDeliveryConfigurationStatus {
ACTIVE = "active",
DISABLING = "disabling",
ENABLING = "enabling",
ERROR = "error",
MODIFYING = "modifying",
}
/**
* <p>Returns the destination, format and type of the logs. </p>
*/
export interface LogDeliveryConfiguration {
/**
* <p>Refers to <a href="https://redis.io/commands/slowlog">slow-log</a> or engine-log.</p>
*/
LogType?: LogType | string;
/**
* <p>Returns the destination type, either <code>cloudwatch-logs</code> or <code>kinesis-firehose</code>.</p>
*/
DestinationType?: DestinationType | string;
/**
* <p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>
*/
DestinationDetails?: DestinationDetails;
/**
* <p>Returns the log format, either JSON or TEXT.</p>
*/
LogFormat?: LogFormat | string;
/**
* <p>Returns the log delivery configuration status. Values are one of <code>enabling</code> | <code>disabling</code> | <code>modifying</code> | <code>active</code> | <code>error</code>
* </p>
*/
Status?: LogDeliveryConfigurationStatus | string;
/**
* <p>Returns an error message for the log delivery configuration.</p>
*/
Message?: string;
}
export enum MultiAZStatus {
DISABLED = "disabled",
ENABLED = "enabled",
}
export enum NetworkType {
DUAL_STACK = "dual_stack",
IPV4 = "ipv4",
IPV6 = "ipv6",
}
/**
* <p>Represents a single node within a node group (shard).</p>
*/
export interface NodeGroupMember {
/**
* <p>The ID of the cluster to which the node belongs.</p>
*/
CacheClusterId?: string;
/**
* <p>The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>
*/
CacheNodeId?: string;
/**
* <p>The information required for client programs to connect to a node for read operations.
* The read endpoint is only applicable on Redis (cluster mode disabled) clusters.</p>
*/
ReadEndpoint?: Endpoint;
/**
* <p>The name of the Availability Zone in which the node is located.</p>
*/
PreferredAvailabilityZone?: string;
/**
* <p>The outpost ARN of the node group member.</p>
*/
PreferredOutpostArn?: string;
/**
* <p>The role that is currently assigned to the node - <code>primary</code> or
* <code>replica</code>. This member is only applicable for Redis (cluster mode disabled)
* replication groups.</p>
*/
CurrentRole?: string;
}
/**
* <p>Represents a collection of cache nodes in a replication group.
* One node in the node group is the read/write primary node.
* All the other nodes are read-only Replica nodes.</p>
*/
export interface NodeGroup {
/**
* <p>The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001.
* A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for
* a node group. </p>
*/
NodeGroupId?: string;
/**
* <p>The current state of this replication group - <code>creating</code>,
* <code>available</code>, <code>modifying</code>, <code>deleting</code>.</p>
*/
Status?: string;
/**
* <p>The endpoint of the primary node in this node group (shard).</p>
*/
PrimaryEndpoint?: Endpoint;
/**
* <p>The endpoint of the replica nodes in this node group (shard).</p>
*/
ReaderEndpoint?: Endpoint;
/**
* <p>The keyspace for this node group (shard).</p>
*/
Slots?: string;
/**
* <p>A list containing information about individual nodes within the node group (shard).</p>
*/
NodeGroupMembers?: NodeGroupMember[];
}
export enum AuthTokenUpdateStatus {
ROTATING = "ROTATING",
SETTING = "SETTING",
}
export enum PendingAutomaticFailoverStatus {
DISABLED = "disabled",
ENABLED = "enabled",
}
/**
* <p>The log delivery configurations being modified </p>
*/
export interface PendingLogDeliveryConfiguration {
/**
* <p>Refers to <a href="https://redis.io/commands/slowlog">slow-log</a> or engine-log..</p>
*/
LogType?: LogType | string;
/**
* <p>Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.</p>
*/
DestinationType?: DestinationType | string;
/**
* <p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>
*/
DestinationDetails?: DestinationDetails;
/**
* <p>Returns the log format, either JSON or TEXT</p>
*/
LogFormat?: LogFormat | string;
}
/**
* <p>Represents the progress of an online resharding operation.</p>
*/
export interface SlotMigration {
/**
* <p>The percentage of the slot migration that is complete.</p>
*/
ProgressPercentage?: number;
}
/**
* <p>The status of an online resharding operation.</p>
*/
export interface ReshardingStatus {
/**
* <p>Represents the progress of an online resharding operation.</p>
*/
SlotMigration?: SlotMigration;
}
/**
* <p>The status of the user group update.</p>
*/
export interface UserGroupsUpdateStatus {
/**
* <p>The ID of the user group to add.</p>
*/
UserGroupIdsToAdd?: string[];
/**
* <p>The ID of the user group to remove.</p>
*/
UserGroupIdsToRemove?: string[];
}
/**
* <p>The settings to be applied to the Redis replication group,
* either immediately or during the next maintenance window.</p>
*/
export interface ReplicationGroupPendingModifiedValues {
/**
* <p>The primary cluster ID that is applied immediately (if <code>--apply-immediately</code>
* was specified), or during the next maintenance window.</p>
*/
PrimaryClusterId?: string;
/**
* <p>Indicates the status of automatic failover for this Redis replication group.</p>
*/
AutomaticFailoverStatus?: PendingAutomaticFailoverStatus | string;
/**
* <p>The status of an online resharding operation.</p>
*/
Resharding?: ReshardingStatus;
/**
* <p>The auth token status</p>
*/
AuthTokenStatus?: AuthTokenUpdateStatus | string;
/**
* <p>The user group being modified.</p>
*/
UserGroups?: UserGroupsUpdateStatus;
/**
* <p>The log delivery configurations being modified </p>
*/
LogDeliveryConfigurations?: PendingLogDeliveryConfiguration[];
}
/**
* <p>Contains all of the attributes of a specific Redis replication group.</p>
*/
export interface ReplicationGroup {
/**
* <p>The identifier for the replication group.</p>
*/
ReplicationGroupId?: string;
/**
* <p>The user supplied description of the replication group.</p>
*/
Description?: string;
/**
* <p>The name of the Global datastore and role of this replication group in the Global datastore.</p>
*/
GlobalReplicationGroupInfo?: GlobalReplicationGroupInfo;
/**
* <p>The current state of this replication group -
* <code>creating</code>,
* <code>available</code>,
* <code>modifying</code>,
* <code>deleting</code>,
* <code>create-failed</code>,
* <code>snapshotting</code>.</p>
*/
Status?: string;