aws-sdk-elasticache 1.2.0 → 1.3.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 +273 -178
- data/lib/aws-sdk-elasticache/client_api.rb +48 -0
- data/lib/aws-sdk-elasticache/types.rb +358 -257
- 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: 3a51809ecc6a163ff1fd1f4bee2564c63d73c8ab
|
4
|
+
data.tar.gz: 0e785a69a7995e175eae6c5c4d6786cdf67515e6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a1b0d48adaa46b7478fdc98a88bb60ddd478611c19822940d5f7ee22c351b8e2a527c6121e0834e368c5c82678b4a3a7a273a5d89194d04c9f117eca294a0f5
|
7
|
+
data.tar.gz: fa48a22578797c178cd9a6880461d291b625516e8d6f0a4baa8c91f1278930a46b26b32fd54cfebabcc0f212a4033c9be785a6b203651f5e57b40d2397c4e127
|
data/lib/aws-sdk-elasticache.rb
CHANGED
@@ -167,6 +167,7 @@ module Aws::ElastiCache
|
|
167
167
|
# to be added, for example
|
168
168
|
# `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or
|
169
169
|
# `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.
|
170
|
+
# ElastiCache resources are *cluster* and *snapshot*.
|
170
171
|
#
|
171
172
|
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
172
173
|
# AWS Service Namespaces][1].
|
@@ -512,7 +513,7 @@ module Aws::ElastiCache
|
|
512
513
|
req.send_request(options)
|
513
514
|
end
|
514
515
|
|
515
|
-
# Creates a
|
516
|
+
# Creates a cluster. All nodes in the cluster run the same
|
516
517
|
# protocol-compliant cache engine software, either Memcached or Redis.
|
517
518
|
#
|
518
519
|
# Due to current limitations on Redis (cluster mode disabled), this
|
@@ -536,14 +537,13 @@ module Aws::ElastiCache
|
|
536
537
|
# operation or parameter is not supported on Redis (cluster mode
|
537
538
|
# enabled) replication groups.
|
538
539
|
#
|
539
|
-
# The ID of the replication group to which this
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
# replication group.
|
540
|
+
# The ID of the replication group to which this cluster should belong.
|
541
|
+
# If this parameter is specified, the cluster is added to the specified
|
542
|
+
# replication group as a read replica; otherwise, the cluster is a
|
543
|
+
# standalone primary that is not part of any replication group.
|
544
544
|
#
|
545
545
|
# If the specified replication group is Multi-AZ enabled and the
|
546
|
-
# Availability Zone is not specified, the
|
546
|
+
# Availability Zone is not specified, the cluster is created in
|
547
547
|
# Availability Zones that provide the best spread of read replicas
|
548
548
|
# across Availability Zones.
|
549
549
|
#
|
@@ -556,15 +556,15 @@ module Aws::ElastiCache
|
|
556
556
|
# single Availability Zone or created across multiple Availability Zones
|
557
557
|
# in the cluster's region.
|
558
558
|
#
|
559
|
-
# This parameter is only supported for Memcached
|
559
|
+
# This parameter is only supported for Memcached clusters.
|
560
560
|
#
|
561
561
|
# If the `AZMode` and `PreferredAvailabilityZones` are not specified,
|
562
562
|
# ElastiCache assumes `single-az` mode.
|
563
563
|
#
|
564
564
|
# @option params [String] :preferred_availability_zone
|
565
|
-
# The EC2 Availability Zone in which the
|
565
|
+
# The EC2 Availability Zone in which the cluster is created.
|
566
566
|
#
|
567
|
-
# All nodes belonging to this Memcached
|
567
|
+
# All nodes belonging to this Memcached cluster are placed in the
|
568
568
|
# preferred Availability Zone. If you want to create your nodes across
|
569
569
|
# multiple Availability Zones, use `PreferredAvailabilityZones`.
|
570
570
|
#
|
@@ -576,9 +576,9 @@ module Aws::ElastiCache
|
|
576
576
|
#
|
577
577
|
# This option is only supported on Memcached.
|
578
578
|
#
|
579
|
-
# <note markdown="1"> If you are creating your
|
580
|
-
#
|
581
|
-
#
|
579
|
+
# <note markdown="1"> If you are creating your cluster in an Amazon VPC (recommended) you
|
580
|
+
# can only locate nodes in Availability Zones that are associated with
|
581
|
+
# the subnets in the selected subnet group.
|
582
582
|
#
|
583
583
|
# The number of Availability Zones listed must equal the value of
|
584
584
|
# `NumCacheNodes`.
|
@@ -592,7 +592,7 @@ module Aws::ElastiCache
|
|
592
592
|
# Default: System chosen Availability Zones.
|
593
593
|
#
|
594
594
|
# @option params [Integer] :num_cache_nodes
|
595
|
-
# The initial number of cache nodes that the
|
595
|
+
# The initial number of cache nodes that the cluster has.
|
596
596
|
#
|
597
597
|
# For clusters running Redis, this value must be 1. For clusters running
|
598
598
|
# Memcached, this value must be between 1 and 20.
|
@@ -666,9 +666,6 @@ module Aws::ElastiCache
|
|
666
666
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
667
667
|
# or T2 instances.
|
668
668
|
#
|
669
|
-
# Supported node types are available in all regions except as noted in
|
670
|
-
# the following table.
|
671
|
-
#
|
672
669
|
# For a complete listing of node types and specifications, see [Amazon
|
673
670
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
674
671
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -681,36 +678,36 @@ module Aws::ElastiCache
|
|
681
678
|
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
682
679
|
#
|
683
680
|
# @option params [String] :engine
|
684
|
-
# The name of the cache engine to be used for this
|
681
|
+
# The name of the cache engine to be used for this cluster.
|
685
682
|
#
|
686
683
|
# Valid values for this parameter are: `memcached` \| `redis`
|
687
684
|
#
|
688
685
|
# @option params [String] :engine_version
|
689
|
-
# The version number of the cache engine to be used for this
|
690
|
-
#
|
686
|
+
# The version number of the cache engine to be used for this cluster. To
|
687
|
+
# view the supported cache engine versions, use the
|
691
688
|
# DescribeCacheEngineVersions operation.
|
692
689
|
#
|
693
690
|
# **Important:** You can upgrade to a newer engine version (see
|
694
691
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
695
692
|
# to an earlier engine version. If you want to use an earlier engine
|
696
|
-
# version, you must delete the existing
|
697
|
-
#
|
693
|
+
# version, you must delete the existing cluster or replication group and
|
694
|
+
# create it anew with the earlier engine version.
|
698
695
|
#
|
699
696
|
#
|
700
697
|
#
|
701
698
|
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html#VersionManagement
|
702
699
|
#
|
703
700
|
# @option params [String] :cache_parameter_group_name
|
704
|
-
# The name of the parameter group to associate with this
|
705
|
-
#
|
701
|
+
# The name of the parameter group to associate with this cluster. If
|
702
|
+
# this argument is omitted, the default parameter group for the
|
706
703
|
# specified engine is used. You cannot use any parameter group which has
|
707
704
|
# `cluster-enabled='yes'` when creating a cluster.
|
708
705
|
#
|
709
706
|
# @option params [String] :cache_subnet_group_name
|
710
|
-
# The name of the subnet group to be used for the
|
707
|
+
# The name of the subnet group to be used for the cluster.
|
711
708
|
#
|
712
|
-
# Use this parameter only when you are creating a
|
713
|
-
#
|
709
|
+
# Use this parameter only when you are creating a cluster in an Amazon
|
710
|
+
# Virtual Private Cloud (Amazon VPC).
|
714
711
|
#
|
715
712
|
# If you're going to launch your cluster in an Amazon VPC, you need to
|
716
713
|
# create a subnet group before you start creating a cluster. For more
|
@@ -721,16 +718,16 @@ module Aws::ElastiCache
|
|
721
718
|
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SubnetGroups.html
|
722
719
|
#
|
723
720
|
# @option params [Array<String>] :cache_security_group_names
|
724
|
-
# A list of security group names to associate with this
|
721
|
+
# A list of security group names to associate with this cluster.
|
725
722
|
#
|
726
|
-
# Use this parameter only when you are creating a
|
727
|
-
#
|
723
|
+
# Use this parameter only when you are creating a cluster outside of an
|
724
|
+
# Amazon Virtual Private Cloud (Amazon VPC).
|
728
725
|
#
|
729
726
|
# @option params [Array<String>] :security_group_ids
|
730
|
-
# One or more VPC security groups associated with the
|
727
|
+
# One or more VPC security groups associated with the cluster.
|
731
728
|
#
|
732
|
-
# Use this parameter only when you are creating a
|
733
|
-
#
|
729
|
+
# Use this parameter only when you are creating a cluster in an Amazon
|
730
|
+
# Virtual Private Cloud (Amazon VPC).
|
734
731
|
#
|
735
732
|
# @option params [Array<Types::Tag>] :tags
|
736
733
|
# A list of cost allocation tags to be added to this resource.
|
@@ -757,7 +754,7 @@ module Aws::ElastiCache
|
|
757
754
|
# </note>
|
758
755
|
#
|
759
756
|
# @option params [String] :preferred_maintenance_window
|
760
|
-
# Specifies the weekly time range during which maintenance on the
|
757
|
+
# Specifies the weekly time range during which maintenance on the
|
761
758
|
# cluster is performed. It is specified as a range in the format
|
762
759
|
# ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
|
763
760
|
# window is a 60 minute period. Valid values for `ddd` are:
|
@@ -792,8 +789,7 @@ module Aws::ElastiCache
|
|
792
789
|
# The Amazon Resource Name (ARN) of the Amazon Simple Notification
|
793
790
|
# Service (SNS) topic to which notifications are sent.
|
794
791
|
#
|
795
|
-
# <note markdown="1"> The Amazon SNS topic owner must be the same as the
|
796
|
-
# owner.
|
792
|
+
# <note markdown="1"> The Amazon SNS topic owner must be the same as the cluster owner.
|
797
793
|
#
|
798
794
|
# </note>
|
799
795
|
#
|
@@ -810,8 +806,7 @@ module Aws::ElastiCache
|
|
810
806
|
#
|
811
807
|
# </note>
|
812
808
|
#
|
813
|
-
# Default: 0 (i.e., automatic backups are disabled for this
|
814
|
-
# cluster).
|
809
|
+
# Default: 0 (i.e., automatic backups are disabled for this cluster).
|
815
810
|
#
|
816
811
|
# @option params [String] :snapshot_window
|
817
812
|
# The daily time range (in UTC) during which ElastiCache begins taking a
|
@@ -830,6 +825,13 @@ module Aws::ElastiCache
|
|
830
825
|
# **Reserved parameter.** The password used to access a password
|
831
826
|
# protected server.
|
832
827
|
#
|
828
|
+
# This parameter is valid only if:
|
829
|
+
#
|
830
|
+
# * The parameter `TransitEncryptionEnabled` was set to `true` when the
|
831
|
+
# cluster was created.
|
832
|
+
#
|
833
|
+
# * The line `requirepass` was added to the database configuration file.
|
834
|
+
#
|
833
835
|
# Password constraints:
|
834
836
|
#
|
835
837
|
# * Must be only printable ASCII characters.
|
@@ -1033,8 +1035,8 @@ module Aws::ElastiCache
|
|
1033
1035
|
|
1034
1036
|
# Creates a new Amazon ElastiCache cache parameter group. An ElastiCache
|
1035
1037
|
# cache parameter group is a collection of parameters and their values
|
1036
|
-
# that are applied to all of the nodes in any
|
1037
|
-
#
|
1038
|
+
# that are applied to all of the nodes in any cluster or replication
|
1039
|
+
# group using the CacheParameterGroup.
|
1038
1040
|
#
|
1039
1041
|
# A newly created CacheParameterGroup is an exact duplicate of the
|
1040
1042
|
# default parameter group for the CacheParameterGroupFamily. To
|
@@ -1111,12 +1113,12 @@ module Aws::ElastiCache
|
|
1111
1113
|
end
|
1112
1114
|
|
1113
1115
|
# Creates a new cache security group. Use a cache security group to
|
1114
|
-
# control access to one or more
|
1116
|
+
# control access to one or more clusters.
|
1115
1117
|
#
|
1116
|
-
# Cache security groups are only used when you are creating a
|
1117
|
-
#
|
1118
|
-
#
|
1119
|
-
#
|
1118
|
+
# Cache security groups are only used when you are creating a cluster
|
1119
|
+
# outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are
|
1120
|
+
# creating a cluster inside of a VPC, use a cache subnet group instead.
|
1121
|
+
# For more information, see [CreateCacheSubnetGroup][1].
|
1120
1122
|
#
|
1121
1123
|
#
|
1122
1124
|
#
|
@@ -1272,9 +1274,9 @@ module Aws::ElastiCache
|
|
1272
1274
|
# enabled) replication group.
|
1273
1275
|
#
|
1274
1276
|
# A Redis (cluster mode disabled) replication group is a collection of
|
1275
|
-
#
|
1276
|
-
#
|
1277
|
-
#
|
1277
|
+
# clusters, where one of the clusters is a read/write primary and the
|
1278
|
+
# others are read-only replicas. Writes to the primary are
|
1279
|
+
# asynchronously propagated to the replicas.
|
1278
1280
|
#
|
1279
1281
|
# A Redis (cluster mode enabled) replication group is a collection of 1
|
1280
1282
|
# to 15 node groups (shards). Each node group (shard) has one read/write
|
@@ -1316,9 +1318,9 @@ module Aws::ElastiCache
|
|
1316
1318
|
# A user-created description for the replication group.
|
1317
1319
|
#
|
1318
1320
|
# @option params [String] :primary_cluster_id
|
1319
|
-
# The identifier of the
|
1320
|
-
#
|
1321
|
-
#
|
1321
|
+
# The identifier of the cluster that serves as the primary for this
|
1322
|
+
# replication group. This cluster must already exist and have a status
|
1323
|
+
# of `available`.
|
1322
1324
|
#
|
1323
1325
|
# This parameter is not required if `NumCacheClusters`, `NumNodeGroups`,
|
1324
1326
|
# or `ReplicasPerNodeGroup` is specified.
|
@@ -1360,16 +1362,16 @@ module Aws::ElastiCache
|
|
1360
1362
|
#
|
1361
1363
|
# @option params [Array<String>] :preferred_cache_cluster_a_zs
|
1362
1364
|
# A list of EC2 Availability Zones in which the replication group's
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1365
|
+
# clusters are created. The order of the Availability Zones in the list
|
1366
|
+
# is the order in which clusters are allocated. The primary cluster is
|
1367
|
+
# created in the first AZ in the list.
|
1366
1368
|
#
|
1367
1369
|
# This parameter is not used if there is more than one node group
|
1368
1370
|
# (shard). You should use `NodeGroupConfiguration` instead.
|
1369
1371
|
#
|
1370
1372
|
# <note markdown="1"> If you are creating your replication group in an Amazon VPC
|
1371
|
-
# (recommended), you can only locate
|
1372
|
-
#
|
1373
|
+
# (recommended), you can only locate clusters in Availability Zones
|
1374
|
+
# associated with the subnets in the selected subnet group.
|
1373
1375
|
#
|
1374
1376
|
# The number of Availability Zones listed must equal the value of
|
1375
1377
|
# `NumCacheClusters`.
|
@@ -1461,9 +1463,6 @@ module Aws::ElastiCache
|
|
1461
1463
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
1462
1464
|
# or T2 instances.
|
1463
1465
|
#
|
1464
|
-
# Supported node types are available in all regions except as noted in
|
1465
|
-
# the following table.
|
1466
|
-
#
|
1467
1466
|
# For a complete listing of node types and specifications, see [Amazon
|
1468
1467
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
1469
1468
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -1476,19 +1475,19 @@ module Aws::ElastiCache
|
|
1476
1475
|
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific
|
1477
1476
|
#
|
1478
1477
|
# @option params [String] :engine
|
1479
|
-
# The name of the cache engine to be used for the
|
1478
|
+
# The name of the cache engine to be used for the clusters in this
|
1480
1479
|
# replication group.
|
1481
1480
|
#
|
1482
1481
|
# @option params [String] :engine_version
|
1483
|
-
# The version number of the cache engine to be used for the
|
1484
|
-
#
|
1485
|
-
#
|
1482
|
+
# The version number of the cache engine to be used for the clusters in
|
1483
|
+
# this replication group. To view the supported cache engine versions,
|
1484
|
+
# use the `DescribeCacheEngineVersions` operation.
|
1486
1485
|
#
|
1487
1486
|
# **Important:** You can upgrade to a newer engine version (see
|
1488
1487
|
# [Selecting a Cache Engine and Version][1]) in the *ElastiCache User
|
1489
1488
|
# Guide*, but you cannot downgrade to an earlier engine version. If you
|
1490
1489
|
# want to use an earlier engine version, you must delete the existing
|
1491
|
-
#
|
1490
|
+
# cluster or replication group and create it anew with the earlier
|
1492
1491
|
# engine version.
|
1493
1492
|
#
|
1494
1493
|
#
|
@@ -1535,7 +1534,8 @@ module Aws::ElastiCache
|
|
1535
1534
|
#
|
1536
1535
|
# @option params [Array<Types::Tag>] :tags
|
1537
1536
|
# A list of cost allocation tags to be added to this resource. A tag is
|
1538
|
-
# a key-value pair.
|
1537
|
+
# a key-value pair. A tag key does not have to be accompanied by a tag
|
1538
|
+
# value.
|
1539
1539
|
#
|
1540
1540
|
# @option params [Array<String>] :snapshot_arns
|
1541
1541
|
# A list of Amazon Resource Names (ARN) that uniquely identify the Redis
|
@@ -1555,7 +1555,7 @@ module Aws::ElastiCache
|
|
1555
1555
|
# the new replication group is being created.
|
1556
1556
|
#
|
1557
1557
|
# @option params [String] :preferred_maintenance_window
|
1558
|
-
# Specifies the weekly time range during which maintenance on the
|
1558
|
+
# Specifies the weekly time range during which maintenance on the
|
1559
1559
|
# cluster is performed. It is specified as a range in the format
|
1560
1560
|
# ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
|
1561
1561
|
# window is a 60 minute period. Valid values for `ddd` are:
|
@@ -1591,8 +1591,7 @@ module Aws::ElastiCache
|
|
1591
1591
|
# The Amazon Resource Name (ARN) of the Amazon Simple Notification
|
1592
1592
|
# Service (SNS) topic to which notifications are sent.
|
1593
1593
|
#
|
1594
|
-
# <note markdown="1"> The Amazon SNS topic owner must be the same as the
|
1595
|
-
# owner.
|
1594
|
+
# <note markdown="1"> The Amazon SNS topic owner must be the same as the cluster owner.
|
1596
1595
|
#
|
1597
1596
|
# </note>
|
1598
1597
|
#
|
@@ -1605,8 +1604,7 @@ module Aws::ElastiCache
|
|
1605
1604
|
# to 5, a snapshot that was taken today is retained for 5 days before
|
1606
1605
|
# being deleted.
|
1607
1606
|
#
|
1608
|
-
# Default: 0 (i.e., automatic backups are disabled for this
|
1609
|
-
# cluster).
|
1607
|
+
# Default: 0 (i.e., automatic backups are disabled for this cluster).
|
1610
1608
|
#
|
1611
1609
|
# @option params [String] :snapshot_window
|
1612
1610
|
# The daily time range (in UTC) during which ElastiCache begins taking a
|
@@ -1824,6 +1822,7 @@ module Aws::ElastiCache
|
|
1824
1822
|
# resp.replication_group.status #=> String
|
1825
1823
|
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
1826
1824
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
1825
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
1827
1826
|
# resp.replication_group.member_clusters #=> Array
|
1828
1827
|
# resp.replication_group.member_clusters[0] #=> String
|
1829
1828
|
# resp.replication_group.node_groups #=> Array
|
@@ -1860,8 +1859,8 @@ module Aws::ElastiCache
|
|
1860
1859
|
req.send_request(options)
|
1861
1860
|
end
|
1862
1861
|
|
1863
|
-
# Creates a copy of an entire
|
1864
|
-
#
|
1862
|
+
# Creates a copy of an entire cluster or replication group at a specific
|
1863
|
+
# moment in time.
|
1865
1864
|
#
|
1866
1865
|
# <note markdown="1"> This operation is valid for Redis only.
|
1867
1866
|
#
|
@@ -1872,8 +1871,8 @@ module Aws::ElastiCache
|
|
1872
1871
|
# created from this replication group.
|
1873
1872
|
#
|
1874
1873
|
# @option params [String] :cache_cluster_id
|
1875
|
-
# The identifier of an existing
|
1876
|
-
#
|
1874
|
+
# The identifier of an existing cluster. The snapshot is created from
|
1875
|
+
# this cluster.
|
1877
1876
|
#
|
1878
1877
|
# @option params [required, String] :snapshot_name
|
1879
1878
|
# A name for the snapshot being created.
|
@@ -2062,29 +2061,29 @@ module Aws::ElastiCache
|
|
2062
2061
|
req.send_request(options)
|
2063
2062
|
end
|
2064
2063
|
|
2065
|
-
# Deletes a previously provisioned
|
2066
|
-
#
|
2067
|
-
#
|
2068
|
-
#
|
2069
|
-
#
|
2064
|
+
# Deletes a previously provisioned cluster. `DeleteCacheCluster` deletes
|
2065
|
+
# all associated cache nodes, node endpoints and the cluster itself.
|
2066
|
+
# When you receive a successful response from this operation, Amazon
|
2067
|
+
# ElastiCache immediately begins deleting the cluster; you cannot cancel
|
2068
|
+
# or revert this operation.
|
2070
2069
|
#
|
2071
|
-
# This operation cannot be used to delete a
|
2072
|
-
#
|
2073
|
-
#
|
2074
|
-
#
|
2070
|
+
# This operation cannot be used to delete a cluster that is the last
|
2071
|
+
# read replica of a replication group or node group (shard) that has
|
2072
|
+
# Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled)
|
2073
|
+
# replication group.
|
2075
2074
|
#
|
2076
2075
|
# Due to current limitations on Redis (cluster mode disabled), this
|
2077
2076
|
# operation or parameter is not supported on Redis (cluster mode
|
2078
2077
|
# enabled) replication groups.
|
2079
2078
|
#
|
2080
2079
|
# @option params [required, String] :cache_cluster_id
|
2081
|
-
# The
|
2082
|
-
#
|
2080
|
+
# The cluster identifier for the cluster to be deleted. This parameter
|
2081
|
+
# is not case sensitive.
|
2083
2082
|
#
|
2084
2083
|
# @option params [String] :final_snapshot_identifier
|
2085
|
-
# The user-supplied name of a final
|
2086
|
-
#
|
2087
|
-
#
|
2084
|
+
# The user-supplied name of a final cluster snapshot. This is the unique
|
2085
|
+
# name that identifies the snapshot. ElastiCache creates the snapshot,
|
2086
|
+
# and then deletes the cluster immediately afterward.
|
2088
2087
|
#
|
2089
2088
|
# @return [Types::DeleteCacheClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2090
2089
|
#
|
@@ -2203,7 +2202,7 @@ module Aws::ElastiCache
|
|
2203
2202
|
# The name of the cache parameter group to delete.
|
2204
2203
|
#
|
2205
2204
|
# <note markdown="1"> The specified cache security group must not be associated with any
|
2206
|
-
#
|
2205
|
+
# clusters.
|
2207
2206
|
#
|
2208
2207
|
# </note>
|
2209
2208
|
#
|
@@ -2236,7 +2235,7 @@ module Aws::ElastiCache
|
|
2236
2235
|
# Deletes a cache security group.
|
2237
2236
|
#
|
2238
2237
|
# <note markdown="1"> You cannot delete a cache security group if it is associated with any
|
2239
|
-
#
|
2238
|
+
# clusters.
|
2240
2239
|
#
|
2241
2240
|
# </note>
|
2242
2241
|
#
|
@@ -2276,7 +2275,7 @@ module Aws::ElastiCache
|
|
2276
2275
|
# Deletes a cache subnet group.
|
2277
2276
|
#
|
2278
2277
|
# <note markdown="1"> You cannot delete a cache subnet group if it is associated with any
|
2279
|
-
#
|
2278
|
+
# clusters.
|
2280
2279
|
#
|
2281
2280
|
# </note>
|
2282
2281
|
#
|
@@ -2382,6 +2381,7 @@ module Aws::ElastiCache
|
|
2382
2381
|
# resp.replication_group.status #=> String
|
2383
2382
|
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
2384
2383
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
2384
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
2385
2385
|
# resp.replication_group.member_clusters #=> Array
|
2386
2386
|
# resp.replication_group.member_clusters[0] #=> String
|
2387
2387
|
# resp.replication_group.node_groups #=> Array
|
@@ -2527,15 +2527,14 @@ module Aws::ElastiCache
|
|
2527
2527
|
req.send_request(options)
|
2528
2528
|
end
|
2529
2529
|
|
2530
|
-
# Returns information about all provisioned
|
2531
|
-
#
|
2532
|
-
#
|
2530
|
+
# Returns information about all provisioned clusters if no cluster
|
2531
|
+
# identifier is specified, or about a specific cache cluster if a
|
2532
|
+
# cluster identifier is supplied.
|
2533
2533
|
#
|
2534
|
-
# By default, abbreviated information about the
|
2535
|
-
#
|
2536
|
-
#
|
2537
|
-
#
|
2538
|
-
# the cache node endpoint.
|
2534
|
+
# By default, abbreviated information about the clusters is returned.
|
2535
|
+
# You can use the optional *ShowCacheNodeInfo* flag to retrieve detailed
|
2536
|
+
# information about the cache nodes associated with the clusters. These
|
2537
|
+
# details include the DNS address and port for the cache node endpoint.
|
2539
2538
|
#
|
2540
2539
|
# If the cluster is in the *creating* state, only cluster-level
|
2541
2540
|
# information is displayed until all of the nodes are successfully
|
@@ -2544,17 +2543,17 @@ module Aws::ElastiCache
|
|
2544
2543
|
# If the cluster is in the *deleting* state, only cluster-level
|
2545
2544
|
# information is displayed.
|
2546
2545
|
#
|
2547
|
-
# If cache nodes are currently being added to the
|
2548
|
-
#
|
2549
|
-
#
|
2550
|
-
#
|
2546
|
+
# If cache nodes are currently being added to the cluster, node endpoint
|
2547
|
+
# information and creation time for the additional nodes are not
|
2548
|
+
# displayed until they are completely provisioned. When the cluster
|
2549
|
+
# state is *available*, the cluster is ready for use.
|
2551
2550
|
#
|
2552
|
-
# If cache nodes are currently being removed from the
|
2551
|
+
# If cache nodes are currently being removed from the cluster, no
|
2553
2552
|
# endpoint information for the removed nodes is displayed.
|
2554
2553
|
#
|
2555
2554
|
# @option params [String] :cache_cluster_id
|
2556
2555
|
# The user-supplied cluster identifier. If this parameter is specified,
|
2557
|
-
# only information about that specific
|
2556
|
+
# only information about that specific cluster is returned. This
|
2558
2557
|
# parameter isn't case sensitive.
|
2559
2558
|
#
|
2560
2559
|
# @option params [Integer] :max_records
|
@@ -4426,10 +4425,10 @@ module Aws::ElastiCache
|
|
4426
4425
|
req.send_request(options)
|
4427
4426
|
end
|
4428
4427
|
|
4429
|
-
# Returns events related to
|
4430
|
-
#
|
4431
|
-
#
|
4432
|
-
#
|
4428
|
+
# Returns events related to clusters, cache security groups, and cache
|
4429
|
+
# parameter groups. You can obtain events specific to a particular
|
4430
|
+
# cluster, cache security group, or cache parameter group by providing
|
4431
|
+
# the name as a parameter.
|
4433
4432
|
#
|
4434
4433
|
# By default, only the events occurring within the last hour are
|
4435
4434
|
# returned; however, you can retrieve up to 14 days' worth of events if
|
@@ -4723,6 +4722,7 @@ module Aws::ElastiCache
|
|
4723
4722
|
# resp.replication_groups[0].status #=> String
|
4724
4723
|
# resp.replication_groups[0].pending_modified_values.primary_cluster_id #=> String
|
4725
4724
|
# resp.replication_groups[0].pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
4725
|
+
# resp.replication_groups[0].pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
4726
4726
|
# resp.replication_groups[0].member_clusters #=> Array
|
4727
4727
|
# resp.replication_groups[0].member_clusters[0] #=> String
|
4728
4728
|
# resp.replication_groups[0].node_groups #=> Array
|
@@ -4831,9 +4831,6 @@ module Aws::ElastiCache
|
|
4831
4831
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
4832
4832
|
# or T2 instances.
|
4833
4833
|
#
|
4834
|
-
# Supported node types are available in all regions except as noted in
|
4835
|
-
# the following table.
|
4836
|
-
#
|
4837
4834
|
# For a complete listing of node types and specifications, see [Amazon
|
4838
4835
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
4839
4836
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -5004,9 +5001,6 @@ module Aws::ElastiCache
|
|
5004
5001
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
5005
5002
|
# or T2 instances.
|
5006
5003
|
#
|
5007
|
-
# Supported node types are available in all regions except as noted in
|
5008
|
-
# the following table.
|
5009
|
-
#
|
5010
5004
|
# For a complete listing of node types and specifications, see [Amazon
|
5011
5005
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
5012
5006
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -5412,10 +5406,10 @@ module Aws::ElastiCache
|
|
5412
5406
|
req.send_request(options)
|
5413
5407
|
end
|
5414
5408
|
|
5415
|
-
# Returns information about
|
5416
|
-
#
|
5417
|
-
#
|
5418
|
-
#
|
5409
|
+
# Returns information about cluster or replication group snapshots. By
|
5410
|
+
# default, `DescribeSnapshots` lists all of your snapshots; it can
|
5411
|
+
# optionally describe a single snapshot, or just the snapshots
|
5412
|
+
# associated with a particular cache cluster.
|
5419
5413
|
#
|
5420
5414
|
# <note markdown="1"> This operation is valid for Redis only.
|
5421
5415
|
#
|
@@ -5428,8 +5422,7 @@ module Aws::ElastiCache
|
|
5428
5422
|
#
|
5429
5423
|
# @option params [String] :cache_cluster_id
|
5430
5424
|
# A user-supplied cluster identifier. If this parameter is specified,
|
5431
|
-
# only snapshots associated with that specific
|
5432
|
-
# described.
|
5425
|
+
# only snapshots associated with that specific cluster are described.
|
5433
5426
|
#
|
5434
5427
|
# @option params [String] :snapshot_name
|
5435
5428
|
# A user-supplied name of the snapshot. If this parameter is specified,
|
@@ -5580,7 +5573,7 @@ module Aws::ElastiCache
|
|
5580
5573
|
# by this operation.
|
5581
5574
|
#
|
5582
5575
|
# @option params [String] :cache_cluster_id
|
5583
|
-
# The name of the
|
5576
|
+
# The name of the cluster you want to scale up to a larger node
|
5584
5577
|
# instanced type. ElastiCache uses the cluster id to identify the
|
5585
5578
|
# current node type of this cluster and from that to create a list of
|
5586
5579
|
# node types you can scale up to.
|
@@ -5734,22 +5727,21 @@ module Aws::ElastiCache
|
|
5734
5727
|
req.send_request(options)
|
5735
5728
|
end
|
5736
5729
|
|
5737
|
-
# Modifies the settings for a
|
5738
|
-
#
|
5739
|
-
#
|
5730
|
+
# Modifies the settings for a cluster. You can use this operation to
|
5731
|
+
# change one or more cluster configuration parameters by specifying the
|
5732
|
+
# parameters and the new values.
|
5740
5733
|
#
|
5741
5734
|
# @option params [required, String] :cache_cluster_id
|
5742
|
-
# The
|
5743
|
-
# string.
|
5735
|
+
# The cluster identifier. This value is stored as a lowercase string.
|
5744
5736
|
#
|
5745
5737
|
# @option params [Integer] :num_cache_nodes
|
5746
|
-
# The number of cache nodes that the
|
5747
|
-
#
|
5748
|
-
#
|
5749
|
-
#
|
5750
|
-
#
|
5751
|
-
#
|
5752
|
-
#
|
5738
|
+
# The number of cache nodes that the cluster should have. If the value
|
5739
|
+
# for `NumCacheNodes` is greater than the sum of the number of current
|
5740
|
+
# cache nodes and the number of cache nodes pending creation (which may
|
5741
|
+
# be zero), more nodes are added. If the value is less than the number
|
5742
|
+
# of existing cache nodes, nodes are removed. If the value is equal to
|
5743
|
+
# the number of current cache nodes, any pending add or remove requests
|
5744
|
+
# are canceled.
|
5753
5745
|
#
|
5754
5746
|
# If you are removing cache nodes, you must use the
|
5755
5747
|
# `CacheNodeIdsToRemove` parameter to provide the IDs of the specific
|
@@ -5777,7 +5769,7 @@ module Aws::ElastiCache
|
|
5777
5769
|
# cancel the pending request and retry the new request. To cancel
|
5778
5770
|
# pending operations to modify the number of cache nodes in a cluster,
|
5779
5771
|
# use the `ModifyCacheCluster` request and set `NumCacheNodes` equal to
|
5780
|
-
# the number of cache nodes currently in the
|
5772
|
+
# the number of cache nodes currently in the cluster.
|
5781
5773
|
#
|
5782
5774
|
# </note>
|
5783
5775
|
#
|
@@ -5795,16 +5787,16 @@ module Aws::ElastiCache
|
|
5795
5787
|
# you must list 2 (7 - 5) cache node IDs to remove.
|
5796
5788
|
#
|
5797
5789
|
# @option params [String] :az_mode
|
5798
|
-
# Specifies whether the new nodes in this Memcached
|
5799
|
-
#
|
5790
|
+
# Specifies whether the new nodes in this Memcached cluster are all
|
5791
|
+
# created in a single Availability Zone or created across multiple
|
5800
5792
|
# Availability Zones.
|
5801
5793
|
#
|
5802
5794
|
# Valid values: `single-az` \| `cross-az`.
|
5803
5795
|
#
|
5804
|
-
# This option is only supported for Memcached
|
5796
|
+
# This option is only supported for Memcached clusters.
|
5805
5797
|
#
|
5806
|
-
# <note markdown="1"> You cannot specify `single-az` if the Memcached
|
5807
|
-
#
|
5798
|
+
# <note markdown="1"> You cannot specify `single-az` if the Memcached cluster already has
|
5799
|
+
# cache nodes in different Availability Zones. If `cross-az` is
|
5808
5800
|
# specified, existing Memcached nodes remain in their current
|
5809
5801
|
# Availability Zone.
|
5810
5802
|
#
|
@@ -5902,8 +5894,8 @@ module Aws::ElastiCache
|
|
5902
5894
|
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html
|
5903
5895
|
#
|
5904
5896
|
# @option params [Array<String>] :cache_security_group_names
|
5905
|
-
# A list of cache security group names to authorize on this
|
5906
|
-
#
|
5897
|
+
# A list of cache security group names to authorize on this cluster.
|
5898
|
+
# This change is asynchronously applied as soon as possible.
|
5907
5899
|
#
|
5908
5900
|
# You can use this parameter only with clusters that are created outside
|
5909
5901
|
# of an Amazon Virtual Private Cloud (Amazon VPC).
|
@@ -5912,7 +5904,7 @@ module Aws::ElastiCache
|
|
5912
5904
|
# Must not be "Default".
|
5913
5905
|
#
|
5914
5906
|
# @option params [Array<String>] :security_group_ids
|
5915
|
-
# Specifies the VPC Security Groups associated with the
|
5907
|
+
# Specifies the VPC Security Groups associated with the cluster.
|
5916
5908
|
#
|
5917
5909
|
# This parameter can be used only with clusters that are created in an
|
5918
5910
|
# Amazon Virtual Private Cloud (Amazon VPC).
|
@@ -5945,15 +5937,15 @@ module Aws::ElastiCache
|
|
5945
5937
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to which
|
5946
5938
|
# notifications are sent.
|
5947
5939
|
#
|
5948
|
-
# <note markdown="1"> The Amazon SNS topic owner must be same as the
|
5940
|
+
# <note markdown="1"> The Amazon SNS topic owner must be same as the cluster owner.
|
5949
5941
|
#
|
5950
5942
|
# </note>
|
5951
5943
|
#
|
5952
5944
|
# @option params [String] :cache_parameter_group_name
|
5953
|
-
# The name of the cache parameter group to apply to this
|
5954
|
-
#
|
5955
|
-
#
|
5956
|
-
#
|
5945
|
+
# The name of the cache parameter group to apply to this cluster. This
|
5946
|
+
# change is asynchronously applied as soon as possible for parameters
|
5947
|
+
# when the `ApplyImmediately` parameter is specified as `true` for this
|
5948
|
+
# request.
|
5957
5949
|
#
|
5958
5950
|
# @option params [String] :notification_topic_status
|
5959
5951
|
# The status of the Amazon SNS notification topic. Notifications are
|
@@ -5965,11 +5957,10 @@ module Aws::ElastiCache
|
|
5965
5957
|
# If `true`, this parameter causes the modifications in this request and
|
5966
5958
|
# any pending modifications to be applied, asynchronously and as soon as
|
5967
5959
|
# possible, regardless of the `PreferredMaintenanceWindow` setting for
|
5968
|
-
# the
|
5960
|
+
# the cluster.
|
5969
5961
|
#
|
5970
|
-
# If `false`, changes to the
|
5971
|
-
#
|
5972
|
-
# first.
|
5962
|
+
# If `false`, changes to the cluster are applied on the next maintenance
|
5963
|
+
# reboot, or the next failure reboot, whichever occurs first.
|
5973
5964
|
#
|
5974
5965
|
# If you perform a `ModifyCacheCluster` before a pending modification is
|
5975
5966
|
# applied, the pending modification is replaced by the newer
|
@@ -5985,8 +5976,8 @@ module Aws::ElastiCache
|
|
5985
5976
|
# **Important:** You can upgrade to a newer engine version (see
|
5986
5977
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
5987
5978
|
# to an earlier engine version. If you want to use an earlier engine
|
5988
|
-
# version, you must delete the existing
|
5989
|
-
#
|
5979
|
+
# version, you must delete the existing cluster and create it anew with
|
5980
|
+
# the earlier engine version.
|
5990
5981
|
#
|
5991
5982
|
#
|
5992
5983
|
#
|
@@ -5996,8 +5987,8 @@ module Aws::ElastiCache
|
|
5996
5987
|
# This parameter is currently disabled.
|
5997
5988
|
#
|
5998
5989
|
# @option params [Integer] :snapshot_retention_limit
|
5999
|
-
# The number of days for which ElastiCache retains automatic
|
6000
|
-
#
|
5990
|
+
# The number of days for which ElastiCache retains automatic cluster
|
5991
|
+
# snapshots before deleting them. For example, if you set
|
6001
5992
|
# `SnapshotRetentionLimit` to 5, a snapshot that was taken today is
|
6002
5993
|
# retained for 5 days before being deleted.
|
6003
5994
|
#
|
@@ -6008,11 +5999,10 @@ module Aws::ElastiCache
|
|
6008
5999
|
#
|
6009
6000
|
# @option params [String] :snapshot_window
|
6010
6001
|
# The daily time range (in UTC) during which ElastiCache begins taking a
|
6011
|
-
# daily snapshot of your
|
6002
|
+
# daily snapshot of your cluster.
|
6012
6003
|
#
|
6013
6004
|
# @option params [String] :cache_node_type
|
6014
|
-
# A valid cache node type that you want to scale this
|
6015
|
-
# to.
|
6005
|
+
# A valid cache node type that you want to scale this cluster up to.
|
6016
6006
|
#
|
6017
6007
|
# @return [Types::ModifyCacheClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6018
6008
|
#
|
@@ -6329,7 +6319,7 @@ module Aws::ElastiCache
|
|
6329
6319
|
# in the replication group are read replicas.
|
6330
6320
|
#
|
6331
6321
|
# @option params [String] :snapshotting_cluster_id
|
6332
|
-
# The
|
6322
|
+
# The cluster ID that is used as the daily snapshot source for the
|
6333
6323
|
# replication group. This parameter cannot be set for Redis (cluster
|
6334
6324
|
# mode enabled) replication groups.
|
6335
6325
|
#
|
@@ -6354,19 +6344,18 @@ module Aws::ElastiCache
|
|
6354
6344
|
# as possible.
|
6355
6345
|
#
|
6356
6346
|
# This parameter can be used only with replication group containing
|
6357
|
-
#
|
6358
|
-
#
|
6347
|
+
# clusters running outside of an Amazon Virtual Private Cloud (Amazon
|
6348
|
+
# VPC).
|
6359
6349
|
#
|
6360
6350
|
# Constraints: Must contain no more than 255 alphanumeric characters.
|
6361
6351
|
# Must not be `Default`.
|
6362
6352
|
#
|
6363
6353
|
# @option params [Array<String>] :security_group_ids
|
6364
|
-
# Specifies the VPC Security Groups associated with the
|
6365
|
-
#
|
6354
|
+
# Specifies the VPC Security Groups associated with the clusters in the
|
6355
|
+
# replication group.
|
6366
6356
|
#
|
6367
6357
|
# This parameter can be used only with replication group containing
|
6368
|
-
#
|
6369
|
-
# VPC).
|
6358
|
+
# clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
|
6370
6359
|
#
|
6371
6360
|
# @option params [String] :preferred_maintenance_window
|
6372
6361
|
# Specifies the weekly time range during which maintenance on the
|
@@ -6428,8 +6417,8 @@ module Aws::ElastiCache
|
|
6428
6417
|
# Default: `false`
|
6429
6418
|
#
|
6430
6419
|
# @option params [String] :engine_version
|
6431
|
-
# The upgraded version of the cache engine to be run on the
|
6432
|
-
#
|
6420
|
+
# The upgraded version of the cache engine to be run on the clusters in
|
6421
|
+
# the replication group.
|
6433
6422
|
#
|
6434
6423
|
# **Important:** You can upgrade to a newer engine version (see
|
6435
6424
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
@@ -6575,6 +6564,7 @@ module Aws::ElastiCache
|
|
6575
6564
|
# resp.replication_group.status #=> String
|
6576
6565
|
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
6577
6566
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
6567
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
6578
6568
|
# resp.replication_group.member_clusters #=> Array
|
6579
6569
|
# resp.replication_group.member_clusters[0] #=> String
|
6580
6570
|
# resp.replication_group.node_groups #=> Array
|
@@ -6611,6 +6601,110 @@ module Aws::ElastiCache
|
|
6611
6601
|
req.send_request(options)
|
6612
6602
|
end
|
6613
6603
|
|
6604
|
+
# Performs horizontal scaling on a Redis (cluster mode enabled) cluster
|
6605
|
+
# with no downtime. Requires Redis engine version 3.2.10 or newer. For
|
6606
|
+
# information on upgrading your engine to a newer version, see
|
6607
|
+
# [Upgrading Engine Versions][1] in the Amazon ElastiCache User Guide.
|
6608
|
+
#
|
6609
|
+
# For more information on ElastiCache for Redis online horizontal
|
6610
|
+
# scaling, see [ElastiCache for Redis Horizontal Scaling][2]
|
6611
|
+
#
|
6612
|
+
#
|
6613
|
+
#
|
6614
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/VersionManagement.html
|
6615
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/redis-cluster-resharding-online.html
|
6616
|
+
#
|
6617
|
+
# @option params [required, String] :replication_group_id
|
6618
|
+
# The name of the Redis (cluster mode enabled) cluster (replication
|
6619
|
+
# group) on which the shards are to be configured.
|
6620
|
+
#
|
6621
|
+
# @option params [required, Integer] :node_group_count
|
6622
|
+
# The number of node groups (shards) that results from the modification
|
6623
|
+
# of the shard configuration.
|
6624
|
+
#
|
6625
|
+
# @option params [required, Boolean] :apply_immediately
|
6626
|
+
# Indicates that the shard reconfiguration process begins immediately.
|
6627
|
+
# At present, the only permitted value for this parameter is `true`.
|
6628
|
+
#
|
6629
|
+
# Value: true
|
6630
|
+
#
|
6631
|
+
# @option params [Array<Types::ReshardingConfiguration>] :resharding_configuration
|
6632
|
+
# Specifies the preferred availability zones for each node group in the
|
6633
|
+
# cluster. If the value of `NodeGroupCount` is greater than the current
|
6634
|
+
# number of node groups (shards), you can use this parameter to specify
|
6635
|
+
# the preferred availability zones of the cluster's shards. If you omit
|
6636
|
+
# this parameter ElastiCache selects availability zones for you.
|
6637
|
+
#
|
6638
|
+
# You can specify this parameter only if the value of `NodeGroupCount`
|
6639
|
+
# is greater than the current number of node groups (shards).
|
6640
|
+
#
|
6641
|
+
# @option params [Array<String>] :node_groups_to_remove
|
6642
|
+
# If the value of `NodeGroupCount` is less than the current number of
|
6643
|
+
# node groups (shards), `NodeGroupsToRemove` is a required list of node
|
6644
|
+
# group ids to remove from the cluster.
|
6645
|
+
#
|
6646
|
+
# @return [Types::ModifyReplicationGroupShardConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6647
|
+
#
|
6648
|
+
# * {Types::ModifyReplicationGroupShardConfigurationResult#replication_group #replication_group} => Types::ReplicationGroup
|
6649
|
+
#
|
6650
|
+
# @example Request syntax with placeholder values
|
6651
|
+
#
|
6652
|
+
# resp = client.modify_replication_group_shard_configuration({
|
6653
|
+
# replication_group_id: "String", # required
|
6654
|
+
# node_group_count: 1, # required
|
6655
|
+
# apply_immediately: false, # required
|
6656
|
+
# resharding_configuration: [
|
6657
|
+
# {
|
6658
|
+
# preferred_availability_zones: ["String"],
|
6659
|
+
# },
|
6660
|
+
# ],
|
6661
|
+
# node_groups_to_remove: ["String"],
|
6662
|
+
# })
|
6663
|
+
#
|
6664
|
+
# @example Response structure
|
6665
|
+
#
|
6666
|
+
# resp.replication_group.replication_group_id #=> String
|
6667
|
+
# resp.replication_group.description #=> String
|
6668
|
+
# resp.replication_group.status #=> String
|
6669
|
+
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
6670
|
+
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
6671
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
6672
|
+
# resp.replication_group.member_clusters #=> Array
|
6673
|
+
# resp.replication_group.member_clusters[0] #=> String
|
6674
|
+
# resp.replication_group.node_groups #=> Array
|
6675
|
+
# resp.replication_group.node_groups[0].node_group_id #=> String
|
6676
|
+
# resp.replication_group.node_groups[0].status #=> String
|
6677
|
+
# resp.replication_group.node_groups[0].primary_endpoint.address #=> String
|
6678
|
+
# resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
|
6679
|
+
# resp.replication_group.node_groups[0].slots #=> String
|
6680
|
+
# resp.replication_group.node_groups[0].node_group_members #=> Array
|
6681
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
|
6682
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
|
6683
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
6684
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
6685
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
6686
|
+
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
6687
|
+
# resp.replication_group.snapshotting_cluster_id #=> String
|
6688
|
+
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
6689
|
+
# resp.replication_group.configuration_endpoint.address #=> String
|
6690
|
+
# resp.replication_group.configuration_endpoint.port #=> Integer
|
6691
|
+
# resp.replication_group.snapshot_retention_limit #=> Integer
|
6692
|
+
# resp.replication_group.snapshot_window #=> String
|
6693
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
6694
|
+
# resp.replication_group.cache_node_type #=> String
|
6695
|
+
# resp.replication_group.auth_token_enabled #=> Boolean
|
6696
|
+
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
6697
|
+
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
6698
|
+
#
|
6699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration AWS API Documentation
|
6700
|
+
#
|
6701
|
+
# @overload modify_replication_group_shard_configuration(params = {})
|
6702
|
+
# @param [Hash] params ({})
|
6703
|
+
def modify_replication_group_shard_configuration(params = {}, options = {})
|
6704
|
+
req = build_request(:modify_replication_group_shard_configuration, params)
|
6705
|
+
req.send_request(options)
|
6706
|
+
end
|
6707
|
+
|
6614
6708
|
# Allows you to purchase a reserved cache node offering.
|
6615
6709
|
#
|
6616
6710
|
# @option params [required, String] :reserved_cache_nodes_offering_id
|
@@ -6681,16 +6775,16 @@ module Aws::ElastiCache
|
|
6681
6775
|
req.send_request(options)
|
6682
6776
|
end
|
6683
6777
|
|
6684
|
-
# Reboots some, or all, of the cache nodes within a provisioned
|
6685
|
-
#
|
6686
|
-
#
|
6687
|
-
#
|
6688
|
-
#
|
6778
|
+
# Reboots some, or all, of the cache nodes within a provisioned cluster.
|
6779
|
+
# This operation applies any modified cache parameter groups to the
|
6780
|
+
# cluster. The reboot operation takes place as soon as possible, and
|
6781
|
+
# results in a momentary outage to the cluster. During the reboot, the
|
6782
|
+
# cluster status is set to REBOOTING.
|
6689
6783
|
#
|
6690
6784
|
# The reboot causes the contents of the cache (for each cache node being
|
6691
6785
|
# rebooted) to be lost.
|
6692
6786
|
#
|
6693
|
-
# When the reboot is complete, a
|
6787
|
+
# When the reboot is complete, a cluster event is created.
|
6694
6788
|
#
|
6695
6789
|
# Rebooting a cluster is currently supported on Memcached and Redis
|
6696
6790
|
# (cluster mode disabled) clusters. Rebooting is not supported on Redis
|
@@ -6705,13 +6799,13 @@ module Aws::ElastiCache
|
|
6705
6799
|
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Clusters.Rebooting.htm
|
6706
6800
|
#
|
6707
6801
|
# @option params [required, String] :cache_cluster_id
|
6708
|
-
# The
|
6802
|
+
# The cluster identifier. This parameter is stored as a lowercase
|
6709
6803
|
# string.
|
6710
6804
|
#
|
6711
6805
|
# @option params [required, Array<String>] :cache_node_ids_to_reboot
|
6712
6806
|
# A list of cache node IDs to reboot. A node ID is a numeric identifier
|
6713
|
-
# (0001, 0002, etc.). To reboot an entire
|
6714
|
-
#
|
6807
|
+
# (0001, 0002, etc.). To reboot an entire cluster, specify all of the
|
6808
|
+
# cache node IDs.
|
6715
6809
|
#
|
6716
6810
|
# @return [Types::RebootCacheClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6717
6811
|
#
|
@@ -7120,6 +7214,7 @@ module Aws::ElastiCache
|
|
7120
7214
|
# resp.replication_group.status #=> String
|
7121
7215
|
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
7122
7216
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
7217
|
+
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
7123
7218
|
# resp.replication_group.member_clusters #=> Array
|
7124
7219
|
# resp.replication_group.member_clusters[0] #=> String
|
7125
7220
|
# resp.replication_group.node_groups #=> Array
|
@@ -7169,7 +7264,7 @@ module Aws::ElastiCache
|
|
7169
7264
|
params: params,
|
7170
7265
|
config: config)
|
7171
7266
|
context[:gem_name] = 'aws-sdk-elasticache'
|
7172
|
-
context[:gem_version] = '1.
|
7267
|
+
context[:gem_version] = '1.3.0'
|
7173
7268
|
Seahorse::Client::Request.new(handlers, context)
|
7174
7269
|
end
|
7175
7270
|
|