-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
2696 lines (2696 loc) · 273 KB
/
docs-2.json
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
{
"version": "2.0",
"service": "<fullname>Amazon ElastiCache</fullname> <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.</p> <p>With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.</p> <p>In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.</p>",
"operations": {
"AddTagsToResource": "<p>A tag is a key-value pair where the key and value are case-sensitive. 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. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html\">Resource-level permissions</a>.</p> <p> For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html\">Using Cost Allocation Tags in Amazon ElastiCache</a> in the <i>ElastiCache User Guide</i>.</p>",
"AuthorizeCacheSecurityGroupIngress": "<p>Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.</p> <note> <p>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.</p> </note>",
"BatchApplyUpdateAction": "<p>Apply the service update. For more information on service updates and applying them, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html\">Applying Service Updates</a>.</p>",
"BatchStopUpdateAction": "<p>Stop the service update. For more information on service updates and stopping them, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html\">Stopping Service Updates</a>.</p>",
"CompleteMigration": "<p>Complete the migration of data.</p>",
"CopySnapshot": "<p>Makes a copy of an existing snapshot.</p> <note> <p>This operation is valid for Redis only.</p> </note> <important> <p>Users or groups that have permissions to use the <code>CopySnapshot</code> operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the <code>CopySnapshot</code> operation. For more information about using IAM to control the use of ElastiCache operations, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html\">Exporting Snapshots</a> and <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html\">Authentication & Access Control</a>.</p> </important> <p>You could receive the following error messages.</p> <p class=\"title\"> <b>Error Messages</b> </p> <ul> <li> <p> <b>Error Message:</b> The S3 bucket %s is outside of the region.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s does not exist.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s is not owned by the authenticated user.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The authenticated user does not have sufficient permissions to perform the desired activity.</p> <p> <b>Solution:</b> Contact your system administrator to get the needed permissions.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s already contains an object with key %s.</p> <p> <b>Solution:</b> Give the <code>TargetSnapshotName</code> a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for <code>TargetSnapshotName</code>.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add List and Read permissions on the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add Upload/Delete permissions on the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add View Permissions on the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> </ul>",
"CreateCacheCluster": "<p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.</p> <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>",
"CreateCacheParameterGroup": "<p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.</p> <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html\">ModifyCacheParameterGroup</a> in the ElastiCache API Reference.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html\">Parameters and Parameter Groups</a> in the ElastiCache User Guide.</p> </li> </ul>",
"CreateCacheSecurityGroup": "<p>Creates a new cache security group. Use a cache security group to control access to one or more clusters.</p> <p>Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html\">CreateCacheSubnetGroup</a>.</p>",
"CreateCacheSubnetGroup": "<p>Creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>",
"CreateGlobalReplicationGroup": "<p>Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html\">Replication Across Regions Using Global Datastore</a>. </p> <ul> <li> <p>The <b>GlobalReplicationGroupIdSuffix</b> is the name of the Global datastore.</p> </li> <li> <p>The <b>PrimaryReplicationGroupId</b> represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p> </li> </ul>",
"CreateReplicationGroup": "<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. </p> <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html\">Creating a Subnet Group</a>. For versions below 5.0.6, the limit is 250 per cluster.</p> <p>To request a limit increase, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">Amazon Service Limits</a> and choose the limit type <b>Nodes per cluster per instance type</b>. </p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"CreateSnapshot": "<p>Creates a copy of an entire cluster or replication group at a specific moment in time.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"CreateUser": "<p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>.</p>",
"CreateUserGroup": "<p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a> </p>",
"DecreaseNodeGroupsInGlobalReplicationGroup": "<p>Decreases the number of node groups in a Global datastore</p>",
"DecreaseReplicaCount": "<p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>",
"DeleteCacheCluster": "<p>Deletes a previously provisioned cluster. <code>DeleteCacheCluster</code> deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.</p> <p>This operation is not valid for:</p> <ul> <li> <p>Redis (cluster mode enabled) clusters</p> </li> <li> <p>Redis (cluster mode disabled) clusters</p> </li> <li> <p>A cluster that is the last read replica of a replication group</p> </li> <li> <p>A cluster that is the primary node of a replication group</p> </li> <li> <p>A node group (shard) that has Multi-AZ mode enabled</p> </li> <li> <p>A cluster from a Redis (cluster mode enabled) replication group</p> </li> <li> <p>A cluster that is not in the <code>available</code> state</p> </li> </ul>",
"DeleteCacheParameterGroup": "<p>Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.</p>",
"DeleteCacheSecurityGroup": "<p>Deletes a cache security group.</p> <note> <p>You cannot delete a cache security group if it is associated with any clusters.</p> </note>",
"DeleteCacheSubnetGroup": "<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p> </note>",
"DeleteGlobalReplicationGroup": "<p>Deleting a Global datastore is a two-step process: </p> <ul> <li> <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary clusters in the Global datastore.</p> </li> <li> <p>Once the Global datastore contains only the primary cluster, you can use the <code>DeleteGlobalReplicationGroup</code> API to delete the Global datastore while retainining the primary cluster using <code>RetainPrimaryReplicationGroup=true</code>.</p> </li> </ul> <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting <code>RetainPrimaryReplicationGroup=true</code>. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.</p> <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</p>",
"DeleteReplicationGroup": "<p>Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting <code>RetainPrimaryCluster=true</code>.</p> <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"DeleteSnapshot": "<p>Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"DeleteUser": "<p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>. </p>",
"DeleteUserGroup": "<p>For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html\">Using Role Based Access Control (RBAC)</a>. </p>",
"DescribeCacheClusters": "<p>Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.</p> <p>By default, abbreviated information about the clusters is returned. You can use the optional <i>ShowCacheNodeInfo</i> flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.</p> <p>If the cluster is in the <i>creating</i> state, only cluster-level information is displayed until all of the nodes are successfully provisioned.</p> <p>If the cluster is in the <i>deleting</i> state, only cluster-level information is displayed.</p> <p>If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is <i>available</i>, the cluster is ready for use.</p> <p>If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.</p>",
"DescribeCacheEngineVersions": "<p>Returns a list of the available cache engines and their versions.</p>",
"DescribeCacheParameterGroups": "<p>Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.</p>",
"DescribeCacheParameters": "<p>Returns the detailed parameter list for a particular cache parameter group.</p>",
"DescribeCacheSecurityGroups": "<p>Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup </p>",
"DescribeCacheSubnetGroups": "<p>Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. </p>",
"DescribeEngineDefaultParameters": "<p>Returns the default engine and system parameter information for the specified cache engine.</p>",
"DescribeEvents": "<p>Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>",
"DescribeGlobalReplicationGroups": "<p>Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. </p>",
"DescribeReplicationGroups": "<p>Returns information about a particular replication group. If no identifier is specified, <code>DescribeReplicationGroups</code> returns information about all replication groups.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"DescribeReservedCacheNodes": "<p>Returns information about reserved cache nodes for this account, or about a specified reserved cache node.</p>",
"DescribeReservedCacheNodesOfferings": "<p>Lists available reserved cache node offerings.</p>",
"DescribeServiceUpdates": "<p>Returns details of the service updates</p>",
"DescribeSnapshots": "<p>Returns information about cluster or replication group snapshots. By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.</p> <note> <p>This operation is valid for Redis only.</p> </note>",
"DescribeUpdateActions": "<p>Returns details of the update actions </p>",
"DescribeUserGroups": "<p>Returns a list of user groups.</p>",
"DescribeUsers": "<p>Returns a list of users.</p>",
"DisassociateGlobalReplicationGroup": "<p>Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.</p>",
"FailoverGlobalReplicationGroup": "<p>Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.</p>",
"IncreaseNodeGroupsInGlobalReplicationGroup": "<p>Increase the number of node groups in the Global datastore</p>",
"IncreaseReplicaCount": "<p>Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>",
"ListAllowedNodeTypeModifications": "<p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type.</p> <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to scale your cluster or replication group, the value of the <code>CacheNodeType</code> parameter must be one of the node types returned by this operation.</p>",
"ListTagsForResource": "<p>Lists all tags currently on a named resource.</p> <p> A tag is a key-value pair where the key and value are case-sensitive. 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. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html\">Resource-level permissions</a>.</p> <p>If the cluster is not in the <i>available</i> state, <code>ListTagsForResource</code> returns an error.</p>",
"ModifyCacheCluster": "<p>Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.</p>",
"ModifyCacheParameterGroup": "<p>Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.</p>",
"ModifyCacheSubnetGroup": "<p>Modifies an existing cache subnet group.</p>",
"ModifyGlobalReplicationGroup": "<p>Modifies the settings for a Global datastore.</p>",
"ModifyReplicationGroup": "<p>Modifies the settings for a replication group.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html\">Scaling for Amazon ElastiCache for Redis (cluster mode enabled)</a> in the ElastiCache User Guide</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html\">ModifyReplicationGroupShardConfiguration</a> in the ElastiCache API Reference</p> </li> </ul> <note> <p>This operation is valid for Redis only.</p> </note>",
"ModifyReplicationGroupShardConfiguration": "<p>Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.</p>",
"ModifyUser": "<p>Changes user password(s) and/or access string.</p>",
"ModifyUserGroup": "<p>Changes the list of users that belong to the user group.</p>",
"PurchaseReservedCacheNodesOffering": "<p>Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html\">Managing Costs with Reserved Nodes</a> for Redis or <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html\">Managing Costs with Reserved Nodes</a> for Memcached.</p>",
"RebalanceSlotsInGlobalReplicationGroup": "<p>Redistribute slots to ensure uniform distribution across existing shards in the cluster.</p>",
"RebootCacheCluster": "<p>Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.</p> <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p> <p>When the reboot is complete, a cluster event is created.</p> <p>Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.</p> <p>If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html\">Rebooting a Cluster</a> for an alternate process.</p>",
"RemoveTagsFromResource": "<p>Removes the tags identified by the <code>TagKeys</code> list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. 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. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html\">Resource-level permissions</a>.</p>",
"ResetCacheParameterGroup": "<p>Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <code>ResetAllParameters</code> and <code>CacheParameterGroupName</code> parameters.</p>",
"RevokeCacheSecurityGroupIngress": "<p>Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.</p>",
"StartMigration": "<p>Start the migration of data.</p>",
"TestFailover": "<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).</p> <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. </p> <p class=\"title\"> <b>Note the following</b> </p> <ul> <li> <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.</p> </li> <li> <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p> <p> </p> </li> <li> <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.</p> </li> <li> <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:</p> <ol> <li> <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code> </p> </li> <li> <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Cache cluster message: <code>Recovering cache nodes <node-id></code> </p> </li> <li> <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code> </p> </li> </ol> <p>For more information see:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a> in the <i>ElastiCache User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p> </li> </ul> </li> </ul> <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
},
"shapes": {
"APICallRateForCustomerExceededFault": {
"base": "<p>The customer has exceeded the allowed rate of API calls.</p>",
"refs": {
}
},
"AZMode": {
"base": null,
"refs": {
"CreateCacheClusterMessage$AZMode": "<p>Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.</p> <p>This parameter is only supported for Memcached clusters.</p> <p>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</p>",
"ModifyCacheClusterMessage$AZMode": "<p>Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.</p> <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p> <p>This option is only supported for Memcached clusters.</p> <note> <p>You cannot specify <code>single-az</code> if the Memcached cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</p> <p>Only newly created nodes are located in different Availability Zones. </p> </note>"
}
},
"AccessString": {
"base": null,
"refs": {
"CreateUserMessage$AccessString": "<p>Access permissions string used for this user.</p>",
"ModifyUserMessage$AccessString": "<p>Access permissions string used for this user.</p>",
"ModifyUserMessage$AppendAccessString": "<p>Adds additional user permissions to the access string.</p>"
}
},
"AddTagsToResourceMessage": {
"base": "<p>Represents the input of an AddTagsToResource operation.</p>",
"refs": {
}
},
"AllowedNodeGroupId": {
"base": null,
"refs": {
"ConfigureShard$NodeGroupId": "<p>The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html\">Finding a Shard's Id</a>.</p>",
"NodeGroupConfiguration$NodeGroupId": "<p>Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.</p>",
"NodeGroupsToRemoveList$member": null,
"NodeGroupsToRetainList$member": null,
"ReshardingConfiguration$NodeGroupId": "<p>Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.</p>",
"TestFailoverMessage$NodeGroupId": "<p>The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.</p>"
}
},
"AllowedNodeTypeModificationsMessage": {
"base": "<p>Represents the allowed node types you can use to modify your cluster or replication group.</p>",
"refs": {
}
},
"AuthTokenUpdateStatus": {
"base": null,
"refs": {
"PendingModifiedValues$AuthTokenStatus": "<p>The auth token status</p>",
"ReplicationGroupPendingModifiedValues$AuthTokenStatus": "<p>The auth token status</p>"
}
},
"AuthTokenUpdateStrategyType": {
"base": null,
"refs": {
"ModifyCacheClusterMessage$AuthTokenUpdateStrategy": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be specified with the <code>auth-token</code> parameter. Possible values:</p> <ul> <li> <p>Rotate</p> </li> <li> <p>Set</p> </li> </ul> <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a> </p>",
"ModifyReplicationGroupMessage$AuthTokenUpdateStrategy": "<p>Specifies the strategy to use to update the AUTH token. This parameter must be specified with the <code>auth-token</code> parameter. Possible values:</p> <ul> <li> <p>Rotate</p> </li> <li> <p>Set</p> </li> </ul> <p> For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html\">Authenticating Users with Redis AUTH</a> </p>"
}
},
"Authentication": {
"base": "<p>Indicates whether the user requires a password to authenticate.</p>",
"refs": {
"User$Authentication": "<p>Denotes whether the user requires a password to authenticate.</p>"
}
},
"AuthenticationType": {
"base": null,
"refs": {
"Authentication$Type": "<p>Indicates whether the user requires a password to authenticate.</p>"
}
},
"AuthorizationAlreadyExistsFault": {
"base": "<p>The specified Amazon EC2 security group is already authorized for the specified cache security group.</p>",
"refs": {
}
},
"AuthorizationNotFoundFault": {
"base": "<p>The specified Amazon EC2 security group is not authorized for the specified cache security group.</p>",
"refs": {
}
},
"AuthorizeCacheSecurityGroupIngressMessage": {
"base": "<p>Represents the input of an AuthorizeCacheSecurityGroupIngress operation.</p>",
"refs": {
}
},
"AuthorizeCacheSecurityGroupIngressResult": {
"base": null,
"refs": {
}
},
"AutomaticFailoverStatus": {
"base": null,
"refs": {
"GlobalReplicationGroupMember$AutomaticFailover": "<p>Indicates whether automatic failover is enabled for the replication group.</p>",
"ReplicationGroup$AutomaticFailover": "<p>Indicates the status of automatic failover for this Redis replication group.</p>",
"Snapshot$AutomaticFailover": "<p>Indicates the status of automatic failover for the source Redis replication group.</p>"
}
},
"AvailabilityZone": {
"base": "<p>Describes an Availability Zone in which the cluster is launched.</p>",
"refs": {
"Subnet$SubnetAvailabilityZone": "<p>The Availability Zone associated with the subnet.</p>"
}
},
"AvailabilityZonesList": {
"base": null,
"refs": {
"CreateReplicationGroupMessage$PreferredCacheClusterAZs": "<p>A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.</p> <p>This parameter is not used if there is more than one node group (shard). You should use <code>NodeGroupConfiguration</code> instead.</p> <note> <p>If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.</p> <p>The number of Availability Zones listed must equal the value of <code>NumCacheClusters</code>.</p> </note> <p>Default: system chosen Availability Zones.</p>",
"NodeGroupConfiguration$ReplicaAvailabilityZones": "<p>A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of <code>ReplicaCount</code> or <code>ReplicasPerNodeGroup</code> if not specified.</p>",
"ReshardingConfiguration$PreferredAvailabilityZones": "<p>A list of preferred availability zones for the nodes in this cluster.</p>"
}
},
"AwsQueryErrorMessage": {
"base": null,
"refs": {
"InvalidParameterCombinationException$message": "<p>Two or more parameters that must not be used together were used together.</p>",
"InvalidParameterValueException$message": "<p>A parameter value is invalid.</p>"
}
},
"BatchApplyUpdateActionMessage": {
"base": null,
"refs": {
}
},
"BatchStopUpdateActionMessage": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"CacheCluster$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>",
"CacheCluster$ReplicationGroupLogDeliveryEnabled": "<p>A boolean value indicating whether log delivery is enabled for the replication group.</p>",
"CacheNodeTypeSpecificParameter$IsModifiable": "<p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>",
"CacheParameterGroup$IsGlobal": "<p>Indicates whether the parameter group is associated with a Global datastore</p>",
"CompleteMigrationMessage$Force": "<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>",
"DecreaseNodeGroupsInGlobalReplicationGroupMessage$ApplyImmediately": "<p>Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. </p>",
"DecreaseReplicaCountMessage$ApplyImmediately": "<p>If <code>True</code>, the number of replica nodes is decreased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>",
"DeleteGlobalReplicationGroupMessage$RetainPrimaryReplicationGroup": "<p>The primary replication group is retained as a standalone replication group. </p>",
"DescribeCacheEngineVersionsMessage$DefaultOnly": "<p>If <code>true</code>, specifies that only the default version of the specified engine or engine and major version combination is to be returned.</p>",
"IncreaseNodeGroupsInGlobalReplicationGroupMessage$ApplyImmediately": "<p>Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.</p>",
"IncreaseReplicaCountMessage$ApplyImmediately": "<p>If <code>True</code>, the number of replica nodes is increased immediately. <code>ApplyImmediately=False</code> is not currently supported.</p>",
"ModifyCacheClusterMessage$ApplyImmediately": "<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster.</p> <p>If <code>false</code>, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <important> <p>If you perform a <code>ModifyCacheCluster</code> before a pending modification is applied, the pending modification is replaced by the newer modification.</p> </important> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>",
"ModifyGlobalReplicationGroupMessage$ApplyImmediately": "<p>This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow. </p>",
"ModifyReplicationGroupMessage$ApplyImmediately": "<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the replication group.</p> <p>If <code>false</code>, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>",
"ModifyReplicationGroupShardConfigurationMessage$ApplyImmediately": "<p>Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is <code>true</code>.</p> <p>Value: true</p>",
"Parameter$IsModifiable": "<p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>",
"RebalanceSlotsInGlobalReplicationGroupMessage$ApplyImmediately": "<p>If <code>True</code>, redistribution is applied immediately.</p>",
"ResetCacheParameterGroupMessage$ResetAllParameters": "<p>If <code>true</code>, all parameters in the cache parameter group are reset to their default values. If <code>false</code>, only the parameters listed by <code>ParameterNameValues</code> are reset to their default values.</p> <p>Valid values: <code>true</code> | <code>false</code> </p>",
"Snapshot$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>"
}
},
"BooleanOptional": {
"base": null,
"refs": {
"CacheCluster$AuthTokenEnabled": "<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>",
"CacheCluster$TransitEncryptionEnabled": "<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>",
"CacheCluster$AtRestEncryptionEnabled": "<p>A flag that enables encryption at-rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the cluster is created. To enable at-rest encryption on a cluster you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>",
"CreateCacheClusterMessage$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>",
"CreateReplicationGroupMessage$AutomaticFailoverEnabled": "<p>Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.</p> <p> <code>AutomaticFailoverEnabled</code> must be enabled for Redis (cluster mode enabled) replication groups.</p> <p>Default: false</p>",
"CreateReplicationGroupMessage$MultiAZEnabled": "<p>A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html\">Minimizing Downtime: Multi-AZ</a>.</p>",
"CreateReplicationGroupMessage$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>",
"CreateReplicationGroupMessage$TransitEncryptionEnabled": "<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p>This parameter is valid only if the <code>Engine</code> parameter is <code>redis</code>, the <code>EngineVersion</code> parameter is <code>3.2.6</code>, <code>4.x</code> or later, and the cluster is being created in an Amazon VPC.</p> <p>If you enable in-transit encryption, you must also specify a value for <code>CacheSubnetGroup</code>.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p> <important> <p>For HIPAA compliance, you must specify <code>TransitEncryptionEnabled</code> as <code>true</code>, an <code>AuthToken</code>, and a <code>CacheSubnetGroup</code>.</p> </important>",
"CreateReplicationGroupMessage$AtRestEncryptionEnabled": "<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>",
"CreateReplicationGroupMessage$DataTieringEnabled": "<p>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html\">Data tiering</a>.</p>",
"CreateUserMessage$NoPasswordRequired": "<p>Indicates a password is not required for this user.</p>",
"DeleteReplicationGroupMessage$RetainPrimaryCluster": "<p>If set to <code>true</code>, all of the read replicas are deleted, but the primary node is retained.</p>",
"DescribeCacheClustersMessage$ShowCacheNodeInfo": "<p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to retrieve information about the individual cache nodes.</p>",
"DescribeCacheClustersMessage$ShowCacheClustersNotInReplicationGroups": "<p>An optional flag that can be included in the <code>DescribeCacheCluster</code> request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.</p>",
"DescribeGlobalReplicationGroupsMessage$ShowMemberInfo": "<p>Returns the list of members that comprise the Global datastore.</p>",
"DescribeSnapshotsMessage$ShowNodeGroupConfig": "<p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>",
"DescribeUpdateActionsMessage$ShowNodeLevelUpdateStatus": "<p>Dictates whether to include node level update status in the response </p>",
"GlobalReplicationGroup$ClusterEnabled": "<p>A flag that indicates whether the Global datastore is cluster enabled.</p>",
"GlobalReplicationGroup$AuthTokenEnabled": "<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>",
"GlobalReplicationGroup$TransitEncryptionEnabled": "<p>A flag that enables in-transit encryption when set to true. You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to true when you create a cluster. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p>",
"GlobalReplicationGroup$AtRestEncryptionEnabled": "<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p>",
"LogDeliveryConfigurationRequest$Enabled": "<p>Specify if log delivery is enabled. Default <code>true</code>.</p>",
"ModifyCacheClusterMessage$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>",
"ModifyGlobalReplicationGroupMessage$AutomaticFailoverEnabled": "<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. </p>",
"ModifyReplicationGroupMessage$AutomaticFailoverEnabled": "<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p>",
"ModifyReplicationGroupMessage$MultiAZEnabled": "<p>A flag to indicate MultiAZ is enabled.</p>",
"ModifyReplicationGroupMessage$AutoMinorVersionUpgrade": "<p> If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. </p>",
"ModifyReplicationGroupMessage$RemoveUserGroups": "<p>Removes the user group associated with this replication group.</p>",
"ModifyUserMessage$NoPasswordRequired": "<p>Indicates no password is required for the user.</p>",
"ReplicationGroup$ClusterEnabled": "<p>A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).</p> <p>Valid values: <code>true</code> | <code>false</code> </p>",
"ReplicationGroup$AuthTokenEnabled": "<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>",
"ReplicationGroup$TransitEncryptionEnabled": "<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>",
"ReplicationGroup$AtRestEncryptionEnabled": "<p>A flag that enables encryption at-rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the cluster is created. To enable encryption at-rest on a cluster you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>",
"ServiceUpdate$AutoUpdateAfterRecommendedApplyByDate": "<p>Indicates whether the service update will be automatically applied once the recommended apply-by date has expired. </p>"
}
},
"CacheCluster": {
"base": "<p>Contains all of the attributes of a specific cluster.</p>",
"refs": {
"CacheClusterList$member": null,
"CreateCacheClusterResult$CacheCluster": null,
"DeleteCacheClusterResult$CacheCluster": null,
"ModifyCacheClusterResult$CacheCluster": null,
"RebootCacheClusterResult$CacheCluster": null
}
},
"CacheClusterAlreadyExistsFault": {
"base": "<p>You already have a cluster with the given identifier.</p>",
"refs": {
}
},
"CacheClusterIdList": {
"base": null,
"refs": {
"BatchApplyUpdateActionMessage$CacheClusterIds": "<p>The cache cluster IDs</p>",
"BatchStopUpdateActionMessage$CacheClusterIds": "<p>The cache cluster IDs</p>",
"DescribeUpdateActionsMessage$CacheClusterIds": "<p>The cache cluster IDs</p>"
}
},
"CacheClusterList": {
"base": null,
"refs": {
"CacheClusterMessage$CacheClusters": "<p>A list of clusters. Each item in the list contains detailed information about one cluster.</p>"
}
},
"CacheClusterMessage": {
"base": "<p>Represents the output of a <code>DescribeCacheClusters</code> operation.</p>",
"refs": {
}
},
"CacheClusterNotFoundFault": {
"base": "<p>The requested cluster ID does not refer to an existing cluster.</p>",
"refs": {
}
},
"CacheEngineVersion": {
"base": "<p>Provides all of the details about a particular cache engine version.</p>",
"refs": {
"CacheEngineVersionList$member": null
}
},
"CacheEngineVersionList": {
"base": null,
"refs": {
"CacheEngineVersionMessage$CacheEngineVersions": "<p>A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.</p>"
}
},
"CacheEngineVersionMessage": {
"base": "<p>Represents the output of a <a>DescribeCacheEngineVersions</a> operation.</p>",
"refs": {
}
},
"CacheNode": {
"base": "<p>Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>",
"refs": {
"CacheNodeList$member": null
}
},
"CacheNodeIdsList": {
"base": null,
"refs": {
"CacheParameterGroupStatus$CacheNodeIdsToReboot": "<p>A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>",
"ModifyCacheClusterMessage$CacheNodeIdsToRemove": "<p>A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when <code>NumCacheNodes</code> is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of <code>NumCacheNodes</code> in the request.</p> <p>For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this <code>ModifyCacheCluster</code> call is 5, you must list 2 (7 - 5) cache node IDs to remove.</p>",
"PendingModifiedValues$CacheNodeIdsToRemove": "<p>A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).</p>",
"RebootCacheClusterMessage$CacheNodeIdsToReboot": "<p>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.</p>"
}
},
"CacheNodeList": {
"base": null,
"refs": {
"CacheCluster$CacheNodes": "<p>A list of cache nodes that are members of the cluster.</p>"
}
},
"CacheNodeTypeSpecificParameter": {
"base": "<p>A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a <code>cache.m1.large</code> cache node type would have a larger <code>maxmemory</code> value than a <code>cache.m1.small</code> type.</p>",
"refs": {
"CacheNodeTypeSpecificParametersList$member": null
}
},
"CacheNodeTypeSpecificParametersList": {
"base": null,
"refs": {
"CacheParameterGroupDetails$CacheNodeTypeSpecificParameters": "<p>A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.</p>",
"EngineDefaults$CacheNodeTypeSpecificParameters": "<p>A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.</p>"
}
},
"CacheNodeTypeSpecificValue": {
"base": "<p>A value that applies only to a certain cache node type.</p>",
"refs": {
"CacheNodeTypeSpecificValueList$member": null
}
},
"CacheNodeTypeSpecificValueList": {
"base": null,
"refs": {
"CacheNodeTypeSpecificParameter$CacheNodeTypeSpecificValues": "<p>A list of cache node types and their corresponding values for this parameter.</p>"
}
},
"CacheNodeUpdateStatus": {
"base": "<p>The status of the service update on the cache node</p>",
"refs": {
"CacheNodeUpdateStatusList$member": null
}
},
"CacheNodeUpdateStatusList": {
"base": null,
"refs": {
"UpdateAction$CacheNodeUpdateStatus": "<p>The status of the service update on the cache node</p>"
}
},
"CacheParameterGroup": {
"base": "<p>Represents the output of a <code>CreateCacheParameterGroup</code> operation.</p>",
"refs": {
"CacheParameterGroupList$member": null,
"CreateCacheParameterGroupResult$CacheParameterGroup": null
}
},
"CacheParameterGroupAlreadyExistsFault": {
"base": "<p>A cache parameter group with the requested name already exists.</p>",
"refs": {
}
},
"CacheParameterGroupDetails": {
"base": "<p>Represents the output of a <code>DescribeCacheParameters</code> operation.</p>",
"refs": {
}
},
"CacheParameterGroupList": {
"base": null,
"refs": {
"CacheParameterGroupsMessage$CacheParameterGroups": "<p>A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.</p>"
}
},
"CacheParameterGroupNameMessage": {
"base": "<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>ModifyCacheParameterGroup</code> </p> </li> <li> <p> <code>ResetCacheParameterGroup</code> </p> </li> </ul>",
"refs": {
}
},
"CacheParameterGroupNotFoundFault": {
"base": "<p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>",
"refs": {
}
},
"CacheParameterGroupQuotaExceededFault": {
"base": "<p>The request cannot be processed because it would exceed the maximum number of cache security groups.</p>",
"refs": {
}
},
"CacheParameterGroupStatus": {
"base": "<p>Status of the cache parameter group.</p>",
"refs": {
"CacheCluster$CacheParameterGroup": "<p>Status of the cache parameter group.</p>"
}
},
"CacheParameterGroupsMessage": {
"base": "<p>Represents the output of a <code>DescribeCacheParameterGroups</code> operation.</p>",
"refs": {
}
},
"CacheSecurityGroup": {
"base": "<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>",
"refs": {
"AuthorizeCacheSecurityGroupIngressResult$CacheSecurityGroup": null,
"CacheSecurityGroups$member": null,
"CreateCacheSecurityGroupResult$CacheSecurityGroup": null,
"RevokeCacheSecurityGroupIngressResult$CacheSecurityGroup": null
}
},
"CacheSecurityGroupAlreadyExistsFault": {
"base": "<p>A cache security group with the specified name already exists.</p>",
"refs": {
}
},
"CacheSecurityGroupMembership": {
"base": "<p>Represents a cluster's status within a particular cache security group.</p>",
"refs": {
"CacheSecurityGroupMembershipList$member": null
}
},
"CacheSecurityGroupMembershipList": {
"base": null,
"refs": {
"CacheCluster$CacheSecurityGroups": "<p>A list of cache security group elements, composed of name and status sub-elements.</p>"
}
},
"CacheSecurityGroupMessage": {
"base": "<p>Represents the output of a <code>DescribeCacheSecurityGroups</code> operation.</p>",
"refs": {
}
},
"CacheSecurityGroupNameList": {
"base": null,
"refs": {
"CreateCacheClusterMessage$CacheSecurityGroupNames": "<p>A list of security group names to associate with this cluster.</p> <p>Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).</p>",
"CreateReplicationGroupMessage$CacheSecurityGroupNames": "<p>A list of cache security group names to associate with this replication group.</p>",
"ModifyCacheClusterMessage$CacheSecurityGroupNames": "<p>A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.</p> <p>You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".</p>",
"ModifyReplicationGroupMessage$CacheSecurityGroupNames": "<p>A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.</p> <p>This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be <code>Default</code>.</p>"
}
},
"CacheSecurityGroupNotFoundFault": {
"base": "<p>The requested cache security group name does not refer to an existing cache security group.</p>",
"refs": {
}
},
"CacheSecurityGroupQuotaExceededFault": {
"base": "<p>The request cannot be processed because it would exceed the allowed number of cache security groups.</p>",
"refs": {
}
},
"CacheSecurityGroups": {
"base": null,
"refs": {
"CacheSecurityGroupMessage$CacheSecurityGroups": "<p>A list of cache security groups. Each element in the list contains detailed information about one group.</p>"
}
},
"CacheSubnetGroup": {
"base": "<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>CreateCacheSubnetGroup</code> </p> </li> <li> <p> <code>ModifyCacheSubnetGroup</code> </p> </li> </ul>",
"refs": {
"CacheSubnetGroups$member": null,
"CreateCacheSubnetGroupResult$CacheSubnetGroup": null,
"ModifyCacheSubnetGroupResult$CacheSubnetGroup": null
}
},
"CacheSubnetGroupAlreadyExistsFault": {
"base": "<p>The requested cache subnet group name is already in use by an existing cache subnet group.</p>",
"refs": {
}
},
"CacheSubnetGroupInUse": {
"base": "<p>The requested cache subnet group is currently in use.</p>",
"refs": {
}
},
"CacheSubnetGroupMessage": {
"base": "<p>Represents the output of a <code>DescribeCacheSubnetGroups</code> operation.</p>",
"refs": {
}
},
"CacheSubnetGroupNotFoundFault": {
"base": "<p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>",
"refs": {
}
},
"CacheSubnetGroupQuotaExceededFault": {
"base": "<p>The request cannot be processed because it would exceed the allowed number of cache subnet groups.</p>",
"refs": {
}
},
"CacheSubnetGroups": {
"base": null,
"refs": {
"CacheSubnetGroupMessage$CacheSubnetGroups": "<p>A list of cache subnet groups. Each element in the list contains detailed information about one group.</p>"
}
},
"CacheSubnetQuotaExceededFault": {
"base": "<p>The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.</p>",
"refs": {
}
},
"ChangeType": {
"base": null,
"refs": {
"CacheNodeTypeSpecificParameter$ChangeType": "<p>Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>",
"Parameter$ChangeType": "<p>Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>"
}
},
"CloudWatchLogsDestinationDetails": {
"base": "<p>The configuration details of the CloudWatch Logs destination.</p>",
"refs": {
"DestinationDetails$CloudWatchLogsDetails": "<p>The configuration details of the CloudWatch Logs destination.</p>"
}
},
"ClusterIdList": {
"base": null,
"refs": {
"ReplicationGroup$MemberClusters": "<p>The names of all the cache clusters that are part of this replication group.</p>"
}
},
"ClusterQuotaForCustomerExceededFault": {
"base": "<p>The request cannot be processed because it would exceed the allowed number of clusters per customer.</p>",
"refs": {
}
},
"CompleteMigrationMessage": {
"base": null,
"refs": {
}
},
"CompleteMigrationResponse": {
"base": null,
"refs": {
}
},
"ConfigureShard": {
"base": "<p>Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones. </p>",
"refs": {
"ReplicaConfigurationList$member": null
}
},
"CopySnapshotMessage": {
"base": "<p>Represents the input of a <code>CopySnapshotMessage</code> operation.</p>",
"refs": {
}
},
"CopySnapshotResult": {
"base": null,
"refs": {
}
},
"CreateCacheClusterMessage": {
"base": "<p>Represents the input of a CreateCacheCluster operation.</p>",
"refs": {
}
},
"CreateCacheClusterResult": {
"base": null,
"refs": {
}
},
"CreateCacheParameterGroupMessage": {
"base": "<p>Represents the input of a <code>CreateCacheParameterGroup</code> operation.</p>",
"refs": {
}
},
"CreateCacheParameterGroupResult": {
"base": null,
"refs": {
}
},
"CreateCacheSecurityGroupMessage": {
"base": "<p>Represents the input of a <code>CreateCacheSecurityGroup</code> operation.</p>",
"refs": {
}
},
"CreateCacheSecurityGroupResult": {
"base": null,
"refs": {
}
},
"CreateCacheSubnetGroupMessage": {
"base": "<p>Represents the input of a <code>CreateCacheSubnetGroup</code> operation.</p>",
"refs": {
}
},
"CreateCacheSubnetGroupResult": {
"base": null,
"refs": {
}
},
"CreateGlobalReplicationGroupMessage": {
"base": null,
"refs": {
}
},
"CreateGlobalReplicationGroupResult": {
"base": null,
"refs": {
}
},
"CreateReplicationGroupMessage": {
"base": "<p>Represents the input of a <code>CreateReplicationGroup</code> operation.</p>",
"refs": {
}
},
"CreateReplicationGroupResult": {
"base": null,
"refs": {
}
},
"CreateSnapshotMessage": {
"base": "<p>Represents the input of a <code>CreateSnapshot</code> operation.</p>",
"refs": {
}
},
"CreateSnapshotResult": {
"base": null,
"refs": {
}
},
"CreateUserGroupMessage": {
"base": null,
"refs": {
}
},
"CreateUserMessage": {
"base": null,
"refs": {
}
},
"CustomerNodeEndpoint": {
"base": "<p>The endpoint from which data should be migrated.</p>",
"refs": {
"CustomerNodeEndpointList$member": null
}
},
"CustomerNodeEndpointList": {
"base": null,
"refs": {
"StartMigrationMessage$CustomerNodeEndpointList": "<p>List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.</p>"
}
},
"DataTieringStatus": {
"base": null,
"refs": {
"ReplicationGroup$DataTiering": "<p>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html\">Data tiering</a>.</p>",
"Snapshot$DataTiering": "<p>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html\">Data tiering</a>.</p>"
}
},
"DecreaseNodeGroupsInGlobalReplicationGroupMessage": {
"base": null,
"refs": {
}
},
"DecreaseNodeGroupsInGlobalReplicationGroupResult": {
"base": null,
"refs": {
}
},
"DecreaseReplicaCountMessage": {
"base": null,
"refs": {
}
},
"DecreaseReplicaCountResult": {
"base": null,
"refs": {
}
},
"DefaultUserAssociatedToUserGroupFault": {
"base": "<p>The default user assigned to the user group.</p>",
"refs": {
}
},
"DefaultUserRequired": {
"base": "<p>You must add default user to a user group.</p>",
"refs": {
}
},
"DeleteCacheClusterMessage": {
"base": "<p>Represents the input of a <code>DeleteCacheCluster</code> operation.</p>",
"refs": {
}
},
"DeleteCacheClusterResult": {
"base": null,
"refs": {
}
},
"DeleteCacheParameterGroupMessage": {
"base": "<p>Represents the input of a <code>DeleteCacheParameterGroup</code> operation.</p>",
"refs": {
}
},
"DeleteCacheSecurityGroupMessage": {
"base": "<p>Represents the input of a <code>DeleteCacheSecurityGroup</code> operation.</p>",
"refs": {
}
},
"DeleteCacheSubnetGroupMessage": {
"base": "<p>Represents the input of a <code>DeleteCacheSubnetGroup</code> operation.</p>",
"refs": {
}
},
"DeleteGlobalReplicationGroupMessage": {
"base": null,
"refs": {
}
},
"DeleteGlobalReplicationGroupResult": {
"base": null,
"refs": {
}
},
"DeleteReplicationGroupMessage": {
"base": "<p>Represents the input of a <code>DeleteReplicationGroup</code> operation.</p>",
"refs": {
}
},
"DeleteReplicationGroupResult": {
"base": null,
"refs": {
}
},
"DeleteSnapshotMessage": {
"base": "<p>Represents the input of a <code>DeleteSnapshot</code> operation.</p>",
"refs": {
}
},
"DeleteSnapshotResult": {
"base": null,
"refs": {
}
},
"DeleteUserGroupMessage": {
"base": null,
"refs": {
}
},
"DeleteUserMessage": {
"base": null,
"refs": {
}
},
"DescribeCacheClustersMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheClusters</code> operation.</p>",
"refs": {
}
},
"DescribeCacheEngineVersionsMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheEngineVersions</code> operation.</p>",
"refs": {
}
},
"DescribeCacheParameterGroupsMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheParameterGroups</code> operation.</p>",
"refs": {
}
},
"DescribeCacheParametersMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheParameters</code> operation.</p>",
"refs": {
}
},
"DescribeCacheSecurityGroupsMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheSecurityGroups</code> operation.</p>",
"refs": {
}
},
"DescribeCacheSubnetGroupsMessage": {
"base": "<p>Represents the input of a <code>DescribeCacheSubnetGroups</code> operation.</p>",
"refs": {
}
},
"DescribeEngineDefaultParametersMessage": {
"base": "<p>Represents the input of a <code>DescribeEngineDefaultParameters</code> operation.</p>",
"refs": {
}
},
"DescribeEngineDefaultParametersResult": {
"base": null,
"refs": {
}
},
"DescribeEventsMessage": {
"base": "<p>Represents the input of a <code>DescribeEvents</code> operation.</p>",
"refs": {
}
},
"DescribeGlobalReplicationGroupsMessage": {
"base": null,
"refs": {
}
},
"DescribeGlobalReplicationGroupsResult": {
"base": null,
"refs": {
}
},
"DescribeReplicationGroupsMessage": {
"base": "<p>Represents the input of a <code>DescribeReplicationGroups</code> operation.</p>",
"refs": {
}
},
"DescribeReservedCacheNodesMessage": {
"base": "<p>Represents the input of a <code>DescribeReservedCacheNodes</code> operation.</p>",
"refs": {
}
},
"DescribeReservedCacheNodesOfferingsMessage": {
"base": "<p>Represents the input of a <code>DescribeReservedCacheNodesOfferings</code> operation.</p>",
"refs": {
}
},
"DescribeServiceUpdatesMessage": {
"base": null,
"refs": {
}
},
"DescribeSnapshotsListMessage": {
"base": "<p>Represents the output of a <code>DescribeSnapshots</code> operation.</p>",
"refs": {
}
},
"DescribeSnapshotsMessage": {
"base": "<p>Represents the input of a <code>DescribeSnapshotsMessage</code> operation.</p>",
"refs": {
}
},
"DescribeUpdateActionsMessage": {
"base": null,
"refs": {
}
},
"DescribeUserGroupsMessage": {
"base": null,
"refs": {
}
},
"DescribeUserGroupsResult": {
"base": null,
"refs": {
}
},
"DescribeUsersMessage": {
"base": null,
"refs": {
}
},
"DescribeUsersResult": {
"base": null,
"refs": {
}
},
"DestinationDetails": {
"base": "<p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>",
"refs": {
"LogDeliveryConfiguration$DestinationDetails": "<p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>",
"LogDeliveryConfigurationRequest$DestinationDetails": "<p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>",
"PendingLogDeliveryConfiguration$DestinationDetails": "<p>Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.</p>"
}
},
"DestinationType": {
"base": null,
"refs": {
"LogDeliveryConfiguration$DestinationType": "<p>Returns the destination type, either <code>cloudwatch-logs</code> or <code>kinesis-firehose</code>.</p>",
"LogDeliveryConfigurationRequest$DestinationType": "<p>Specify either <code>cloudwatch-logs</code> or <code>kinesis-firehose</code> as the destination type.</p>",
"PendingLogDeliveryConfiguration$DestinationType": "<p>Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.</p>"
}
},
"DisassociateGlobalReplicationGroupMessage": {
"base": null,
"refs": {
}
},
"DisassociateGlobalReplicationGroupResult": {
"base": null,
"refs": {
}
},
"Double": {
"base": null,
"refs": {
"RecurringCharge$RecurringChargeAmount": "<p>The monetary amount of the recurring charge.</p>",
"ReservedCacheNode$FixedPrice": "<p>The fixed price charged for this reserved cache node.</p>",
"ReservedCacheNode$UsagePrice": "<p>The hourly price charged for this reserved cache node.</p>",
"ReservedCacheNodesOffering$FixedPrice": "<p>The fixed price charged for this offering.</p>",
"ReservedCacheNodesOffering$UsagePrice": "<p>The hourly price charged for this offering.</p>",
"SlotMigration$ProgressPercentage": "<p>The percentage of the slot migration that is complete.</p>"
}
},
"DuplicateUserNameFault": {
"base": "<p>A user with this username already exists.</p>",
"refs": {
}
},
"EC2SecurityGroup": {
"base": "<p>Provides ownership and status information for an Amazon EC2 security group.</p>",
"refs": {
"EC2SecurityGroupList$member": null
}
},
"EC2SecurityGroupList": {
"base": null,
"refs": {
"CacheSecurityGroup$EC2SecurityGroups": "<p>A list of Amazon EC2 security groups that are associated with this cache security group.</p>"
}
},
"Endpoint": {
"base": "<p>Represents the information required for client programs to connect to a cache node.</p>",
"refs": {
"CacheCluster$ConfigurationEndpoint": "<p>Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have <code>.cfg</code> in it.</p> <p>Example: <code>mem-3.9dvc4r<u>.cfg</u>.usw2.cache.amazonaws.com:11211</code> </p>",
"CacheNode$Endpoint": "<p>The hostname for connecting to this cache node.</p>",
"NodeGroup$PrimaryEndpoint": "<p>The endpoint of the primary node in this node group (shard).</p>",
"NodeGroup$ReaderEndpoint": "<p>The endpoint of the replica nodes in this node group (shard).</p>",
"NodeGroupMember$ReadEndpoint": "<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>",
"ReplicationGroup$ConfigurationEndpoint": "<p>The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.</p>"
}
},
"EngineDefaults": {
"base": "<p>Represents the output of a <code>DescribeEngineDefaultParameters</code> operation.</p>",
"refs": {
"DescribeEngineDefaultParametersResult$EngineDefaults": null
}
},
"EngineType": {
"base": null,
"refs": {
"CreateUserGroupMessage$Engine": "<p>The current supported value is Redis. </p>",
"CreateUserMessage$Engine": "<p>The current supported value is Redis. </p>",
"DescribeUsersMessage$Engine": "<p>The Redis engine. </p>",
"User$Engine": "<p>The current supported value is Redis.</p>",
"UserGroup$Engine": "<p>The current supported value is Redis. </p>"
}
},
"Event": {
"base": "<p>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.</p>",
"refs": {
"EventList$member": null
}
},
"EventList": {
"base": null,
"refs": {
"EventsMessage$Events": "<p>A list of events. Each element in the list contains detailed information about one event.</p>"
}
},
"EventsMessage": {
"base": "<p>Represents the output of a <code>DescribeEvents</code> operation.</p>",
"refs": {
}
},
"FailoverGlobalReplicationGroupMessage": {
"base": null,
"refs": {
}
},
"FailoverGlobalReplicationGroupResult": {
"base": null,
"refs": {
}
},
"Filter": {
"base": "<p>Used to streamline results of a search based on the property being filtered.</p>",
"refs": {
"FilterList$member": null
}
},
"FilterList": {
"base": null,
"refs": {
"DescribeUsersMessage$Filters": "<p>Filter to determine the list of User IDs to return.</p>"
}
},
"FilterName": {
"base": null,
"refs": {