/
memorydb.jl
1624 lines (1483 loc) · 59.5 KB
/
memorydb.jl
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
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: memorydb
using AWS.Compat
using AWS.UUIDs
"""
batch_update_cluster(cluster_names)
batch_update_cluster(cluster_names, params::Dict{String,<:Any})
Apply the service update to a list of clusters supplied. For more information on service
updates and applying them, see Applying the service updates.
# Arguments
- `cluster_names`: The cluster names to apply the updates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ServiceUpdate"`: The unique ID of the service update
"""
function batch_update_cluster(
ClusterNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"BatchUpdateCluster",
Dict{String,Any}("ClusterNames" => ClusterNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_cluster(
ClusterNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"BatchUpdateCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterNames" => ClusterNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_snapshot(source_snapshot_name, target_snapshot_name)
copy_snapshot(source_snapshot_name, target_snapshot_name, params::Dict{String,<:Any})
Makes a copy of an existing snapshot.
# Arguments
- `source_snapshot_name`: The name of an existing snapshot from which to make a copy.
- `target_snapshot_name`: A name for the snapshot copy. MemoryDB does not permit
overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or
an Amazon S3 bucket if exporting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the target snapshot.
- `"Tags"`: 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.
- `"TargetBucket"`: The Amazon S3 bucket to which the snapshot is exported. This parameter
is used only when exporting a snapshot for external access. When using this parameter to
export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more
information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.
"""
function copy_snapshot(
SourceSnapshotName,
TargetSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CopySnapshot",
Dict{String,Any}(
"SourceSnapshotName" => SourceSnapshotName,
"TargetSnapshotName" => TargetSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_snapshot(
SourceSnapshotName,
TargetSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CopySnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceSnapshotName" => SourceSnapshotName,
"TargetSnapshotName" => TargetSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_acl(aclname)
create_acl(aclname, params::Dict{String,<:Any})
Creates an Access Control List. For more information, see Authenticating users with Access
Contol Lists (ACLs).
# Arguments
- `aclname`: The name of the Access Control List.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: 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.
- `"UserNames"`: The list of users that belong to the Access Control List.
"""
function create_acl(ACLName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"CreateACL",
Dict{String,Any}("ACLName" => ACLName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_acl(
ACLName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateACL",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ACLName" => ACLName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(aclname, cluster_name, node_type)
create_cluster(aclname, cluster_name, node_type, params::Dict{String,<:Any})
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
# Arguments
- `aclname`: The name of the Access Control List to associate with the cluster.
- `cluster_name`: The name of the cluster. This value must be unique as it also serves as
the cluster identifier.
- `node_type`: The compute and memory capacity of the nodes in the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoMinorVersionUpgrade"`: When set to true, the cluster will automatically receive
minor engine version upgrades after launch.
- `"DataTiering"`: Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes. For more information,
see Data tiering.
- `"Description"`: An optional description of the cluster.
- `"EngineVersion"`: The version number of the Redis engine to be used for the cluster.
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the cluster.
- `"MaintenanceWindow"`: Specifies the weekly time range during which maintenance on the
cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H
Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
- `"NumReplicasPerShard"`: The number of replicas to apply to each shard. The default value
is 1. The maximum is 5.
- `"NumShards"`: The number of shards the cluster will contain. The default value is 1.
- `"ParameterGroupName"`: The name of the parameter group associated with the cluster.
- `"Port"`: The port number on which each of the nodes accepts connections.
- `"SecurityGroupIds"`: A list of security group names to associate with this cluster.
- `"SnapshotArns"`: A list of Amazon Resource Names (ARN) that uniquely identify the RDB
snapshot files stored in Amazon S3. The snapshot files are used to populate the new
cluster. The Amazon S3 object name in the ARN cannot contain any commas.
- `"SnapshotName"`: The name of a snapshot from which to restore data into the new cluster.
The snapshot status changes to restoring while the new cluster is being created.
- `"SnapshotRetentionLimit"`: The number of days for which MemoryDB retains automatic
snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a
snapshot that was taken today is retained for 5 days before being deleted.
- `"SnapshotWindow"`: The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter,
MemoryDB automatically chooses an appropriate time range.
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) topic to which notifications are sent.
- `"SubnetGroupName"`: The name of the subnet group to be used for the cluster.
- `"TLSEnabled"`: A flag to enable in-transit encryption on the cluster.
- `"Tags"`: A list of tags to be added to this resource. Tags are comma-separated key,value
pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following:
Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
"""
function create_cluster(
ACLName, ClusterName, NodeType; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateCluster",
Dict{String,Any}(
"ACLName" => ACLName, "ClusterName" => ClusterName, "NodeType" => NodeType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ACLName,
ClusterName,
NodeType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ACLName" => ACLName,
"ClusterName" => ClusterName,
"NodeType" => NodeType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_parameter_group(family, parameter_group_name)
create_parameter_group(family, parameter_group_name, params::Dict{String,<:Any})
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and
their values that are applied to all of the nodes in any cluster. For more information, see
Configuring engine parameters using parameter groups.
# Arguments
- `family`: The name of the parameter group family that the parameter group can be used
with.
- `parameter_group_name`: The name of the parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description of the parameter group.
- `"Tags"`: 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.
"""
function create_parameter_group(
Family, ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateParameterGroup",
Dict{String,Any}("Family" => Family, "ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_parameter_group(
Family,
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Family" => Family, "ParameterGroupName" => ParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(cluster_name, snapshot_name)
create_snapshot(cluster_name, snapshot_name, params::Dict{String,<:Any})
Creates a copy of an entire cluster at a specific moment in time.
# Arguments
- `cluster_name`: The snapshot is created from this cluster.
- `snapshot_name`: A name for the snapshot being created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the snapshot.
- `"Tags"`: 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.
"""
function create_snapshot(
ClusterName, SnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateSnapshot",
Dict{String,Any}("ClusterName" => ClusterName, "SnapshotName" => SnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
ClusterName,
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName, "SnapshotName" => SnapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subnet_group(subnet_group_name, subnet_ids)
create_subnet_group(subnet_group_name, subnet_ids, params::Dict{String,<:Any})
Creates a subnet group. A subnet group is a collection of subnets (typically private) that
you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC)
environment. When you create a cluster in an Amazon VPC, you must specify a subnet group.
MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to
associate with your nodes. For more information, see Subnets and subnet groups.
# Arguments
- `subnet_group_name`: The name of the subnet group.
- `subnet_ids`: A list of VPC subnet IDs for the subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the subnet group.
- `"Tags"`: 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.
"""
function create_subnet_group(
SubnetGroupName, SubnetIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"CreateSubnetGroup",
Dict{String,Any}("SubnetGroupName" => SubnetGroupName, "SubnetIds" => SubnetIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subnet_group(
SubnetGroupName,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SubnetGroupName" => SubnetGroupName, "SubnetIds" => SubnetIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(access_string, authentication_mode, user_name)
create_user(access_string, authentication_mode, user_name, params::Dict{String,<:Any})
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol
Lists (ACLs).
# Arguments
- `access_string`: Access permissions string used for this user.
- `authentication_mode`: Denotes the user's authentication properties, such as whether it
requires a password to authenticate.
- `user_name`: The name of the user. This value must be unique as it also serves as the
user identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: 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.
"""
function create_user(
AccessString,
AuthenticationMode,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateUser",
Dict{String,Any}(
"AccessString" => AccessString,
"AuthenticationMode" => AuthenticationMode,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
AccessString,
AuthenticationMode,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessString" => AccessString,
"AuthenticationMode" => AuthenticationMode,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_acl(aclname)
delete_acl(aclname, params::Dict{String,<:Any})
Deletes an Access Control List. The ACL must first be disassociated from the cluster before
it can be deleted. For more information, see Authenticating users with Access Contol Lists
(ACLs).
# Arguments
- `aclname`: The name of the Access Control List to delete
"""
function delete_acl(ACLName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteACL",
Dict{String,Any}("ACLName" => ACLName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_acl(
ACLName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteACL",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ACLName" => ACLName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_name)
delete_cluster(cluster_name, params::Dict{String,<:Any})
Deletes a cluster. It also deletes all associated nodes and node endpoints
# Arguments
- `cluster_name`: The name of the cluster to be deleted
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalSnapshotName"`: The user-supplied name of a final cluster snapshot. This is the
unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes
the cluster immediately afterward.
"""
function delete_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteCluster",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_parameter_group(parameter_group_name)
delete_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Deletes the specified parameter group. You cannot delete a parameter group if it is
associated with any clusters. You cannot delete the default parameter groups in your
account.
# Arguments
- `parameter_group_name`: The name of the parameter group to delete.
"""
function delete_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_name)
delete_snapshot(snapshot_name, params::Dict{String,<:Any})
Deletes an existing snapshot. When you receive a successful response from this operation,
MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this
operation.
# Arguments
- `snapshot_name`: The name of the snapshot to delete
"""
function delete_snapshot(SnapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteSnapshot",
Dict{String,Any}("SnapshotName" => SnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot(
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotName" => SnapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subnet_group(subnet_group_name)
delete_subnet_group(subnet_group_name, params::Dict{String,<:Any})
Deletes a subnet group. You cannot delete a default subnet group or one that is associated
with any clusters.
# Arguments
- `subnet_group_name`: The name of the subnet group to delete
"""
function delete_subnet_group(
SubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DeleteSubnetGroup",
Dict{String,Any}("SubnetGroupName" => SubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subnet_group(
SubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubnetGroupName" => SubnetGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(user_name)
delete_user(user_name, params::Dict{String,<:Any})
Deletes a user. The user will be removed from all ACLs and in turn removed from all
clusters.
# Arguments
- `user_name`: The name of the user to delete
"""
function delete_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DeleteUser",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DeleteUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_acls()
describe_acls(params::Dict{String,<:Any})
Returns a list of ACLs
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ACLName"`: The name of the ACL
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
"""
function describe_acls(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb("DescribeACLs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_acls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeACLs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_clusters()
describe_clusters(params::Dict{String,<:Any})
Returns information about all provisioned clusters if no cluster identifier is specified,
or about a specific cluster if a cluster name is supplied.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterName"`: The name of the cluster
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
- `"ShowShardDetails"`: An optional flag that can be included in the request to retrieve
information about the individual shard(s).
"""
function describe_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_engine_versions()
describe_engine_versions(params::Dict{String,<:Any})
Returns a list of the available Redis engine versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultOnly"`: If true, specifies that only the default version of the specified engine
or engine and major version combination is to be returned.
- `"EngineVersion"`: The Redis engine version
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
- `"ParameterGroupFamily"`: The name of a specific parameter group family to return details
for.
"""
function describe_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeEngineVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_engine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to clusters, security groups, and parameter groups. You can obtain
events specific to a particular cluster, security group, or parameter group by providing
the name as a parameter. 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.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The number of minutes worth of events to retrieve.
- `"EndTime"`: The end of the time interval for which to retrieve events, specified in ISO
8601 format. Example: 2017-03-30T07:03:49.555Z
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
- `"SourceName"`: The identifier of the event source for which events are returned. If not
specified, all sources are included in the response.
- `"SourceType"`: The event source to retrieve events for. If no value is specified, all
events are returned.
- `"StartTime"`: The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_parameter_groups()
describe_parameter_groups(params::Dict{String,<:Any})
Returns a list of parameter group descriptions. If a parameter group name is specified, the
list contains only the descriptions for that group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
- `"ParameterGroupName"`: The name of a specific parameter group to return details for.
"""
function describe_parameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeParameterGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_parameters(parameter_group_name)
describe_parameters(parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular parameter group.
# Arguments
- `parameter_group_name`: he name of a specific parameter group to return details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
"""
function describe_parameters(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeParameters",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_parameters(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return memorydb(
"DescribeParameters",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_nodes()
describe_reserved_nodes(params::Dict{String,<:Any})
Returns information about reserved nodes for this account, or about a specified reserved
node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The duration filter value, specified in years or seconds. Use this
parameter to show only reservations for this duration.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a marker is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"NodeType"`: The node type filter value. Use this parameter to show only those
reservations matching the specified node type. For more information, see Supported node
types.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values: \"All
Upfront\"|\"Partial Upfront\"| \"No Upfront\"
- `"ReservationId"`: The reserved node identifier filter value. Use this parameter to show
only the reservation that matches the specified reservation ID.
- `"ReservedNodesOfferingId"`: The offering identifier filter value. Use this parameter to
show only purchased reservations matching the specified offering identifier.
"""
function describe_reserved_nodes(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeReservedNodes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_reserved_nodes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_nodes_offerings()
describe_reserved_nodes_offerings(params::Dict{String,<:Any})
Lists available reserved node offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: Duration filter value, specified in years or seconds. Use this parameter to
show only reservations for a given duration.
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a marker is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"NodeType"`: The node type for the reserved nodes. For more information, see Supported
node types.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values: \"All
Upfront\"|\"Partial Upfront\"| \"No Upfront\"
- `"ReservedNodesOfferingId"`: The offering identifier filter value. Use this parameter to
show only the available offering that matches the specified reservation identifier.
"""
function describe_reserved_nodes_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodesOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_nodes_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeReservedNodesOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_updates()
describe_service_updates(params::Dict{String,<:Any})
Returns details of the service updates
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterNames"`: The list of cluster names to identify service updates to apply
- `"MaxResults"`: The maximum number of records to include in the response. If more records
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved.
- `"NextToken"`: An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more results available. The
value of nextToken is a unique pagination token for each page. Make the call again using
the returned token to retrieve the next page. Keep all other arguments unchanged.
- `"ServiceUpdateName"`: The unique ID of the service update to describe.
- `"Status"`: The status(es) of the service updates to filter on
"""
function describe_service_updates(; aws_config::AbstractAWSConfig=global_aws_config())
return memorydb(
"DescribeServiceUpdates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_service_updates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return memorydb(
"DescribeServiceUpdates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})