aws-sdk-memorydb 1.38.0 → 1.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-memorydb/client.rb +347 -39
- data/lib/aws-sdk-memorydb/client_api.rb +181 -0
- data/lib/aws-sdk-memorydb/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-memorydb/endpoints.rb +2 -416
- data/lib/aws-sdk-memorydb/errors.rb +44 -0
- data/lib/aws-sdk-memorydb/plugins/endpoints.rb +1 -82
- data/lib/aws-sdk-memorydb/types.rb +410 -51
- data/lib/aws-sdk-memorydb.rb +1 -1
- data/sig/client.rbs +78 -0
- data/sig/errors.rbs +8 -0
- data/sig/types.rbs +109 -0
- metadata +4 -4
@@ -493,6 +493,7 @@ module Aws::MemoryDB
|
|
493
493
|
# resp.processed_clusters[0].pending_updates.service_updates #=> Array
|
494
494
|
# resp.processed_clusters[0].pending_updates.service_updates[0].service_update_name #=> String
|
495
495
|
# resp.processed_clusters[0].pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
496
|
+
# resp.processed_clusters[0].multi_region_cluster_name #=> String
|
496
497
|
# resp.processed_clusters[0].number_of_shards #=> Integer
|
497
498
|
# resp.processed_clusters[0].shards #=> Array
|
498
499
|
# resp.processed_clusters[0].shards[0].name #=> String
|
@@ -619,6 +620,8 @@ module Aws::MemoryDB
|
|
619
620
|
# resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
|
620
621
|
# resp.snapshot.cluster_configuration.shards[0].size #=> String
|
621
622
|
# resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
|
623
|
+
# resp.snapshot.cluster_configuration.multi_region_parameter_group_name #=> String
|
624
|
+
# resp.snapshot.cluster_configuration.multi_region_cluster_name #=> String
|
622
625
|
# resp.snapshot.data_tiering #=> String, one of "true", "false"
|
623
626
|
#
|
624
627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CopySnapshot AWS API Documentation
|
@@ -699,6 +702,9 @@ module Aws::MemoryDB
|
|
699
702
|
# @option params [required, String] :node_type
|
700
703
|
# The compute and memory capacity of the nodes in the cluster.
|
701
704
|
#
|
705
|
+
# @option params [String] :multi_region_cluster_name
|
706
|
+
# The name of the multi-Region cluster to be created.
|
707
|
+
#
|
702
708
|
# @option params [String] :parameter_group_name
|
703
709
|
# The name of the parameter group associated with the cluster.
|
704
710
|
#
|
@@ -791,11 +797,10 @@ module Aws::MemoryDB
|
|
791
797
|
# The name of the Access Control List to associate with the cluster.
|
792
798
|
#
|
793
799
|
# @option params [String] :engine
|
794
|
-
# The name of the engine to be used for the
|
795
|
-
# value must be set to either Redis or Valkey.
|
800
|
+
# The name of the engine to be used for the cluster.
|
796
801
|
#
|
797
802
|
# @option params [String] :engine_version
|
798
|
-
# The version number of the engine to be used for the cluster.
|
803
|
+
# The version number of the Redis OSS engine to be used for the cluster.
|
799
804
|
#
|
800
805
|
# @option params [Boolean] :auto_minor_version_upgrade
|
801
806
|
# When set to true, the cluster will automatically receive minor engine
|
@@ -819,6 +824,7 @@ module Aws::MemoryDB
|
|
819
824
|
# resp = client.create_cluster({
|
820
825
|
# cluster_name: "String", # required
|
821
826
|
# node_type: "String", # required
|
827
|
+
# multi_region_cluster_name: "String",
|
822
828
|
# parameter_group_name: "String",
|
823
829
|
# description: "String",
|
824
830
|
# num_shards: 1,
|
@@ -857,6 +863,7 @@ module Aws::MemoryDB
|
|
857
863
|
# resp.cluster.pending_updates.service_updates #=> Array
|
858
864
|
# resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
|
859
865
|
# resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
866
|
+
# resp.cluster.multi_region_cluster_name #=> String
|
860
867
|
# resp.cluster.number_of_shards #=> Integer
|
861
868
|
# resp.cluster.shards #=> Array
|
862
869
|
# resp.cluster.shards[0].name #=> String
|
@@ -904,6 +911,86 @@ module Aws::MemoryDB
|
|
904
911
|
req.send_request(options)
|
905
912
|
end
|
906
913
|
|
914
|
+
# Creates a new multi-Region cluster.
|
915
|
+
#
|
916
|
+
# @option params [required, String] :multi_region_cluster_name_suffix
|
917
|
+
# A suffix to be added to the multi-Region cluster name.
|
918
|
+
#
|
919
|
+
# @option params [String] :description
|
920
|
+
# A description for the multi-Region cluster.
|
921
|
+
#
|
922
|
+
# @option params [String] :engine
|
923
|
+
# The name of the engine to be used for the multi-Region cluster.
|
924
|
+
#
|
925
|
+
# @option params [String] :engine_version
|
926
|
+
# The version of the engine to be used for the multi-Region cluster.
|
927
|
+
#
|
928
|
+
# @option params [required, String] :node_type
|
929
|
+
# The node type to be used for the multi-Region cluster.
|
930
|
+
#
|
931
|
+
# @option params [String] :multi_region_parameter_group_name
|
932
|
+
# The name of the multi-Region parameter group to be associated with the
|
933
|
+
# cluster.
|
934
|
+
#
|
935
|
+
# @option params [Integer] :num_shards
|
936
|
+
# The number of shards for the multi-Region cluster.
|
937
|
+
#
|
938
|
+
# @option params [Boolean] :tls_enabled
|
939
|
+
# Whether to enable TLS encryption for the multi-Region cluster.
|
940
|
+
#
|
941
|
+
# @option params [Array<Types::Tag>] :tags
|
942
|
+
# A list of tags to be applied to the multi-Region cluster.
|
943
|
+
#
|
944
|
+
# @return [Types::CreateMultiRegionClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
945
|
+
#
|
946
|
+
# * {Types::CreateMultiRegionClusterResponse#multi_region_cluster #multi_region_cluster} => Types::MultiRegionCluster
|
947
|
+
#
|
948
|
+
# @example Request syntax with placeholder values
|
949
|
+
#
|
950
|
+
# resp = client.create_multi_region_cluster({
|
951
|
+
# multi_region_cluster_name_suffix: "String", # required
|
952
|
+
# description: "String",
|
953
|
+
# engine: "String",
|
954
|
+
# engine_version: "String",
|
955
|
+
# node_type: "String", # required
|
956
|
+
# multi_region_parameter_group_name: "String",
|
957
|
+
# num_shards: 1,
|
958
|
+
# tls_enabled: false,
|
959
|
+
# tags: [
|
960
|
+
# {
|
961
|
+
# key: "String",
|
962
|
+
# value: "String",
|
963
|
+
# },
|
964
|
+
# ],
|
965
|
+
# })
|
966
|
+
#
|
967
|
+
# @example Response structure
|
968
|
+
#
|
969
|
+
# resp.multi_region_cluster.multi_region_cluster_name #=> String
|
970
|
+
# resp.multi_region_cluster.description #=> String
|
971
|
+
# resp.multi_region_cluster.status #=> String
|
972
|
+
# resp.multi_region_cluster.node_type #=> String
|
973
|
+
# resp.multi_region_cluster.engine #=> String
|
974
|
+
# resp.multi_region_cluster.engine_version #=> String
|
975
|
+
# resp.multi_region_cluster.number_of_shards #=> Integer
|
976
|
+
# resp.multi_region_cluster.clusters #=> Array
|
977
|
+
# resp.multi_region_cluster.clusters[0].cluster_name #=> String
|
978
|
+
# resp.multi_region_cluster.clusters[0].region #=> String
|
979
|
+
# resp.multi_region_cluster.clusters[0].status #=> String
|
980
|
+
# resp.multi_region_cluster.clusters[0].arn #=> String
|
981
|
+
# resp.multi_region_cluster.multi_region_parameter_group_name #=> String
|
982
|
+
# resp.multi_region_cluster.tls_enabled #=> Boolean
|
983
|
+
# resp.multi_region_cluster.arn #=> String
|
984
|
+
#
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateMultiRegionCluster AWS API Documentation
|
986
|
+
#
|
987
|
+
# @overload create_multi_region_cluster(params = {})
|
988
|
+
# @param [Hash] params ({})
|
989
|
+
def create_multi_region_cluster(params = {}, options = {})
|
990
|
+
req = build_request(:create_multi_region_cluster, params)
|
991
|
+
req.send_request(options)
|
992
|
+
end
|
993
|
+
|
907
994
|
# Creates a new MemoryDB parameter group. A parameter group is a
|
908
995
|
# collection of parameters and their values that are applied to all of
|
909
996
|
# the nodes in any cluster. For more information, see [Configuring
|
@@ -1023,6 +1110,8 @@ module Aws::MemoryDB
|
|
1023
1110
|
# resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
|
1024
1111
|
# resp.snapshot.cluster_configuration.shards[0].size #=> String
|
1025
1112
|
# resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
|
1113
|
+
# resp.snapshot.cluster_configuration.multi_region_parameter_group_name #=> String
|
1114
|
+
# resp.snapshot.cluster_configuration.multi_region_cluster_name #=> String
|
1026
1115
|
# resp.snapshot.data_tiering #=> String, one of "true", "false"
|
1027
1116
|
#
|
1028
1117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateSnapshot AWS API Documentation
|
@@ -1171,7 +1260,7 @@ module Aws::MemoryDB
|
|
1171
1260
|
# [1]: https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html
|
1172
1261
|
#
|
1173
1262
|
# @option params [required, String] :acl_name
|
1174
|
-
# The name of the Access Control List to delete
|
1263
|
+
# The name of the Access Control List to delete.
|
1175
1264
|
#
|
1176
1265
|
# @return [Types::DeleteACLResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1177
1266
|
#
|
@@ -1208,11 +1297,20 @@ module Aws::MemoryDB
|
|
1208
1297
|
end
|
1209
1298
|
|
1210
1299
|
# Deletes a cluster. It also deletes all associated nodes and node
|
1211
|
-
# endpoints
|
1300
|
+
# endpoints.
|
1301
|
+
#
|
1302
|
+
# <note markdown="1"> `CreateSnapshot` permission is required to create a final snapshot.
|
1303
|
+
# Without this permission, the API call will fail with an `Access
|
1304
|
+
# Denied` exception.
|
1305
|
+
#
|
1306
|
+
# </note>
|
1212
1307
|
#
|
1213
1308
|
# @option params [required, String] :cluster_name
|
1214
1309
|
# The name of the cluster to be deleted
|
1215
1310
|
#
|
1311
|
+
# @option params [String] :multi_region_cluster_name
|
1312
|
+
# The name of the multi-Region cluster to be deleted.
|
1313
|
+
#
|
1216
1314
|
# @option params [String] :final_snapshot_name
|
1217
1315
|
# The user-supplied name of a final cluster snapshot. This is the unique
|
1218
1316
|
# name that identifies the snapshot. MemoryDB creates the snapshot, and
|
@@ -1226,6 +1324,7 @@ module Aws::MemoryDB
|
|
1226
1324
|
#
|
1227
1325
|
# resp = client.delete_cluster({
|
1228
1326
|
# cluster_name: "String", # required
|
1327
|
+
# multi_region_cluster_name: "String",
|
1229
1328
|
# final_snapshot_name: "String",
|
1230
1329
|
# })
|
1231
1330
|
#
|
@@ -1239,6 +1338,7 @@ module Aws::MemoryDB
|
|
1239
1338
|
# resp.cluster.pending_updates.service_updates #=> Array
|
1240
1339
|
# resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
|
1241
1340
|
# resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
1341
|
+
# resp.cluster.multi_region_cluster_name #=> String
|
1242
1342
|
# resp.cluster.number_of_shards #=> Integer
|
1243
1343
|
# resp.cluster.shards #=> Array
|
1244
1344
|
# resp.cluster.shards[0].name #=> String
|
@@ -1286,6 +1386,48 @@ module Aws::MemoryDB
|
|
1286
1386
|
req.send_request(options)
|
1287
1387
|
end
|
1288
1388
|
|
1389
|
+
# Deletes an existing multi-Region cluster.
|
1390
|
+
#
|
1391
|
+
# @option params [required, String] :multi_region_cluster_name
|
1392
|
+
# The name of the multi-Region cluster to be deleted.
|
1393
|
+
#
|
1394
|
+
# @return [Types::DeleteMultiRegionClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1395
|
+
#
|
1396
|
+
# * {Types::DeleteMultiRegionClusterResponse#multi_region_cluster #multi_region_cluster} => Types::MultiRegionCluster
|
1397
|
+
#
|
1398
|
+
# @example Request syntax with placeholder values
|
1399
|
+
#
|
1400
|
+
# resp = client.delete_multi_region_cluster({
|
1401
|
+
# multi_region_cluster_name: "String", # required
|
1402
|
+
# })
|
1403
|
+
#
|
1404
|
+
# @example Response structure
|
1405
|
+
#
|
1406
|
+
# resp.multi_region_cluster.multi_region_cluster_name #=> String
|
1407
|
+
# resp.multi_region_cluster.description #=> String
|
1408
|
+
# resp.multi_region_cluster.status #=> String
|
1409
|
+
# resp.multi_region_cluster.node_type #=> String
|
1410
|
+
# resp.multi_region_cluster.engine #=> String
|
1411
|
+
# resp.multi_region_cluster.engine_version #=> String
|
1412
|
+
# resp.multi_region_cluster.number_of_shards #=> Integer
|
1413
|
+
# resp.multi_region_cluster.clusters #=> Array
|
1414
|
+
# resp.multi_region_cluster.clusters[0].cluster_name #=> String
|
1415
|
+
# resp.multi_region_cluster.clusters[0].region #=> String
|
1416
|
+
# resp.multi_region_cluster.clusters[0].status #=> String
|
1417
|
+
# resp.multi_region_cluster.clusters[0].arn #=> String
|
1418
|
+
# resp.multi_region_cluster.multi_region_parameter_group_name #=> String
|
1419
|
+
# resp.multi_region_cluster.tls_enabled #=> Boolean
|
1420
|
+
# resp.multi_region_cluster.arn #=> String
|
1421
|
+
#
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteMultiRegionCluster AWS API Documentation
|
1423
|
+
#
|
1424
|
+
# @overload delete_multi_region_cluster(params = {})
|
1425
|
+
# @param [Hash] params ({})
|
1426
|
+
def delete_multi_region_cluster(params = {}, options = {})
|
1427
|
+
req = build_request(:delete_multi_region_cluster, params)
|
1428
|
+
req.send_request(options)
|
1429
|
+
end
|
1430
|
+
|
1289
1431
|
# Deletes the specified parameter group. You cannot delete a parameter
|
1290
1432
|
# group if it is associated with any clusters. You cannot delete the
|
1291
1433
|
# default parameter groups in your account.
|
@@ -1324,7 +1466,7 @@ module Aws::MemoryDB
|
|
1324
1466
|
# snapshot; you cannot cancel or revert this operation.
|
1325
1467
|
#
|
1326
1468
|
# @option params [required, String] :snapshot_name
|
1327
|
-
# The name of the snapshot to delete
|
1469
|
+
# The name of the snapshot to delete.
|
1328
1470
|
#
|
1329
1471
|
# @return [Types::DeleteSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1330
1472
|
#
|
@@ -1363,6 +1505,8 @@ module Aws::MemoryDB
|
|
1363
1505
|
# resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
|
1364
1506
|
# resp.snapshot.cluster_configuration.shards[0].size #=> String
|
1365
1507
|
# resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
|
1508
|
+
# resp.snapshot.cluster_configuration.multi_region_parameter_group_name #=> String
|
1509
|
+
# resp.snapshot.cluster_configuration.multi_region_cluster_name #=> String
|
1366
1510
|
# resp.snapshot.data_tiering #=> String, one of "true", "false"
|
1367
1511
|
#
|
1368
1512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSnapshot AWS API Documentation
|
@@ -1378,7 +1522,7 @@ module Aws::MemoryDB
|
|
1378
1522
|
# one that is associated with any clusters.
|
1379
1523
|
#
|
1380
1524
|
# @option params [required, String] :subnet_group_name
|
1381
|
-
# The name of the subnet group to delete
|
1525
|
+
# The name of the subnet group to delete.
|
1382
1526
|
#
|
1383
1527
|
# @return [Types::DeleteSubnetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1384
1528
|
#
|
@@ -1446,10 +1590,10 @@ module Aws::MemoryDB
|
|
1446
1590
|
req.send_request(options)
|
1447
1591
|
end
|
1448
1592
|
|
1449
|
-
# Returns a list of ACLs
|
1593
|
+
# Returns a list of ACLs.
|
1450
1594
|
#
|
1451
1595
|
# @option params [String] :acl_name
|
1452
|
-
# The name of the ACL
|
1596
|
+
# The name of the ACL.
|
1453
1597
|
#
|
1454
1598
|
# @option params [Integer] :max_results
|
1455
1599
|
# The maximum number of records to include in the response. If more
|
@@ -1509,7 +1653,7 @@ module Aws::MemoryDB
|
|
1509
1653
|
# is supplied.
|
1510
1654
|
#
|
1511
1655
|
# @option params [String] :cluster_name
|
1512
|
-
# The name of the cluster
|
1656
|
+
# The name of the cluster.
|
1513
1657
|
#
|
1514
1658
|
# @option params [Integer] :max_results
|
1515
1659
|
# The maximum number of records to include in the response. If more
|
@@ -1555,6 +1699,7 @@ module Aws::MemoryDB
|
|
1555
1699
|
# resp.clusters[0].pending_updates.service_updates #=> Array
|
1556
1700
|
# resp.clusters[0].pending_updates.service_updates[0].service_update_name #=> String
|
1557
1701
|
# resp.clusters[0].pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
1702
|
+
# resp.clusters[0].multi_region_cluster_name #=> String
|
1558
1703
|
# resp.clusters[0].number_of_shards #=> Integer
|
1559
1704
|
# resp.clusters[0].shards #=> Array
|
1560
1705
|
# resp.clusters[0].shards[0].name #=> String
|
@@ -1602,13 +1747,13 @@ module Aws::MemoryDB
|
|
1602
1747
|
req.send_request(options)
|
1603
1748
|
end
|
1604
1749
|
|
1605
|
-
# Returns a list of the available engine versions.
|
1750
|
+
# Returns a list of the available Redis OSS engine versions.
|
1606
1751
|
#
|
1607
1752
|
# @option params [String] :engine
|
1608
|
-
# The
|
1753
|
+
# The name of the engine for which to list available versions.
|
1609
1754
|
#
|
1610
1755
|
# @option params [String] :engine_version
|
1611
|
-
# The engine version
|
1756
|
+
# The Redis OSS engine version
|
1612
1757
|
#
|
1613
1758
|
# @option params [String] :parameter_group_family
|
1614
1759
|
# The name of a specific parameter group family to return details for.
|
@@ -1740,6 +1885,65 @@ module Aws::MemoryDB
|
|
1740
1885
|
req.send_request(options)
|
1741
1886
|
end
|
1742
1887
|
|
1888
|
+
# Returns details about one or more multi-Region clusters.
|
1889
|
+
#
|
1890
|
+
# @option params [String] :multi_region_cluster_name
|
1891
|
+
# The name of a specific multi-Region cluster to describe.
|
1892
|
+
#
|
1893
|
+
# @option params [Integer] :max_results
|
1894
|
+
# The maximum number of results to return.
|
1895
|
+
#
|
1896
|
+
# @option params [String] :next_token
|
1897
|
+
# A token to specify where to start paginating.
|
1898
|
+
#
|
1899
|
+
# @option params [Boolean] :show_cluster_details
|
1900
|
+
# Details about the multi-Region cluster.
|
1901
|
+
#
|
1902
|
+
# @return [Types::DescribeMultiRegionClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1903
|
+
#
|
1904
|
+
# * {Types::DescribeMultiRegionClustersResponse#next_token #next_token} => String
|
1905
|
+
# * {Types::DescribeMultiRegionClustersResponse#multi_region_clusters #multi_region_clusters} => Array<Types::MultiRegionCluster>
|
1906
|
+
#
|
1907
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1908
|
+
#
|
1909
|
+
# @example Request syntax with placeholder values
|
1910
|
+
#
|
1911
|
+
# resp = client.describe_multi_region_clusters({
|
1912
|
+
# multi_region_cluster_name: "String",
|
1913
|
+
# max_results: 1,
|
1914
|
+
# next_token: "String",
|
1915
|
+
# show_cluster_details: false,
|
1916
|
+
# })
|
1917
|
+
#
|
1918
|
+
# @example Response structure
|
1919
|
+
#
|
1920
|
+
# resp.next_token #=> String
|
1921
|
+
# resp.multi_region_clusters #=> Array
|
1922
|
+
# resp.multi_region_clusters[0].multi_region_cluster_name #=> String
|
1923
|
+
# resp.multi_region_clusters[0].description #=> String
|
1924
|
+
# resp.multi_region_clusters[0].status #=> String
|
1925
|
+
# resp.multi_region_clusters[0].node_type #=> String
|
1926
|
+
# resp.multi_region_clusters[0].engine #=> String
|
1927
|
+
# resp.multi_region_clusters[0].engine_version #=> String
|
1928
|
+
# resp.multi_region_clusters[0].number_of_shards #=> Integer
|
1929
|
+
# resp.multi_region_clusters[0].clusters #=> Array
|
1930
|
+
# resp.multi_region_clusters[0].clusters[0].cluster_name #=> String
|
1931
|
+
# resp.multi_region_clusters[0].clusters[0].region #=> String
|
1932
|
+
# resp.multi_region_clusters[0].clusters[0].status #=> String
|
1933
|
+
# resp.multi_region_clusters[0].clusters[0].arn #=> String
|
1934
|
+
# resp.multi_region_clusters[0].multi_region_parameter_group_name #=> String
|
1935
|
+
# resp.multi_region_clusters[0].tls_enabled #=> Boolean
|
1936
|
+
# resp.multi_region_clusters[0].arn #=> String
|
1937
|
+
#
|
1938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeMultiRegionClusters AWS API Documentation
|
1939
|
+
#
|
1940
|
+
# @overload describe_multi_region_clusters(params = {})
|
1941
|
+
# @param [Hash] params ({})
|
1942
|
+
def describe_multi_region_clusters(params = {}, options = {})
|
1943
|
+
req = build_request(:describe_multi_region_clusters, params)
|
1944
|
+
req.send_request(options)
|
1945
|
+
end
|
1946
|
+
|
1743
1947
|
# Returns a list of parameter group descriptions. If a parameter group
|
1744
1948
|
# name is specified, the list contains only the descriptions for that
|
1745
1949
|
# group.
|
@@ -2007,16 +2211,16 @@ module Aws::MemoryDB
|
|
2007
2211
|
req.send_request(options)
|
2008
2212
|
end
|
2009
2213
|
|
2010
|
-
# Returns details of the service updates
|
2214
|
+
# Returns details of the service updates.
|
2011
2215
|
#
|
2012
2216
|
# @option params [String] :service_update_name
|
2013
2217
|
# The unique ID of the service update to describe.
|
2014
2218
|
#
|
2015
2219
|
# @option params [Array<String>] :cluster_names
|
2016
|
-
# The list of cluster names to identify service updates to apply
|
2220
|
+
# The list of cluster names to identify service updates to apply.
|
2017
2221
|
#
|
2018
2222
|
# @option params [Array<String>] :status
|
2019
|
-
# The status(es) of the service updates to filter on
|
2223
|
+
# The status(es) of the service updates to filter on.
|
2020
2224
|
#
|
2021
2225
|
# @option params [Integer] :max_results
|
2022
2226
|
# The maximum number of records to include in the response. If more
|
@@ -2152,6 +2356,8 @@ module Aws::MemoryDB
|
|
2152
2356
|
# resp.snapshots[0].cluster_configuration.shards[0].configuration.replica_count #=> Integer
|
2153
2357
|
# resp.snapshots[0].cluster_configuration.shards[0].size #=> String
|
2154
2358
|
# resp.snapshots[0].cluster_configuration.shards[0].snapshot_creation_time #=> Time
|
2359
|
+
# resp.snapshots[0].cluster_configuration.multi_region_parameter_group_name #=> String
|
2360
|
+
# resp.snapshots[0].cluster_configuration.multi_region_cluster_name #=> String
|
2155
2361
|
# resp.snapshots[0].data_tiering #=> String, one of "true", "false"
|
2156
2362
|
#
|
2157
2363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeSnapshots AWS API Documentation
|
@@ -2220,7 +2426,7 @@ module Aws::MemoryDB
|
|
2220
2426
|
# Returns a list of users.
|
2221
2427
|
#
|
2222
2428
|
# @option params [String] :user_name
|
2223
|
-
# The name of the user
|
2429
|
+
# The name of the user.
|
2224
2430
|
#
|
2225
2431
|
# @option params [Array<Types::Filter>] :filters
|
2226
2432
|
# Filter to determine the list of users to return.
|
@@ -2289,10 +2495,10 @@ module Aws::MemoryDB
|
|
2289
2495
|
# events, Amazon may block this API.
|
2290
2496
|
#
|
2291
2497
|
# @option params [required, String] :cluster_name
|
2292
|
-
# The cluster being failed over
|
2498
|
+
# The cluster being failed over.
|
2293
2499
|
#
|
2294
2500
|
# @option params [required, String] :shard_name
|
2295
|
-
# The name of the shard
|
2501
|
+
# The name of the shard.
|
2296
2502
|
#
|
2297
2503
|
# @return [Types::FailoverShardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2298
2504
|
#
|
@@ -2315,6 +2521,7 @@ module Aws::MemoryDB
|
|
2315
2521
|
# resp.cluster.pending_updates.service_updates #=> Array
|
2316
2522
|
# resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
|
2317
2523
|
# resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
2524
|
+
# resp.cluster.multi_region_cluster_name #=> String
|
2318
2525
|
# resp.cluster.number_of_shards #=> Integer
|
2319
2526
|
# resp.cluster.shards #=> Array
|
2320
2527
|
# resp.cluster.shards[0].name #=> String
|
@@ -2362,6 +2569,38 @@ module Aws::MemoryDB
|
|
2362
2569
|
req.send_request(options)
|
2363
2570
|
end
|
2364
2571
|
|
2572
|
+
# Lists the allowed updates for a multi-Region cluster.
|
2573
|
+
#
|
2574
|
+
# @option params [required, String] :multi_region_cluster_name
|
2575
|
+
# The name of the multi-Region cluster.
|
2576
|
+
#
|
2577
|
+
# @return [Types::ListAllowedMultiRegionClusterUpdatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2578
|
+
#
|
2579
|
+
# * {Types::ListAllowedMultiRegionClusterUpdatesResponse#scale_up_node_types #scale_up_node_types} => Array<String>
|
2580
|
+
# * {Types::ListAllowedMultiRegionClusterUpdatesResponse#scale_down_node_types #scale_down_node_types} => Array<String>
|
2581
|
+
#
|
2582
|
+
# @example Request syntax with placeholder values
|
2583
|
+
#
|
2584
|
+
# resp = client.list_allowed_multi_region_cluster_updates({
|
2585
|
+
# multi_region_cluster_name: "String", # required
|
2586
|
+
# })
|
2587
|
+
#
|
2588
|
+
# @example Response structure
|
2589
|
+
#
|
2590
|
+
# resp.scale_up_node_types #=> Array
|
2591
|
+
# resp.scale_up_node_types[0] #=> String
|
2592
|
+
# resp.scale_down_node_types #=> Array
|
2593
|
+
# resp.scale_down_node_types[0] #=> String
|
2594
|
+
#
|
2595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates AWS API Documentation
|
2596
|
+
#
|
2597
|
+
# @overload list_allowed_multi_region_cluster_updates(params = {})
|
2598
|
+
# @param [Hash] params ({})
|
2599
|
+
def list_allowed_multi_region_cluster_updates(params = {}, options = {})
|
2600
|
+
req = build_request(:list_allowed_multi_region_cluster_updates, params)
|
2601
|
+
req.send_request(options)
|
2602
|
+
end
|
2603
|
+
|
2365
2604
|
# Lists all available node types that you can scale to from your
|
2366
2605
|
# cluster's current node type. When you use the UpdateCluster operation
|
2367
2606
|
# to scale your cluster, the value of the NodeType parameter must be one
|
@@ -2402,7 +2641,7 @@ module Aws::MemoryDB
|
|
2402
2641
|
# Lists all tags currently on a named resource. A tag is a key-value
|
2403
2642
|
# pair where the key and value are case-sensitive. You can use tags to
|
2404
2643
|
# categorize and track your MemoryDB resources. For more information,
|
2405
|
-
# see [Tagging your MemoryDB resources][1]
|
2644
|
+
# see [Tagging your MemoryDB resources][1].
|
2406
2645
|
#
|
2407
2646
|
#
|
2408
2647
|
#
|
@@ -2410,7 +2649,7 @@ module Aws::MemoryDB
|
|
2410
2649
|
#
|
2411
2650
|
# @option params [required, String] :resource_arn
|
2412
2651
|
# The Amazon Resource Name (ARN) of the resource for which you want the
|
2413
|
-
# list of tags
|
2652
|
+
# list of tags.
|
2414
2653
|
#
|
2415
2654
|
# @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2416
2655
|
#
|
@@ -2564,7 +2803,7 @@ module Aws::MemoryDB
|
|
2564
2803
|
#
|
2565
2804
|
# @option params [required, String] :resource_arn
|
2566
2805
|
# The Amazon Resource Name (ARN) of the resource to which the tags are
|
2567
|
-
# to be added
|
2806
|
+
# to be added.
|
2568
2807
|
#
|
2569
2808
|
# @option params [required, Array<Types::Tag>] :tags
|
2570
2809
|
# A list of tags to be added to this resource. A tag is a key-value
|
@@ -2602,14 +2841,14 @@ module Aws::MemoryDB
|
|
2602
2841
|
req.send_request(options)
|
2603
2842
|
end
|
2604
2843
|
|
2605
|
-
# Use this operation to remove tags on a resource
|
2844
|
+
# Use this operation to remove tags on a resource.
|
2606
2845
|
#
|
2607
2846
|
# @option params [required, String] :resource_arn
|
2608
2847
|
# The Amazon Resource Name (ARN) of the resource to which the tags are
|
2609
|
-
# to be removed
|
2848
|
+
# to be removed.
|
2610
2849
|
#
|
2611
2850
|
# @option params [required, Array<String>] :tag_keys
|
2612
|
-
# The list of keys of the tags that are to be removed
|
2851
|
+
# The list of keys of the tags that are to be removed.
|
2613
2852
|
#
|
2614
2853
|
# @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2615
2854
|
#
|
@@ -2640,13 +2879,13 @@ module Aws::MemoryDB
|
|
2640
2879
|
# Changes the list of users that belong to the Access Control List.
|
2641
2880
|
#
|
2642
2881
|
# @option params [required, String] :acl_name
|
2643
|
-
# The name of the Access Control List
|
2882
|
+
# The name of the Access Control List.
|
2644
2883
|
#
|
2645
2884
|
# @option params [Array<String>] :user_names_to_add
|
2646
|
-
# The list of users to add to the Access Control List
|
2885
|
+
# The list of users to add to the Access Control List.
|
2647
2886
|
#
|
2648
2887
|
# @option params [Array<String>] :user_names_to_remove
|
2649
|
-
# The list of users to remove from the Access Control List
|
2888
|
+
# The list of users to remove from the Access Control List.
|
2650
2889
|
#
|
2651
2890
|
# @return [Types::UpdateACLResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2652
2891
|
#
|
@@ -2689,13 +2928,13 @@ module Aws::MemoryDB
|
|
2689
2928
|
# settings and the new values.
|
2690
2929
|
#
|
2691
2930
|
# @option params [required, String] :cluster_name
|
2692
|
-
# The name of the cluster to update
|
2931
|
+
# The name of the cluster to update.
|
2693
2932
|
#
|
2694
2933
|
# @option params [String] :description
|
2695
|
-
# The description of the cluster to update
|
2934
|
+
# The description of the cluster to update.
|
2696
2935
|
#
|
2697
2936
|
# @option params [Array<String>] :security_group_ids
|
2698
|
-
# The SecurityGroupIds to update
|
2937
|
+
# The SecurityGroupIds to update.
|
2699
2938
|
#
|
2700
2939
|
# @option params [String] :maintenance_window
|
2701
2940
|
# Specifies the weekly time range during which maintenance on the
|
@@ -2722,14 +2961,14 @@ module Aws::MemoryDB
|
|
2722
2961
|
# Example: `sun:23:00-mon:01:30`
|
2723
2962
|
#
|
2724
2963
|
# @option params [String] :sns_topic_arn
|
2725
|
-
# The SNS topic ARN to update
|
2964
|
+
# The SNS topic ARN to update.
|
2726
2965
|
#
|
2727
2966
|
# @option params [String] :sns_topic_status
|
2728
2967
|
# The status of the Amazon SNS notification topic. Notifications are
|
2729
2968
|
# sent only if the status is active.
|
2730
2969
|
#
|
2731
2970
|
# @option params [String] :parameter_group_name
|
2732
|
-
# The name of the parameter group to update
|
2971
|
+
# The name of the parameter group to update.
|
2733
2972
|
#
|
2734
2973
|
# @option params [String] :snapshot_window
|
2735
2974
|
# The daily time range (in UTC) during which MemoryDB begins taking a
|
@@ -2745,8 +2984,7 @@ module Aws::MemoryDB
|
|
2745
2984
|
# A valid node type that you want to scale this cluster up or down to.
|
2746
2985
|
#
|
2747
2986
|
# @option params [String] :engine
|
2748
|
-
# The name of the engine to be used for the
|
2749
|
-
# value must be set to either Redis or Valkey.
|
2987
|
+
# The name of the engine to be used for the cluster.
|
2750
2988
|
#
|
2751
2989
|
# @option params [String] :engine_version
|
2752
2990
|
# The upgraded version of the engine to be run on the nodes. You can
|
@@ -2756,13 +2994,13 @@ module Aws::MemoryDB
|
|
2756
2994
|
# earlier engine version.
|
2757
2995
|
#
|
2758
2996
|
# @option params [Types::ReplicaConfigurationRequest] :replica_configuration
|
2759
|
-
# The number of replicas that will reside in each shard
|
2997
|
+
# The number of replicas that will reside in each shard.
|
2760
2998
|
#
|
2761
2999
|
# @option params [Types::ShardConfigurationRequest] :shard_configuration
|
2762
|
-
# The number of shards in the cluster
|
3000
|
+
# The number of shards in the cluster.
|
2763
3001
|
#
|
2764
3002
|
# @option params [String] :acl_name
|
2765
|
-
# The Access Control List that is associated with the cluster
|
3003
|
+
# The Access Control List that is associated with the cluster.
|
2766
3004
|
#
|
2767
3005
|
# @return [Types::UpdateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2768
3006
|
#
|
@@ -2802,6 +3040,7 @@ module Aws::MemoryDB
|
|
2802
3040
|
# resp.cluster.pending_updates.service_updates #=> Array
|
2803
3041
|
# resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
|
2804
3042
|
# resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
|
3043
|
+
# resp.cluster.multi_region_cluster_name #=> String
|
2805
3044
|
# resp.cluster.number_of_shards #=> Integer
|
2806
3045
|
# resp.cluster.shards #=> Array
|
2807
3046
|
# resp.cluster.shards[0].name #=> String
|
@@ -2849,6 +3088,75 @@ module Aws::MemoryDB
|
|
2849
3088
|
req.send_request(options)
|
2850
3089
|
end
|
2851
3090
|
|
3091
|
+
# Updates the configuration of an existing multi-Region cluster.
|
3092
|
+
#
|
3093
|
+
# @option params [required, String] :multi_region_cluster_name
|
3094
|
+
# The name of the multi-Region cluster to be updated.
|
3095
|
+
#
|
3096
|
+
# @option params [String] :node_type
|
3097
|
+
# The new node type to be used for the multi-Region cluster.
|
3098
|
+
#
|
3099
|
+
# @option params [String] :description
|
3100
|
+
# A new description for the multi-Region cluster.
|
3101
|
+
#
|
3102
|
+
# @option params [String] :engine_version
|
3103
|
+
# The new engine version to be used for the multi-Region cluster.
|
3104
|
+
#
|
3105
|
+
# @option params [Types::ShardConfigurationRequest] :shard_configuration
|
3106
|
+
# A request to configure the sharding properties of a cluster
|
3107
|
+
#
|
3108
|
+
# @option params [String] :multi_region_parameter_group_name
|
3109
|
+
# The new multi-Region parameter group to be associated with the
|
3110
|
+
# cluster.
|
3111
|
+
#
|
3112
|
+
# @option params [String] :update_strategy
|
3113
|
+
# Whether to force the update even if it may cause data loss.
|
3114
|
+
#
|
3115
|
+
# @return [Types::UpdateMultiRegionClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3116
|
+
#
|
3117
|
+
# * {Types::UpdateMultiRegionClusterResponse#multi_region_cluster #multi_region_cluster} => Types::MultiRegionCluster
|
3118
|
+
#
|
3119
|
+
# @example Request syntax with placeholder values
|
3120
|
+
#
|
3121
|
+
# resp = client.update_multi_region_cluster({
|
3122
|
+
# multi_region_cluster_name: "String", # required
|
3123
|
+
# node_type: "String",
|
3124
|
+
# description: "String",
|
3125
|
+
# engine_version: "String",
|
3126
|
+
# shard_configuration: {
|
3127
|
+
# shard_count: 1,
|
3128
|
+
# },
|
3129
|
+
# multi_region_parameter_group_name: "String",
|
3130
|
+
# update_strategy: "coordinated", # accepts coordinated, uncoordinated
|
3131
|
+
# })
|
3132
|
+
#
|
3133
|
+
# @example Response structure
|
3134
|
+
#
|
3135
|
+
# resp.multi_region_cluster.multi_region_cluster_name #=> String
|
3136
|
+
# resp.multi_region_cluster.description #=> String
|
3137
|
+
# resp.multi_region_cluster.status #=> String
|
3138
|
+
# resp.multi_region_cluster.node_type #=> String
|
3139
|
+
# resp.multi_region_cluster.engine #=> String
|
3140
|
+
# resp.multi_region_cluster.engine_version #=> String
|
3141
|
+
# resp.multi_region_cluster.number_of_shards #=> Integer
|
3142
|
+
# resp.multi_region_cluster.clusters #=> Array
|
3143
|
+
# resp.multi_region_cluster.clusters[0].cluster_name #=> String
|
3144
|
+
# resp.multi_region_cluster.clusters[0].region #=> String
|
3145
|
+
# resp.multi_region_cluster.clusters[0].status #=> String
|
3146
|
+
# resp.multi_region_cluster.clusters[0].arn #=> String
|
3147
|
+
# resp.multi_region_cluster.multi_region_parameter_group_name #=> String
|
3148
|
+
# resp.multi_region_cluster.tls_enabled #=> Boolean
|
3149
|
+
# resp.multi_region_cluster.arn #=> String
|
3150
|
+
#
|
3151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateMultiRegionCluster AWS API Documentation
|
3152
|
+
#
|
3153
|
+
# @overload update_multi_region_cluster(params = {})
|
3154
|
+
# @param [Hash] params ({})
|
3155
|
+
def update_multi_region_cluster(params = {}, options = {})
|
3156
|
+
req = build_request(:update_multi_region_cluster, params)
|
3157
|
+
req.send_request(options)
|
3158
|
+
end
|
3159
|
+
|
2852
3160
|
# Updates the parameters of a parameter group. You can modify up to 20
|
2853
3161
|
# parameters in a single request by submitting a list parameter name and
|
2854
3162
|
# value pairs.
|
@@ -3007,7 +3315,7 @@ module Aws::MemoryDB
|
|
3007
3315
|
tracer: tracer
|
3008
3316
|
)
|
3009
3317
|
context[:gem_name] = 'aws-sdk-memorydb'
|
3010
|
-
context[:gem_version] = '1.
|
3318
|
+
context[:gem_version] = '1.40.0'
|
3011
3319
|
Seahorse::Client::Request.new(handlers, context)
|
3012
3320
|
end
|
3013
3321
|
|