aws-sdk-elasticache 1.6.0 → 1.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-elasticache.rb +1 -1
- data/lib/aws-sdk-elasticache/client.rb +351 -106
- data/lib/aws-sdk-elasticache/client_api.rb +88 -3
- data/lib/aws-sdk-elasticache/types.rb +433 -116
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 23bb9309d8ba331f9fdee191e970348c84c0a261
|
4
|
+
data.tar.gz: 8f171338bbdc80f75b2e917d968270cc6e32ea7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5be7232a35df08ee30fe6bfacd2572a22dce12780c6523f5200c39d8d944be5032d32e1dc11fe1a0557f8b794e6527152b6e56385cb446cc83408d006b2ca13d
|
7
|
+
data.tar.gz: 651e8c738f77c1af0968ca192ddedc9624f0a82369381c530456e3c30b6eb432440233aeee535492f45ed0abd34458af5b96a418a0fe621335195b316fc62292
|
data/lib/aws-sdk-elasticache.rb
CHANGED
@@ -191,7 +191,7 @@ module Aws::ElastiCache
|
|
191
191
|
#
|
192
192
|
#
|
193
193
|
#
|
194
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
194
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html
|
195
195
|
#
|
196
196
|
# @option params [required, String] :resource_name
|
197
197
|
# The Amazon Resource Name (ARN) of the resource to which the tags are
|
@@ -412,10 +412,10 @@ module Aws::ElastiCache
|
|
412
412
|
#
|
413
413
|
#
|
414
414
|
#
|
415
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
416
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
417
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
418
|
-
# [4]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
415
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html
|
416
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html
|
417
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket
|
418
|
+
# [4]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess
|
419
419
|
#
|
420
420
|
# @option params [required, String] :source_snapshot_name
|
421
421
|
# The name of an existing snapshot from which to make a copy.
|
@@ -439,8 +439,8 @@ module Aws::ElastiCache
|
|
439
439
|
#
|
440
440
|
#
|
441
441
|
#
|
442
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
443
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
442
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess
|
443
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html
|
444
444
|
#
|
445
445
|
# @return [Types::CopySnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
446
446
|
#
|
@@ -526,6 +526,7 @@ module Aws::ElastiCache
|
|
526
526
|
# resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
|
527
527
|
# resp.snapshot.node_snapshots[0].node_group_id #=> String
|
528
528
|
# resp.snapshot.node_snapshots[0].cache_node_id #=> String
|
529
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
|
529
530
|
# resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
|
530
531
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
|
531
532
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
@@ -547,9 +548,8 @@ module Aws::ElastiCache
|
|
547
548
|
# Creates a cluster. All nodes in the cluster run the same
|
548
549
|
# protocol-compliant cache engine software, either Memcached or Redis.
|
549
550
|
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
# enabled) replication groups.
|
551
|
+
# This operation is not supported for Redis (cluster mode enabled)
|
552
|
+
# clusters.
|
553
553
|
#
|
554
554
|
# @option params [required, String] :cache_cluster_id
|
555
555
|
# The node group (shard) identifier. This parameter is stored as a
|
@@ -564,10 +564,6 @@ module Aws::ElastiCache
|
|
564
564
|
# * A name cannot end with a hyphen or contain two consecutive hyphens.
|
565
565
|
#
|
566
566
|
# @option params [String] :replication_group_id
|
567
|
-
# Due to current limitations on Redis (cluster mode disabled), this
|
568
|
-
# operation or parameter is not supported on Redis (cluster mode
|
569
|
-
# enabled) replication groups.
|
570
|
-
#
|
571
567
|
# The ID of the replication group to which this cluster should belong.
|
572
568
|
# If this parameter is specified, the cluster is added to the specified
|
573
569
|
# replication group as a read replica; otherwise, the cluster is a
|
@@ -678,6 +674,10 @@ module Aws::ElastiCache
|
|
678
674
|
# **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`,
|
679
675
|
# `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`
|
680
676
|
#
|
677
|
+
# **R4 node types;** `cache.r4.large`, `cache.r4.xlarge`,
|
678
|
+
# `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,
|
679
|
+
# `cache.r4.16xlarge`
|
680
|
+
#
|
681
681
|
# * Previous generation: (not recommended)
|
682
682
|
#
|
683
683
|
# **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`,
|
@@ -697,16 +697,19 @@ module Aws::ElastiCache
|
|
697
697
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
698
698
|
# or T2 instances.
|
699
699
|
#
|
700
|
-
# For a complete listing of node types and specifications, see
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
700
|
+
# For a complete listing of node types and specifications, see:
|
701
|
+
#
|
702
|
+
# * [Amazon ElastiCache Product Features and Details][1]
|
703
|
+
#
|
704
|
+
# * [Cache Node Type-Specific Parameters for Memcached][2]
|
705
|
+
#
|
706
|
+
# * [Cache Node Type-Specific Parameters for Redis][3]
|
704
707
|
#
|
705
708
|
#
|
706
709
|
#
|
707
710
|
# [1]: http://aws.amazon.com/elasticache/details
|
708
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
709
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
711
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific
|
712
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
710
713
|
#
|
711
714
|
# @option params [String] :engine
|
712
715
|
# The name of the cache engine to be used for this cluster.
|
@@ -726,7 +729,7 @@ module Aws::ElastiCache
|
|
726
729
|
#
|
727
730
|
#
|
728
731
|
#
|
729
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
732
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement
|
730
733
|
#
|
731
734
|
# @option params [String] :cache_parameter_group_name
|
732
735
|
# The name of the parameter group to associate with this cluster. If
|
@@ -746,7 +749,7 @@ module Aws::ElastiCache
|
|
746
749
|
#
|
747
750
|
#
|
748
751
|
#
|
749
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
752
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html
|
750
753
|
#
|
751
754
|
# @option params [Array<String>] :cache_security_group_names
|
752
755
|
# A list of security group names to associate with this cluster.
|
@@ -837,7 +840,8 @@ module Aws::ElastiCache
|
|
837
840
|
#
|
838
841
|
# </note>
|
839
842
|
#
|
840
|
-
# Default: 0 (i.e., automatic backups are disabled for this
|
843
|
+
# Default: 0 (i.e., automatic backups are disabled for this cache
|
844
|
+
# cluster).
|
841
845
|
#
|
842
846
|
# @option params [String] :snapshot_window
|
843
847
|
# The daily time range (in UTC) during which ElastiCache begins taking a
|
@@ -856,13 +860,6 @@ module Aws::ElastiCache
|
|
856
860
|
# **Reserved parameter.** The password used to access a password
|
857
861
|
# protected server.
|
858
862
|
#
|
859
|
-
# This parameter is valid only if:
|
860
|
-
#
|
861
|
-
# * The parameter `TransitEncryptionEnabled` was set to `true` when the
|
862
|
-
# cluster was created.
|
863
|
-
#
|
864
|
-
# * The line `requirepass` was added to the database configuration file.
|
865
|
-
#
|
866
863
|
# Password constraints:
|
867
864
|
#
|
868
865
|
# * Must be only printable ASCII characters.
|
@@ -1081,7 +1078,7 @@ module Aws::ElastiCache
|
|
1081
1078
|
#
|
1082
1079
|
#
|
1083
1080
|
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html
|
1084
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1081
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html
|
1085
1082
|
#
|
1086
1083
|
# @option params [required, String] :cache_parameter_group_name
|
1087
1084
|
# A user-specified name for the cache parameter group.
|
@@ -1091,7 +1088,7 @@ module Aws::ElastiCache
|
|
1091
1088
|
# group can be used with.
|
1092
1089
|
#
|
1093
1090
|
# Valid values are: `memcached1.4` \| `redis2.6` \| `redis2.8` \|
|
1094
|
-
# `redis3.2`
|
1091
|
+
# `redis3.2` \| `redis4.0`
|
1095
1092
|
#
|
1096
1093
|
# @option params [required, String] :description
|
1097
1094
|
# A user-specified description for the cache parameter group.
|
@@ -1331,7 +1328,7 @@ module Aws::ElastiCache
|
|
1331
1328
|
#
|
1332
1329
|
#
|
1333
1330
|
#
|
1334
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1331
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-restoring.html
|
1335
1332
|
#
|
1336
1333
|
# @option params [required, String] :replication_group_id
|
1337
1334
|
# The replication group identifier. This parameter is stored as a
|
@@ -1388,8 +1385,8 @@ module Aws::ElastiCache
|
|
1388
1385
|
# omit this parameter (it will default to 1), or you can explicitly set
|
1389
1386
|
# it to a value between 2 and 6.
|
1390
1387
|
#
|
1391
|
-
# The maximum permitted value for `NumCacheClusters` is 6 (primary
|
1392
|
-
# 5 replicas).
|
1388
|
+
# The maximum permitted value for `NumCacheClusters` is 6 (1 primary
|
1389
|
+
# plus 5 replicas).
|
1393
1390
|
#
|
1394
1391
|
# @option params [Array<String>] :preferred_cache_cluster_a_zs
|
1395
1392
|
# A list of EC2 Availability Zones in which the replication group's
|
@@ -1425,13 +1422,17 @@ module Aws::ElastiCache
|
|
1425
1422
|
#
|
1426
1423
|
# @option params [Array<Types::NodeGroupConfiguration>] :node_group_configuration
|
1427
1424
|
# A list of node group (shard) configuration options. Each node group
|
1428
|
-
# (shard) configuration has the following:
|
1429
|
-
# PrimaryAvailabilityZone
|
1425
|
+
# (shard) configuration has the following members:
|
1426
|
+
# `PrimaryAvailabilityZone`, `ReplicaAvailabilityZones`, `ReplicaCount`,
|
1427
|
+
# and `Slots`.
|
1430
1428
|
#
|
1431
1429
|
# If you're creating a Redis (cluster mode disabled) or a Redis
|
1432
1430
|
# (cluster mode enabled) replication group, you can use this parameter
|
1433
1431
|
# to individually configure each node group (shard), or you can omit
|
1434
|
-
# this parameter.
|
1432
|
+
# this parameter. However, when seeding a Redis (cluster mode enabled)
|
1433
|
+
# cluster from a S3 rdb file, you must configure each node group (shard)
|
1434
|
+
# using this parameter because you must specify the slots for each node
|
1435
|
+
# group.
|
1435
1436
|
#
|
1436
1437
|
# @option params [String] :cache_node_type
|
1437
1438
|
# The compute and memory capacity of the nodes in the node group
|
@@ -1475,6 +1476,10 @@ module Aws::ElastiCache
|
|
1475
1476
|
# **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`,
|
1476
1477
|
# `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`
|
1477
1478
|
#
|
1479
|
+
# **R4 node types;** `cache.r4.large`, `cache.r4.xlarge`,
|
1480
|
+
# `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,
|
1481
|
+
# `cache.r4.16xlarge`
|
1482
|
+
#
|
1478
1483
|
# * Previous generation: (not recommended)
|
1479
1484
|
#
|
1480
1485
|
# **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`,
|
@@ -1494,16 +1499,19 @@ module Aws::ElastiCache
|
|
1494
1499
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
1495
1500
|
# or T2 instances.
|
1496
1501
|
#
|
1497
|
-
# For a complete listing of node types and specifications, see
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
#
|
1502
|
+
# For a complete listing of node types and specifications, see:
|
1503
|
+
#
|
1504
|
+
# * [Amazon ElastiCache Product Features and Details][1]
|
1505
|
+
#
|
1506
|
+
# * [Cache Node Type-Specific Parameters for Memcached][2]
|
1507
|
+
#
|
1508
|
+
# * [Cache Node Type-Specific Parameters for Redis][3]
|
1501
1509
|
#
|
1502
1510
|
#
|
1503
1511
|
#
|
1504
1512
|
# [1]: http://aws.amazon.com/elasticache/details
|
1505
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1506
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1513
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific
|
1514
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
1507
1515
|
#
|
1508
1516
|
# @option params [String] :engine
|
1509
1517
|
# The name of the cache engine to be used for the clusters in this
|
@@ -1523,7 +1531,7 @@ module Aws::ElastiCache
|
|
1523
1531
|
#
|
1524
1532
|
#
|
1525
1533
|
#
|
1526
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1534
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement
|
1527
1535
|
#
|
1528
1536
|
# @option params [String] :cache_parameter_group_name
|
1529
1537
|
# The name of the parameter group to associate with this replication
|
@@ -1550,7 +1558,7 @@ module Aws::ElastiCache
|
|
1550
1558
|
#
|
1551
1559
|
#
|
1552
1560
|
#
|
1553
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
1561
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html
|
1554
1562
|
#
|
1555
1563
|
# @option params [Array<String>] :cache_security_group_names
|
1556
1564
|
# A list of cache security group names to associate with this
|
@@ -1565,8 +1573,7 @@ module Aws::ElastiCache
|
|
1565
1573
|
#
|
1566
1574
|
# @option params [Array<Types::Tag>] :tags
|
1567
1575
|
# A list of cost allocation tags to be added to this resource. A tag is
|
1568
|
-
# a key-value pair.
|
1569
|
-
# value.
|
1576
|
+
# a key-value pair.
|
1570
1577
|
#
|
1571
1578
|
# @option params [Array<String>] :snapshot_arns
|
1572
1579
|
# A list of Amazon Resource Names (ARN) that uniquely identify the Redis
|
@@ -1650,12 +1657,11 @@ module Aws::ElastiCache
|
|
1650
1657
|
# **Reserved parameter.** The password used to access a password
|
1651
1658
|
# protected server.
|
1652
1659
|
#
|
1653
|
-
#
|
1660
|
+
# `AuthToken` can be specified only on replication groups where
|
1661
|
+
# `TransitEncryptionEnabled` is `true`.
|
1654
1662
|
#
|
1655
|
-
#
|
1656
|
-
#
|
1657
|
-
#
|
1658
|
-
# * The line `requirepass` was added to the database configuration file.
|
1663
|
+
# For HIPAA compliance, you must specify `TransitEncryptionEnabled` as
|
1664
|
+
# `true`, an `AuthToken`, and a `CacheSubnetGroup`.
|
1659
1665
|
#
|
1660
1666
|
# Password constraints:
|
1661
1667
|
#
|
@@ -1683,14 +1689,20 @@ module Aws::ElastiCache
|
|
1683
1689
|
# cluster.
|
1684
1690
|
#
|
1685
1691
|
# This parameter is valid only if the `Engine` parameter is `redis`, the
|
1686
|
-
# `EngineVersion` parameter is `3.2.
|
1692
|
+
# `EngineVersion` parameter is `3.2.6` or `4.x`, and the cluster is
|
1687
1693
|
# being created in an Amazon VPC.
|
1688
1694
|
#
|
1689
1695
|
# If you enable in-transit encryption, you must also specify a value for
|
1690
1696
|
# `CacheSubnetGroup`.
|
1691
1697
|
#
|
1698
|
+
# **Required:** Only available when creating a replication group in an
|
1699
|
+
# Amazon VPC using redis version `3.2.6` or `4.x`.
|
1700
|
+
#
|
1692
1701
|
# Default: `false`
|
1693
1702
|
#
|
1703
|
+
# For HIPAA compliance, you must specify `TransitEncryptionEnabled` as
|
1704
|
+
# `true`, an `AuthToken`, and a `CacheSubnetGroup`.
|
1705
|
+
#
|
1694
1706
|
# @option params [Boolean] :at_rest_encryption_enabled
|
1695
1707
|
# A flag that enables encryption at rest when set to `true`.
|
1696
1708
|
#
|
@@ -1699,10 +1711,8 @@ module Aws::ElastiCache
|
|
1699
1711
|
# replication group you must set `AtRestEncryptionEnabled` to `true`
|
1700
1712
|
# when you create the replication group.
|
1701
1713
|
#
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
# </note>
|
1714
|
+
# **Required:** Only available when creating a replication group in an
|
1715
|
+
# Amazon VPC using redis version `3.2.6` or `4.x`.
|
1706
1716
|
#
|
1707
1717
|
# Default: `false`
|
1708
1718
|
#
|
@@ -1814,6 +1824,7 @@ module Aws::ElastiCache
|
|
1814
1824
|
# replicas_per_node_group: 1,
|
1815
1825
|
# node_group_configuration: [
|
1816
1826
|
# {
|
1827
|
+
# node_group_id: "AllowedNodeGroupId",
|
1817
1828
|
# slots: "String",
|
1818
1829
|
# replica_count: 1,
|
1819
1830
|
# primary_availability_zone: "String",
|
@@ -2074,6 +2085,7 @@ module Aws::ElastiCache
|
|
2074
2085
|
# resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
|
2075
2086
|
# resp.snapshot.node_snapshots[0].node_group_id #=> String
|
2076
2087
|
# resp.snapshot.node_snapshots[0].cache_node_id #=> String
|
2088
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
|
2077
2089
|
# resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
|
2078
2090
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
|
2079
2091
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
@@ -2092,6 +2104,113 @@ module Aws::ElastiCache
|
|
2092
2104
|
req.send_request(options)
|
2093
2105
|
end
|
2094
2106
|
|
2107
|
+
# Dynamically decreases the number of replics in a Redis (cluster mode
|
2108
|
+
# disabled) replication group or the number of replica nodes in one or
|
2109
|
+
# more node groups (shards) of a Redis (cluster mode enabled)
|
2110
|
+
# replication group. This operation is performed with no cluster down
|
2111
|
+
# time.
|
2112
|
+
#
|
2113
|
+
# @option params [required, String] :replication_group_id
|
2114
|
+
# The id of the replication group from which you want to remove replica
|
2115
|
+
# nodes.
|
2116
|
+
#
|
2117
|
+
# @option params [Integer] :new_replica_count
|
2118
|
+
# The number of read replica nodes you want at the completion of this
|
2119
|
+
# operation. For Redis (cluster mode disabled) replication groups, this
|
2120
|
+
# is the number of replica nodes in the replication group. For Redis
|
2121
|
+
# (cluster mode enabled) replication groups, this is the number of
|
2122
|
+
# replica nodes in each of the replication group's node groups.
|
2123
|
+
#
|
2124
|
+
# The minimum number of replicas in a shard or replication group is:
|
2125
|
+
#
|
2126
|
+
# * Redis (cluster mode disabled)
|
2127
|
+
#
|
2128
|
+
# * If Multi-AZ with Automatic Failover is enabled: 1
|
2129
|
+
#
|
2130
|
+
# * If Multi-AZ with Automatic Failover is not enabled: 0
|
2131
|
+
#
|
2132
|
+
# * Redis (cluster mode enabled): 0 (though you will not be able to
|
2133
|
+
# failover to a replica if your primary node fails)
|
2134
|
+
#
|
2135
|
+
# @option params [Array<Types::ConfigureShard>] :replica_configuration
|
2136
|
+
# A list of `ConfigureShard` objects that can be used to configure each
|
2137
|
+
# shard in a Redis (cluster mode enabled) replication group. The
|
2138
|
+
# `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`,
|
2139
|
+
# and `PreferredAvailabilityZones`.
|
2140
|
+
#
|
2141
|
+
# @option params [Array<String>] :replicas_to_remove
|
2142
|
+
# A list of the node ids to remove from the replication group or node
|
2143
|
+
# group (shard).
|
2144
|
+
#
|
2145
|
+
# @option params [required, Boolean] :apply_immediately
|
2146
|
+
# If `True`, the number of replica nodes is decreased immediately. If
|
2147
|
+
# `False`, the number of replica nodes is decreased during the next
|
2148
|
+
# maintenance window.
|
2149
|
+
#
|
2150
|
+
# @return [Types::DecreaseReplicaCountResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2151
|
+
#
|
2152
|
+
# * {Types::DecreaseReplicaCountResult#replication_group #replication_group} => Types::ReplicationGroup
|
2153
|
+
#
|
2154
|
+
# @example Request syntax with placeholder values
|
2155
|
+
#
|
2156
|
+
# resp = client.decrease_replica_count({
|
2157
|
+
# replication_group_id: "String", # required
|
2158
|
+
# new_replica_count: 1,
|
2159
|
+
# replica_configuration: [
|
2160
|
+
# {
|
2161
|
+
# node_group_id: "AllowedNodeGroupId", # required
|
2162
|
+
# new_replica_count: 1, # required
|
2163
|
+
# preferred_availability_zones: ["String"],
|
2164
|
+
# },
|
2165
|
+
# ],
|
2166
|
+
# replicas_to_remove: ["String"],
|
2167
|
+
# apply_immediately: false, # required
|
2168
|
+
# })
|
2169
|
+
#
|
2170
|
+
# @example Response structure
|
2171
|
+
#
|
2172
|
+
# resp.replication_group.replication_group_id #=> String
|
2173
|
+
# resp.replication_group.description #=> String
|
2174
|
+
# resp.replication_group.status #=> String
|
2175
|
+
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
2176
|
+
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
2177
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
2178
|
+
# resp.replication_group.member_clusters #=> Array
|
2179
|
+
# resp.replication_group.member_clusters[0] #=> String
|
2180
|
+
# resp.replication_group.node_groups #=> Array
|
2181
|
+
# resp.replication_group.node_groups[0].node_group_id #=> String
|
2182
|
+
# resp.replication_group.node_groups[0].status #=> String
|
2183
|
+
# resp.replication_group.node_groups[0].primary_endpoint.address #=> String
|
2184
|
+
# resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
|
2185
|
+
# resp.replication_group.node_groups[0].slots #=> String
|
2186
|
+
# resp.replication_group.node_groups[0].node_group_members #=> Array
|
2187
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
|
2188
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
|
2189
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
2190
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
2191
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
2192
|
+
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
2193
|
+
# resp.replication_group.snapshotting_cluster_id #=> String
|
2194
|
+
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
2195
|
+
# resp.replication_group.configuration_endpoint.address #=> String
|
2196
|
+
# resp.replication_group.configuration_endpoint.port #=> Integer
|
2197
|
+
# resp.replication_group.snapshot_retention_limit #=> Integer
|
2198
|
+
# resp.replication_group.snapshot_window #=> String
|
2199
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
2200
|
+
# resp.replication_group.cache_node_type #=> String
|
2201
|
+
# resp.replication_group.auth_token_enabled #=> Boolean
|
2202
|
+
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
2203
|
+
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
2204
|
+
#
|
2205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DecreaseReplicaCount AWS API Documentation
|
2206
|
+
#
|
2207
|
+
# @overload decrease_replica_count(params = {})
|
2208
|
+
# @param [Hash] params ({})
|
2209
|
+
def decrease_replica_count(params = {}, options = {})
|
2210
|
+
req = build_request(:decrease_replica_count, params)
|
2211
|
+
req.send_request(options)
|
2212
|
+
end
|
2213
|
+
|
2095
2214
|
# Deletes a previously provisioned cluster. `DeleteCacheCluster` deletes
|
2096
2215
|
# all associated cache nodes, node endpoints and the cluster itself.
|
2097
2216
|
# When you receive a successful response from this operation, Amazon
|
@@ -2103,9 +2222,7 @@ module Aws::ElastiCache
|
|
2103
2222
|
# Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled)
|
2104
2223
|
# replication group.
|
2105
2224
|
#
|
2106
|
-
#
|
2107
|
-
# operation or parameter is not supported on Redis (cluster mode
|
2108
|
-
# enabled) replication groups.
|
2225
|
+
# This operation is not valid for Redis (cluster mode enabled) clusters.
|
2109
2226
|
#
|
2110
2227
|
# @option params [required, String] :cache_cluster_id
|
2111
2228
|
# The cluster identifier for the cluster to be deleted. This parameter
|
@@ -2540,6 +2657,7 @@ module Aws::ElastiCache
|
|
2540
2657
|
# resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
|
2541
2658
|
# resp.snapshot.node_snapshots[0].node_group_id #=> String
|
2542
2659
|
# resp.snapshot.node_snapshots[0].cache_node_id #=> String
|
2660
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
|
2543
2661
|
# resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
|
2544
2662
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
|
2545
2663
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
@@ -2813,7 +2931,7 @@ module Aws::ElastiCache
|
|
2813
2931
|
# for.
|
2814
2932
|
#
|
2815
2933
|
# Valid values are: `memcached1.4` \| `redis2.6` \| `redis2.8` \|
|
2816
|
-
# `redis3.2`
|
2934
|
+
# `redis3.2` \| `redis4.0`
|
2817
2935
|
#
|
2818
2936
|
# Constraints:
|
2819
2937
|
#
|
@@ -3778,7 +3896,7 @@ module Aws::ElastiCache
|
|
3778
3896
|
# The name of the cache parameter group family.
|
3779
3897
|
#
|
3780
3898
|
# Valid values are: `memcached1.4` \| `redis2.6` \| `redis2.8` \|
|
3781
|
-
# `redis3.2`
|
3899
|
+
# `redis3.2` \| `redis4.0`
|
3782
3900
|
#
|
3783
3901
|
# @option params [Integer] :max_records
|
3784
3902
|
# The maximum number of records to include in the response. If more
|
@@ -4843,6 +4961,10 @@ module Aws::ElastiCache
|
|
4843
4961
|
# **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`,
|
4844
4962
|
# `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`
|
4845
4963
|
#
|
4964
|
+
# **R4 node types;** `cache.r4.large`, `cache.r4.xlarge`,
|
4965
|
+
# `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,
|
4966
|
+
# `cache.r4.16xlarge`
|
4967
|
+
#
|
4846
4968
|
# * Previous generation: (not recommended)
|
4847
4969
|
#
|
4848
4970
|
# **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`,
|
@@ -4862,16 +4984,19 @@ module Aws::ElastiCache
|
|
4862
4984
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
4863
4985
|
# or T2 instances.
|
4864
4986
|
#
|
4865
|
-
# For a complete listing of node types and specifications, see
|
4866
|
-
#
|
4867
|
-
#
|
4868
|
-
#
|
4987
|
+
# For a complete listing of node types and specifications, see:
|
4988
|
+
#
|
4989
|
+
# * [Amazon ElastiCache Product Features and Details][1]
|
4990
|
+
#
|
4991
|
+
# * [Cache Node Type-Specific Parameters for Memcached][2]
|
4992
|
+
#
|
4993
|
+
# * [Cache Node Type-Specific Parameters for Redis][3]
|
4869
4994
|
#
|
4870
4995
|
#
|
4871
4996
|
#
|
4872
4997
|
# [1]: http://aws.amazon.com/elasticache/details
|
4873
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
4874
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
4998
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific
|
4999
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
4875
5000
|
#
|
4876
5001
|
# @option params [String] :duration
|
4877
5002
|
# The duration filter value, specified in years or seconds. Use this
|
@@ -4952,6 +5077,7 @@ module Aws::ElastiCache
|
|
4952
5077
|
# resp.reserved_cache_nodes[0].recurring_charges #=> Array
|
4953
5078
|
# resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_amount #=> Float
|
4954
5079
|
# resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_frequency #=> String
|
5080
|
+
# resp.reserved_cache_nodes[0].reservation_arn #=> String
|
4955
5081
|
#
|
4956
5082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReservedCacheNodes AWS API Documentation
|
4957
5083
|
#
|
@@ -5013,6 +5139,10 @@ module Aws::ElastiCache
|
|
5013
5139
|
# **R3 node types:** `cache.r3.large`, `cache.r3.xlarge`,
|
5014
5140
|
# `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`
|
5015
5141
|
#
|
5142
|
+
# **R4 node types;** `cache.r4.large`, `cache.r4.xlarge`,
|
5143
|
+
# `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`,
|
5144
|
+
# `cache.r4.16xlarge`
|
5145
|
+
#
|
5016
5146
|
# * Previous generation: (not recommended)
|
5017
5147
|
#
|
5018
5148
|
# **M2 node types:** `cache.m2.xlarge`, `cache.m2.2xlarge`,
|
@@ -5032,16 +5162,19 @@ module Aws::ElastiCache
|
|
5032
5162
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
5033
5163
|
# or T2 instances.
|
5034
5164
|
#
|
5035
|
-
# For a complete listing of node types and specifications, see
|
5036
|
-
#
|
5037
|
-
#
|
5038
|
-
#
|
5165
|
+
# For a complete listing of node types and specifications, see:
|
5166
|
+
#
|
5167
|
+
# * [Amazon ElastiCache Product Features and Details][1]
|
5168
|
+
#
|
5169
|
+
# * [Cache Node Type-Specific Parameters for Memcached][2]
|
5170
|
+
#
|
5171
|
+
# * [Cache Node Type-Specific Parameters for Redis][3]
|
5039
5172
|
#
|
5040
5173
|
#
|
5041
5174
|
#
|
5042
5175
|
# [1]: http://aws.amazon.com/elasticache/details
|
5043
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
5044
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
5176
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific
|
5177
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
5045
5178
|
#
|
5046
5179
|
# @option params [String] :duration
|
5047
5180
|
# Duration filter value, specified in years or seconds. Use this
|
@@ -5577,6 +5710,7 @@ module Aws::ElastiCache
|
|
5577
5710
|
# resp.snapshots[0].node_snapshots[0].cache_cluster_id #=> String
|
5578
5711
|
# resp.snapshots[0].node_snapshots[0].node_group_id #=> String
|
5579
5712
|
# resp.snapshots[0].node_snapshots[0].cache_node_id #=> String
|
5713
|
+
# resp.snapshots[0].node_snapshots[0].node_group_configuration.node_group_id #=> String
|
5580
5714
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.slots #=> String
|
5581
5715
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_count #=> Integer
|
5582
5716
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
@@ -5595,6 +5729,97 @@ module Aws::ElastiCache
|
|
5595
5729
|
req.send_request(options)
|
5596
5730
|
end
|
5597
5731
|
|
5732
|
+
# Dynamically increases the number of replics in a Redis (cluster mode
|
5733
|
+
# disabled) replication group or the number of replica nodes in one or
|
5734
|
+
# more node groups (shards) of a Redis (cluster mode enabled)
|
5735
|
+
# replication group. This operation is performed with no cluster down
|
5736
|
+
# time.
|
5737
|
+
#
|
5738
|
+
# @option params [required, String] :replication_group_id
|
5739
|
+
# The id of the replication group to which you want to add replica
|
5740
|
+
# nodes.
|
5741
|
+
#
|
5742
|
+
# @option params [Integer] :new_replica_count
|
5743
|
+
# The number of read replica nodes you want at the completion of this
|
5744
|
+
# operation. For Redis (cluster mode disabled) replication groups, this
|
5745
|
+
# is the number of replica nodes in the replication group. For Redis
|
5746
|
+
# (cluster mode enabled) replication groups, this is the number of
|
5747
|
+
# replica nodes in each of the replication group's node groups.
|
5748
|
+
#
|
5749
|
+
# @option params [Array<Types::ConfigureShard>] :replica_configuration
|
5750
|
+
# A list of `ConfigureShard` objects that can be used to configure each
|
5751
|
+
# shard in a Redis (cluster mode enabled) replication group. The
|
5752
|
+
# `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`,
|
5753
|
+
# and `PreferredAvailabilityZones`.
|
5754
|
+
#
|
5755
|
+
# @option params [required, Boolean] :apply_immediately
|
5756
|
+
# If `True`, the number of replica nodes is increased immediately. If
|
5757
|
+
# `False`, the number of replica nodes is increased during the next
|
5758
|
+
# maintenance window.
|
5759
|
+
#
|
5760
|
+
# @return [Types::IncreaseReplicaCountResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5761
|
+
#
|
5762
|
+
# * {Types::IncreaseReplicaCountResult#replication_group #replication_group} => Types::ReplicationGroup
|
5763
|
+
#
|
5764
|
+
# @example Request syntax with placeholder values
|
5765
|
+
#
|
5766
|
+
# resp = client.increase_replica_count({
|
5767
|
+
# replication_group_id: "String", # required
|
5768
|
+
# new_replica_count: 1,
|
5769
|
+
# replica_configuration: [
|
5770
|
+
# {
|
5771
|
+
# node_group_id: "AllowedNodeGroupId", # required
|
5772
|
+
# new_replica_count: 1, # required
|
5773
|
+
# preferred_availability_zones: ["String"],
|
5774
|
+
# },
|
5775
|
+
# ],
|
5776
|
+
# apply_immediately: false, # required
|
5777
|
+
# })
|
5778
|
+
#
|
5779
|
+
# @example Response structure
|
5780
|
+
#
|
5781
|
+
# resp.replication_group.replication_group_id #=> String
|
5782
|
+
# resp.replication_group.description #=> String
|
5783
|
+
# resp.replication_group.status #=> String
|
5784
|
+
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
5785
|
+
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
5786
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
5787
|
+
# resp.replication_group.member_clusters #=> Array
|
5788
|
+
# resp.replication_group.member_clusters[0] #=> String
|
5789
|
+
# resp.replication_group.node_groups #=> Array
|
5790
|
+
# resp.replication_group.node_groups[0].node_group_id #=> String
|
5791
|
+
# resp.replication_group.node_groups[0].status #=> String
|
5792
|
+
# resp.replication_group.node_groups[0].primary_endpoint.address #=> String
|
5793
|
+
# resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
|
5794
|
+
# resp.replication_group.node_groups[0].slots #=> String
|
5795
|
+
# resp.replication_group.node_groups[0].node_group_members #=> Array
|
5796
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
|
5797
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
|
5798
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
5799
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
5800
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
5801
|
+
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
5802
|
+
# resp.replication_group.snapshotting_cluster_id #=> String
|
5803
|
+
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
5804
|
+
# resp.replication_group.configuration_endpoint.address #=> String
|
5805
|
+
# resp.replication_group.configuration_endpoint.port #=> Integer
|
5806
|
+
# resp.replication_group.snapshot_retention_limit #=> Integer
|
5807
|
+
# resp.replication_group.snapshot_window #=> String
|
5808
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
5809
|
+
# resp.replication_group.cache_node_type #=> String
|
5810
|
+
# resp.replication_group.auth_token_enabled #=> Boolean
|
5811
|
+
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
5812
|
+
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
5813
|
+
#
|
5814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/IncreaseReplicaCount AWS API Documentation
|
5815
|
+
#
|
5816
|
+
# @overload increase_replica_count(params = {})
|
5817
|
+
# @param [Hash] params ({})
|
5818
|
+
def increase_replica_count(params = {}, options = {})
|
5819
|
+
req = build_request(:increase_replica_count, params)
|
5820
|
+
req.send_request(options)
|
5821
|
+
end
|
5822
|
+
|
5598
5823
|
# Lists all available node types that you can scale your Redis
|
5599
5824
|
# cluster's or replication group's current node type up to.
|
5600
5825
|
#
|
@@ -5688,13 +5913,15 @@ module Aws::ElastiCache
|
|
5688
5913
|
# case-sensitive and the value is optional. You can use cost allocation
|
5689
5914
|
# tags to categorize and track your AWS costs.
|
5690
5915
|
#
|
5916
|
+
# If the cluster is not in the *available* state, `ListTagsForResource`
|
5917
|
+
# returns an error.
|
5918
|
+
#
|
5691
5919
|
# You can have a maximum of 50 cost allocation tags on an ElastiCache
|
5692
|
-
# resource. For more information, see [
|
5693
|
-
# Amazon ElastiCache][1].
|
5920
|
+
# resource. For more information, see [Monitoring Costs with Tags][1].
|
5694
5921
|
#
|
5695
5922
|
#
|
5696
5923
|
#
|
5697
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
5924
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html
|
5698
5925
|
#
|
5699
5926
|
# @option params [required, String] :resource_name
|
5700
5927
|
# The Amazon Resource Name (ARN) of the resource for which you want the
|
@@ -5840,7 +6067,7 @@ module Aws::ElastiCache
|
|
5840
6067
|
#
|
5841
6068
|
#
|
5842
6069
|
#
|
5843
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
6070
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNode.Memcached.html
|
5844
6071
|
#
|
5845
6072
|
# @option params [Array<String>] :new_availability_zones
|
5846
6073
|
# The list of Availability Zones where the new Memcached cache nodes are
|
@@ -5922,7 +6149,7 @@ module Aws::ElastiCache
|
|
5922
6149
|
#
|
5923
6150
|
#
|
5924
6151
|
#
|
5925
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
6152
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNode.Memcached.html
|
5926
6153
|
#
|
5927
6154
|
# @option params [Array<String>] :cache_security_group_names
|
5928
6155
|
# A list of cache security group names to authorize on this cluster.
|
@@ -6012,7 +6239,7 @@ module Aws::ElastiCache
|
|
6012
6239
|
#
|
6013
6240
|
#
|
6014
6241
|
#
|
6015
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
6242
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement
|
6016
6243
|
#
|
6017
6244
|
# @option params [Boolean] :auto_minor_version_upgrade
|
6018
6245
|
# This parameter is currently disabled.
|
@@ -6328,14 +6555,25 @@ module Aws::ElastiCache
|
|
6328
6555
|
|
6329
6556
|
# Modifies the settings for a replication group.
|
6330
6557
|
#
|
6331
|
-
#
|
6332
|
-
#
|
6333
|
-
#
|
6558
|
+
# For Redis (cluster mode enabled) clusters, this operation cannot be
|
6559
|
+
# used to change a cluster's node type or engine version. For more
|
6560
|
+
# information, see:
|
6561
|
+
#
|
6562
|
+
# * [Scaling for Amazon ElastiCache for Redis—Redis (cluster mode
|
6563
|
+
# enabled)][1] in the ElastiCache User Guide
|
6564
|
+
#
|
6565
|
+
# * [ModifyReplicationGroupShardConfiguration][2] in the ElastiCache API
|
6566
|
+
# Reference
|
6334
6567
|
#
|
6335
6568
|
# <note markdown="1"> This operation is valid for Redis only.
|
6336
6569
|
#
|
6337
6570
|
# </note>
|
6338
6571
|
#
|
6572
|
+
#
|
6573
|
+
#
|
6574
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html
|
6575
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html
|
6576
|
+
#
|
6339
6577
|
# @option params [required, String] :replication_group_id
|
6340
6578
|
# The identifier of the replication group to modify.
|
6341
6579
|
#
|
@@ -6459,7 +6697,7 @@ module Aws::ElastiCache
|
|
6459
6697
|
#
|
6460
6698
|
#
|
6461
6699
|
#
|
6462
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
6700
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement
|
6463
6701
|
#
|
6464
6702
|
# @option params [Boolean] :auto_minor_version_upgrade
|
6465
6703
|
# This parameter is currently disabled.
|
@@ -6488,7 +6726,7 @@ module Aws::ElastiCache
|
|
6488
6726
|
# to.
|
6489
6727
|
#
|
6490
6728
|
# @option params [String] :node_group_id
|
6491
|
-
#
|
6729
|
+
# Deprecated. This parameter is not used.
|
6492
6730
|
#
|
6493
6731
|
# @return [Types::ModifyReplicationGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6494
6732
|
#
|
@@ -6632,18 +6870,9 @@ module Aws::ElastiCache
|
|
6632
6870
|
req.send_request(options)
|
6633
6871
|
end
|
6634
6872
|
|
6635
|
-
#
|
6636
|
-
#
|
6637
|
-
#
|
6638
|
-
# [Upgrading Engine Versions][1] in the Amazon ElastiCache User Guide.
|
6639
|
-
#
|
6640
|
-
# For more information on ElastiCache for Redis online horizontal
|
6641
|
-
# scaling, see [ElastiCache for Redis Horizontal Scaling][2]
|
6642
|
-
#
|
6643
|
-
#
|
6644
|
-
#
|
6645
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/VersionManagement.html
|
6646
|
-
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/redis-cluster-resharding-online.html
|
6873
|
+
# Modifies a replication group's shards (node groups) by allowing you
|
6874
|
+
# to add shards, remove shards, or rebalance the keyspaces among
|
6875
|
+
# exisiting shards.
|
6647
6876
|
#
|
6648
6877
|
# @option params [required, String] :replication_group_id
|
6649
6878
|
# The name of the Redis (cluster mode enabled) cluster (replication
|
@@ -6671,8 +6900,21 @@ module Aws::ElastiCache
|
|
6671
6900
|
#
|
6672
6901
|
# @option params [Array<String>] :node_groups_to_remove
|
6673
6902
|
# If the value of `NodeGroupCount` is less than the current number of
|
6674
|
-
# node groups (shards), `NodeGroupsToRemove`
|
6675
|
-
# group ids to remove from the
|
6903
|
+
# node groups (shards), the `NodeGroupsToRemove` or `NodeGroupsToRetain`
|
6904
|
+
# is a required list of node group ids to remove from or retain in the
|
6905
|
+
# cluster.
|
6906
|
+
#
|
6907
|
+
# ElastiCache for Redis will attempt to remove all node groups listed by
|
6908
|
+
# `NodeGroupsToRemove` from the cluster.
|
6909
|
+
#
|
6910
|
+
# @option params [Array<String>] :node_groups_to_retain
|
6911
|
+
# If the value of `NodeGroupCount` is less than the current number of
|
6912
|
+
# node groups (shards), the `NodeGroupsToRemove` or `NodeGroupsToRetain`
|
6913
|
+
# is a required list of node group ids to remove from or retain in the
|
6914
|
+
# cluster.
|
6915
|
+
#
|
6916
|
+
# ElastiCache for Redis will attempt to remove all node groups except
|
6917
|
+
# those listed by `NodeGroupsToRetain` from the cluster.
|
6676
6918
|
#
|
6677
6919
|
# @return [Types::ModifyReplicationGroupShardConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6678
6920
|
#
|
@@ -6686,10 +6928,12 @@ module Aws::ElastiCache
|
|
6686
6928
|
# apply_immediately: false, # required
|
6687
6929
|
# resharding_configuration: [
|
6688
6930
|
# {
|
6931
|
+
# node_group_id: "AllowedNodeGroupId",
|
6689
6932
|
# preferred_availability_zones: ["String"],
|
6690
6933
|
# },
|
6691
6934
|
# ],
|
6692
|
-
# node_groups_to_remove: ["
|
6935
|
+
# node_groups_to_remove: ["AllowedNodeGroupId"],
|
6936
|
+
# node_groups_to_retain: ["AllowedNodeGroupId"],
|
6693
6937
|
# })
|
6694
6938
|
#
|
6695
6939
|
# @example Response structure
|
@@ -6796,6 +7040,7 @@ module Aws::ElastiCache
|
|
6796
7040
|
# resp.reserved_cache_node.recurring_charges #=> Array
|
6797
7041
|
# resp.reserved_cache_node.recurring_charges[0].recurring_charge_amount #=> Float
|
6798
7042
|
# resp.reserved_cache_node.recurring_charges[0].recurring_charge_frequency #=> String
|
7043
|
+
# resp.reserved_cache_node.reservation_arn #=> String
|
6799
7044
|
#
|
6800
7045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering AWS API Documentation
|
6801
7046
|
#
|
@@ -6827,7 +7072,7 @@ module Aws::ElastiCache
|
|
6827
7072
|
#
|
6828
7073
|
#
|
6829
7074
|
#
|
6830
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
7075
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html
|
6831
7076
|
#
|
6832
7077
|
# @option params [required, String] :cache_cluster_id
|
6833
7078
|
# The cluster identifier. This parameter is stored as a lowercase
|
@@ -7213,9 +7458,9 @@ module Aws::ElastiCache
|
|
7213
7458
|
#
|
7214
7459
|
#
|
7215
7460
|
#
|
7216
|
-
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
7461
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html
|
7217
7462
|
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html
|
7218
|
-
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/
|
7463
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test
|
7219
7464
|
#
|
7220
7465
|
# @option params [required, String] :replication_group_id
|
7221
7466
|
# The name of the replication group (console: cluster) whose automatic
|
@@ -7235,7 +7480,7 @@ module Aws::ElastiCache
|
|
7235
7480
|
#
|
7236
7481
|
# resp = client.test_failover({
|
7237
7482
|
# replication_group_id: "String", # required
|
7238
|
-
# node_group_id: "
|
7483
|
+
# node_group_id: "AllowedNodeGroupId", # required
|
7239
7484
|
# })
|
7240
7485
|
#
|
7241
7486
|
# @example Response structure
|
@@ -7295,7 +7540,7 @@ module Aws::ElastiCache
|
|
7295
7540
|
params: params,
|
7296
7541
|
config: config)
|
7297
7542
|
context[:gem_name] = 'aws-sdk-elasticache'
|
7298
|
-
context[:gem_version] = '1.
|
7543
|
+
context[:gem_version] = '1.7.0'
|
7299
7544
|
Seahorse::Client::Request.new(handlers, context)
|
7300
7545
|
end
|
7301
7546
|
|