aws-sdk-elasticache 1.0.0.rc2 → 1.0.0.rc3
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 +268 -24
- data/lib/aws-sdk-elasticache/client_api.rb +32 -0
- data/lib/aws-sdk-elasticache/types.rb +315 -19
- 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: 6ce4cc084661d14bd2f09dfe68a98550ceabe79e
|
4
|
+
data.tar.gz: 83f0ca4222dce63f9795c7b13001bee5a72b1f2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ac8032eada15e5352c8e6a952f1fb59c2d54b81aefa3cadd490a9675188b4e9d42e0ec79d7ee998380c3e601a57a72c004c5f4c47840040677e9a852ad394b3a
|
7
|
+
data.tar.gz: 454f32b337a483d87ac618284192a51b377ff1561391778cad343505915fe24cc76daa58279aad89d9d0c50b8804a8203ba7f60f62ae82be8fb520e716fc7837
|
data/lib/aws-sdk-elasticache.rb
CHANGED
@@ -18,6 +18,7 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
23
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
23
24
|
|
@@ -45,6 +46,7 @@ module Aws::ElastiCache
|
|
45
46
|
add_plugin(Aws::Plugins::ResponsePaging)
|
46
47
|
add_plugin(Aws::Plugins::StubResponses)
|
47
48
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
48
50
|
add_plugin(Aws::Plugins::SignatureV4)
|
49
51
|
add_plugin(Aws::Plugins::Protocols::Query)
|
50
52
|
|
@@ -143,7 +145,7 @@ module Aws::ElastiCache
|
|
143
145
|
|
144
146
|
# @!group API Operations
|
145
147
|
|
146
|
-
# Adds up to
|
148
|
+
# Adds up to 50 cost allocation tags to the named resource. A cost
|
147
149
|
# allocation tag is a key-value pair where the key and value are
|
148
150
|
# case-sensitive. You can use cost allocation tags to categorize and
|
149
151
|
# track your AWS costs.
|
@@ -199,6 +201,8 @@ module Aws::ElastiCache
|
|
199
201
|
# resp.tag_list[0].key #=> String
|
200
202
|
# resp.tag_list[0].value #=> String
|
201
203
|
#
|
204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/AddTagsToResource AWS API Documentation
|
205
|
+
#
|
202
206
|
# @overload add_tags_to_resource(params = {})
|
203
207
|
# @param [Hash] params ({})
|
204
208
|
def add_tags_to_resource(params = {}, options = {})
|
@@ -249,6 +253,8 @@ module Aws::ElastiCache
|
|
249
253
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
|
250
254
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
|
251
255
|
#
|
256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/AuthorizeCacheSecurityGroupIngress AWS API Documentation
|
257
|
+
#
|
252
258
|
# @overload authorize_cache_security_group_ingress(params = {})
|
253
259
|
# @param [Hash] params ({})
|
254
260
|
def authorize_cache_security_group_ingress(params = {}, options = {})
|
@@ -409,6 +415,8 @@ module Aws::ElastiCache
|
|
409
415
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
410
416
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
411
417
|
#
|
418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CopySnapshot AWS API Documentation
|
419
|
+
#
|
412
420
|
# @overload copy_snapshot(params = {})
|
413
421
|
# @param [Hash] params ({})
|
414
422
|
def copy_snapshot(params = {}, options = {})
|
@@ -808,6 +816,8 @@ module Aws::ElastiCache
|
|
808
816
|
# resp.cache_cluster.snapshot_retention_limit #=> Integer
|
809
817
|
# resp.cache_cluster.snapshot_window #=> String
|
810
818
|
#
|
819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheCluster AWS API Documentation
|
820
|
+
#
|
811
821
|
# @overload create_cache_cluster(params = {})
|
812
822
|
# @param [Hash] params ({})
|
813
823
|
def create_cache_cluster(params = {}, options = {})
|
@@ -815,9 +825,24 @@ module Aws::ElastiCache
|
|
815
825
|
req.send_request(options)
|
816
826
|
end
|
817
827
|
|
818
|
-
# Creates a new
|
819
|
-
#
|
820
|
-
# cluster
|
828
|
+
# Creates a new Amazon ElastiCache cache parameter group. An ElastiCache
|
829
|
+
# cache parameter group is a collection of parameters and their values
|
830
|
+
# that are applied to all of the nodes in any cache cluster or
|
831
|
+
# replication group using the CacheParameterGroup.
|
832
|
+
#
|
833
|
+
# A newly created CacheParameterGroup is an exact duplicate of the
|
834
|
+
# default parameter group for the CacheParameterGroupFamily. To
|
835
|
+
# customize the newly created CacheParameterGroup you can change the
|
836
|
+
# values of specific parameters. For more information, see:
|
837
|
+
#
|
838
|
+
# * [ModifyCacheParameterGroup][1] in the ElastiCache API Reference.
|
839
|
+
#
|
840
|
+
# * [Parameters and Parameter Groups][2] in the ElastiCache User Guide.
|
841
|
+
#
|
842
|
+
#
|
843
|
+
#
|
844
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html
|
845
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/ParameterGroups.html
|
821
846
|
#
|
822
847
|
# @option params [required, String] :cache_parameter_group_name
|
823
848
|
# A user-specified name for the cache parameter group.
|
@@ -850,6 +875,8 @@ module Aws::ElastiCache
|
|
850
875
|
# resp.cache_parameter_group.cache_parameter_group_family #=> String
|
851
876
|
# resp.cache_parameter_group.description #=> String
|
852
877
|
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheParameterGroup AWS API Documentation
|
879
|
+
#
|
853
880
|
# @overload create_cache_parameter_group(params = {})
|
854
881
|
# @param [Hash] params ({})
|
855
882
|
def create_cache_parameter_group(params = {}, options = {})
|
@@ -902,6 +929,8 @@ module Aws::ElastiCache
|
|
902
929
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
|
903
930
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
|
904
931
|
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheSecurityGroup AWS API Documentation
|
933
|
+
#
|
905
934
|
# @overload create_cache_security_group(params = {})
|
906
935
|
# @param [Hash] params ({})
|
907
936
|
def create_cache_security_group(params = {}, options = {})
|
@@ -950,6 +979,8 @@ module Aws::ElastiCache
|
|
950
979
|
# resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
|
951
980
|
# resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
|
952
981
|
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheSubnetGroup AWS API Documentation
|
983
|
+
#
|
953
984
|
# @overload create_cache_subnet_group(params = {})
|
954
985
|
# @param [Hash] params ({})
|
955
986
|
def create_cache_subnet_group(params = {}, options = {})
|
@@ -975,12 +1006,20 @@ module Aws::ElastiCache
|
|
975
1006
|
# When a Redis (cluster mode disabled) replication group has been
|
976
1007
|
# successfully created, you can add one or more read replicas to it, up
|
977
1008
|
# to a total of 5 read replicas. You cannot alter a Redis (cluster mode
|
978
|
-
# enabled) replication group after it has been created.
|
1009
|
+
# enabled) replication group after it has been created. However, if you
|
1010
|
+
# need to increase or decrease the number of node groups (console:
|
1011
|
+
# shards), you can avail yourself of ElastiCache for Redis' enhanced
|
1012
|
+
# backup and restore. For more information, see [Restoring From a Backup
|
1013
|
+
# with Cluster Resizing][1] in the *ElastiCache User Guide*.
|
979
1014
|
#
|
980
1015
|
# <note markdown="1"> This operation is valid for Redis only.
|
981
1016
|
#
|
982
1017
|
# </note>
|
983
1018
|
#
|
1019
|
+
#
|
1020
|
+
#
|
1021
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/backups-restoring.html
|
1022
|
+
#
|
984
1023
|
# @option params [required, String] :replication_group_id
|
985
1024
|
# The replication group identifier. This parameter is stored as a
|
986
1025
|
# lowercase string.
|
@@ -1032,8 +1071,10 @@ module Aws::ElastiCache
|
|
1032
1071
|
# This parameter is not used if there is more than one node group
|
1033
1072
|
# (shard). You should use `ReplicasPerNodeGroup` instead.
|
1034
1073
|
#
|
1035
|
-
# If `
|
1036
|
-
# least 2.
|
1074
|
+
# If `AutomaticFailoverEnabled` is `true`, the value of this parameter
|
1075
|
+
# must be at least 2. If `AutomaticFailoverEnabled` is `false` you can
|
1076
|
+
# omit this parameter (it will default to 1), or you can explicitly set
|
1077
|
+
# it to a value between 2 and 6.
|
1037
1078
|
#
|
1038
1079
|
# The maximum permitted value for `NumCacheClusters` is 6 (primary plus
|
1039
1080
|
# 5 replicas).
|
@@ -1077,7 +1118,8 @@ module Aws::ElastiCache
|
|
1077
1118
|
#
|
1078
1119
|
# If you're creating a Redis (cluster mode disabled) or a Redis
|
1079
1120
|
# (cluster mode enabled) replication group, you can use this parameter
|
1080
|
-
# to configure
|
1121
|
+
# to individually configure each node group (shard), or you can omit
|
1122
|
+
# this parameter.
|
1081
1123
|
#
|
1082
1124
|
# @option params [String] :cache_node_type
|
1083
1125
|
# The compute and memory capacity of the nodes in the node group
|
@@ -1194,10 +1236,12 @@ module Aws::ElastiCache
|
|
1194
1236
|
# @option params [Array<String>] :snapshot_arns
|
1195
1237
|
# A list of Amazon Resource Names (ARN) that uniquely identify the Redis
|
1196
1238
|
# RDB snapshot files stored in Amazon S3. The snapshot files are used to
|
1197
|
-
# populate the replication group. The Amazon S3 object name in the
|
1198
|
-
# cannot contain any commas. The
|
1199
|
-
# groups (shards)
|
1200
|
-
#
|
1239
|
+
# populate the new replication group. The Amazon S3 object name in the
|
1240
|
+
# ARN cannot contain any commas. The new replication group will have the
|
1241
|
+
# number of node groups (console: shards) specified by the parameter
|
1242
|
+
# *NumNodeGroups* or the number of node groups configured by
|
1243
|
+
# *NodeGroupConfiguration* regardless of the number of ARNs specified
|
1244
|
+
# here.
|
1201
1245
|
#
|
1202
1246
|
# <note markdown="1"> This parameter is only valid if the `Engine` parameter is `redis`.
|
1203
1247
|
#
|
@@ -1380,6 +1424,10 @@ module Aws::ElastiCache
|
|
1380
1424
|
# resp.replication_group.configuration_endpoint.port #=> Integer
|
1381
1425
|
# resp.replication_group.snapshot_retention_limit #=> Integer
|
1382
1426
|
# resp.replication_group.snapshot_window #=> String
|
1427
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
1428
|
+
# resp.replication_group.cache_node_type #=> String
|
1429
|
+
#
|
1430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateReplicationGroup AWS API Documentation
|
1383
1431
|
#
|
1384
1432
|
# @overload create_replication_group(params = {})
|
1385
1433
|
# @param [Hash] params ({})
|
@@ -1456,6 +1504,8 @@ module Aws::ElastiCache
|
|
1456
1504
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
1457
1505
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
1458
1506
|
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateSnapshot AWS API Documentation
|
1508
|
+
#
|
1459
1509
|
# @overload create_snapshot(params = {})
|
1460
1510
|
# @param [Hash] params ({})
|
1461
1511
|
def create_snapshot(params = {}, options = {})
|
@@ -1544,6 +1594,8 @@ module Aws::ElastiCache
|
|
1544
1594
|
# resp.cache_cluster.snapshot_retention_limit #=> Integer
|
1545
1595
|
# resp.cache_cluster.snapshot_window #=> String
|
1546
1596
|
#
|
1597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheCluster AWS API Documentation
|
1598
|
+
#
|
1547
1599
|
# @overload delete_cache_cluster(params = {})
|
1548
1600
|
# @param [Hash] params ({})
|
1549
1601
|
def delete_cache_cluster(params = {}, options = {})
|
@@ -1570,6 +1622,8 @@ module Aws::ElastiCache
|
|
1570
1622
|
# cache_parameter_group_name: "String", # required
|
1571
1623
|
# })
|
1572
1624
|
#
|
1625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheParameterGroup AWS API Documentation
|
1626
|
+
#
|
1573
1627
|
# @overload delete_cache_parameter_group(params = {})
|
1574
1628
|
# @param [Hash] params ({})
|
1575
1629
|
def delete_cache_parameter_group(params = {}, options = {})
|
@@ -1599,6 +1653,8 @@ module Aws::ElastiCache
|
|
1599
1653
|
# cache_security_group_name: "String", # required
|
1600
1654
|
# })
|
1601
1655
|
#
|
1656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheSecurityGroup AWS API Documentation
|
1657
|
+
#
|
1602
1658
|
# @overload delete_cache_security_group(params = {})
|
1603
1659
|
# @param [Hash] params ({})
|
1604
1660
|
def delete_cache_security_group(params = {}, options = {})
|
@@ -1627,6 +1683,8 @@ module Aws::ElastiCache
|
|
1627
1683
|
# cache_subnet_group_name: "String", # required
|
1628
1684
|
# })
|
1629
1685
|
#
|
1686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheSubnetGroup AWS API Documentation
|
1687
|
+
#
|
1630
1688
|
# @overload delete_cache_subnet_group(params = {})
|
1631
1689
|
# @param [Hash] params ({})
|
1632
1690
|
def delete_cache_subnet_group(params = {}, options = {})
|
@@ -1703,6 +1761,10 @@ module Aws::ElastiCache
|
|
1703
1761
|
# resp.replication_group.configuration_endpoint.port #=> Integer
|
1704
1762
|
# resp.replication_group.snapshot_retention_limit #=> Integer
|
1705
1763
|
# resp.replication_group.snapshot_window #=> String
|
1764
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
1765
|
+
# resp.replication_group.cache_node_type #=> String
|
1766
|
+
#
|
1767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteReplicationGroup AWS API Documentation
|
1706
1768
|
#
|
1707
1769
|
# @overload delete_replication_group(params = {})
|
1708
1770
|
# @param [Hash] params ({})
|
@@ -1770,6 +1832,8 @@ module Aws::ElastiCache
|
|
1770
1832
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
1771
1833
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
1772
1834
|
#
|
1835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteSnapshot AWS API Documentation
|
1836
|
+
#
|
1773
1837
|
# @overload delete_snapshot(params = {})
|
1774
1838
|
# @param [Hash] params ({})
|
1775
1839
|
def delete_snapshot(params = {}, options = {})
|
@@ -1781,23 +1845,23 @@ module Aws::ElastiCache
|
|
1781
1845
|
# cluster identifier is specified, or about a specific cache cluster if
|
1782
1846
|
# a cache cluster identifier is supplied.
|
1783
1847
|
#
|
1784
|
-
# By default, abbreviated information about the cache clusters
|
1785
|
-
# returned. You can use the optional
|
1786
|
-
# detailed information about the cache nodes associated with
|
1787
|
-
# clusters. These details include the DNS address and port for
|
1788
|
-
# node endpoint.
|
1848
|
+
# By default, abbreviated information about the cache clusters is
|
1849
|
+
# returned. You can use the optional *ShowCacheNodeInfo* flag to
|
1850
|
+
# retrieve detailed information about the cache nodes associated with
|
1851
|
+
# the cache clusters. These details include the DNS address and port for
|
1852
|
+
# the cache node endpoint.
|
1789
1853
|
#
|
1790
|
-
# If the cluster is in the
|
1854
|
+
# If the cluster is in the *creating* state, only cluster-level
|
1791
1855
|
# information is displayed until all of the nodes are successfully
|
1792
1856
|
# provisioned.
|
1793
1857
|
#
|
1794
|
-
# If the cluster is in the
|
1858
|
+
# If the cluster is in the *deleting* state, only cluster-level
|
1795
1859
|
# information is displayed.
|
1796
1860
|
#
|
1797
1861
|
# If cache nodes are currently being added to the cache cluster, node
|
1798
1862
|
# endpoint information and creation time for the additional nodes are
|
1799
1863
|
# not displayed until they are completely provisioned. When the cache
|
1800
|
-
# cluster state is
|
1864
|
+
# cluster state is *available*, the cluster is ready for use.
|
1801
1865
|
#
|
1802
1866
|
# If cache nodes are currently being removed from the cache cluster, no
|
1803
1867
|
# endpoint information for the removed nodes is displayed.
|
@@ -1824,9 +1888,15 @@ module Aws::ElastiCache
|
|
1824
1888
|
# the value specified by `MaxRecords`.
|
1825
1889
|
#
|
1826
1890
|
# @option params [Boolean] :show_cache_node_info
|
1827
|
-
# An optional flag that can be included in the DescribeCacheCluster
|
1891
|
+
# An optional flag that can be included in the `DescribeCacheCluster`
|
1828
1892
|
# request to retrieve information about the individual cache nodes.
|
1829
1893
|
#
|
1894
|
+
# @option params [Boolean] :show_cache_clusters_not_in_replication_groups
|
1895
|
+
# An optional flag that can be included in the `DescribeCacheCluster`
|
1896
|
+
# request to show only nodes (API/CLI: clusters) that are not members of
|
1897
|
+
# a replication group. In practice, this mean Memcached and single node
|
1898
|
+
# Redis clusters.
|
1899
|
+
#
|
1830
1900
|
# @return [Types::CacheClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1831
1901
|
#
|
1832
1902
|
# * {Types::CacheClusterMessage#marker #marker} => String
|
@@ -1839,6 +1909,7 @@ module Aws::ElastiCache
|
|
1839
1909
|
# max_records: 1,
|
1840
1910
|
# marker: "String",
|
1841
1911
|
# show_cache_node_info: false,
|
1912
|
+
# show_cache_clusters_not_in_replication_groups: false,
|
1842
1913
|
# })
|
1843
1914
|
#
|
1844
1915
|
# @example Response structure
|
@@ -1889,6 +1960,8 @@ module Aws::ElastiCache
|
|
1889
1960
|
# resp.cache_clusters[0].snapshot_retention_limit #=> Integer
|
1890
1961
|
# resp.cache_clusters[0].snapshot_window #=> String
|
1891
1962
|
#
|
1963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheClusters AWS API Documentation
|
1964
|
+
#
|
1892
1965
|
# @overload describe_cache_clusters(params = {})
|
1893
1966
|
# @param [Hash] params ({})
|
1894
1967
|
def describe_cache_clusters(params = {}, options = {})
|
@@ -1967,6 +2040,8 @@ module Aws::ElastiCache
|
|
1967
2040
|
# resp.cache_engine_versions[0].cache_engine_description #=> String
|
1968
2041
|
# resp.cache_engine_versions[0].cache_engine_version_description #=> String
|
1969
2042
|
#
|
2043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheEngineVersions AWS API Documentation
|
2044
|
+
#
|
1970
2045
|
# @overload describe_cache_engine_versions(params = {})
|
1971
2046
|
# @param [Hash] params ({})
|
1972
2047
|
def describe_cache_engine_versions(params = {}, options = {})
|
@@ -2018,6 +2093,8 @@ module Aws::ElastiCache
|
|
2018
2093
|
# resp.cache_parameter_groups[0].cache_parameter_group_family #=> String
|
2019
2094
|
# resp.cache_parameter_groups[0].description #=> String
|
2020
2095
|
#
|
2096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheParameterGroups AWS API Documentation
|
2097
|
+
#
|
2021
2098
|
# @overload describe_cache_parameter_groups(params = {})
|
2022
2099
|
# @param [Hash] params ({})
|
2023
2100
|
def describe_cache_parameter_groups(params = {}, options = {})
|
@@ -2093,6 +2170,8 @@ module Aws::ElastiCache
|
|
2093
2170
|
# resp.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].value #=> String
|
2094
2171
|
# resp.cache_node_type_specific_parameters[0].change_type #=> String, one of "immediate", "requires-reboot"
|
2095
2172
|
#
|
2173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheParameters AWS API Documentation
|
2174
|
+
#
|
2096
2175
|
# @overload describe_cache_parameters(params = {})
|
2097
2176
|
# @param [Hash] params ({})
|
2098
2177
|
def describe_cache_parameters(params = {}, options = {})
|
@@ -2148,6 +2227,8 @@ module Aws::ElastiCache
|
|
2148
2227
|
# resp.cache_security_groups[0].ec2_security_groups[0].ec2_security_group_name #=> String
|
2149
2228
|
# resp.cache_security_groups[0].ec2_security_groups[0].ec2_security_group_owner_id #=> String
|
2150
2229
|
#
|
2230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheSecurityGroups AWS API Documentation
|
2231
|
+
#
|
2151
2232
|
# @overload describe_cache_security_groups(params = {})
|
2152
2233
|
# @param [Hash] params ({})
|
2153
2234
|
def describe_cache_security_groups(params = {}, options = {})
|
@@ -2202,6 +2283,8 @@ module Aws::ElastiCache
|
|
2202
2283
|
# resp.cache_subnet_groups[0].subnets[0].subnet_identifier #=> String
|
2203
2284
|
# resp.cache_subnet_groups[0].subnets[0].subnet_availability_zone.name #=> String
|
2204
2285
|
#
|
2286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheSubnetGroups AWS API Documentation
|
2287
|
+
#
|
2205
2288
|
# @overload describe_cache_subnet_groups(params = {})
|
2206
2289
|
# @param [Hash] params ({})
|
2207
2290
|
def describe_cache_subnet_groups(params = {}, options = {})
|
@@ -2273,6 +2356,8 @@ module Aws::ElastiCache
|
|
2273
2356
|
# resp.engine_defaults.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].value #=> String
|
2274
2357
|
# resp.engine_defaults.cache_node_type_specific_parameters[0].change_type #=> String, one of "immediate", "requires-reboot"
|
2275
2358
|
#
|
2359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeEngineDefaultParameters AWS API Documentation
|
2360
|
+
#
|
2276
2361
|
# @overload describe_engine_default_parameters(params = {})
|
2277
2362
|
# @param [Hash] params ({})
|
2278
2363
|
def describe_engine_default_parameters(params = {}, options = {})
|
@@ -2301,12 +2386,16 @@ module Aws::ElastiCache
|
|
2301
2386
|
# The beginning of the time interval to retrieve events for, specified
|
2302
2387
|
# in ISO 8601 format.
|
2303
2388
|
#
|
2389
|
+
# **Example:** 2017-03-30T07:03:49.555Z
|
2390
|
+
#
|
2304
2391
|
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
2305
2392
|
# The end of the time interval for which to retrieve events, specified
|
2306
2393
|
# in ISO 8601 format.
|
2307
2394
|
#
|
2395
|
+
# **Example:** 2017-03-30T07:03:49.555Z
|
2396
|
+
#
|
2308
2397
|
# @option params [Integer] :duration
|
2309
|
-
# The number of minutes
|
2398
|
+
# The number of minutes worth of events to retrieve.
|
2310
2399
|
#
|
2311
2400
|
# @option params [Integer] :max_records
|
2312
2401
|
# The maximum number of records to include in the response. If more
|
@@ -2350,6 +2439,8 @@ module Aws::ElastiCache
|
|
2350
2439
|
# resp.events[0].message #=> String
|
2351
2440
|
# resp.events[0].date #=> Time
|
2352
2441
|
#
|
2442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeEvents AWS API Documentation
|
2443
|
+
#
|
2353
2444
|
# @overload describe_events(params = {})
|
2354
2445
|
# @param [Hash] params ({})
|
2355
2446
|
def describe_events(params = {}, options = {})
|
@@ -2431,6 +2522,10 @@ module Aws::ElastiCache
|
|
2431
2522
|
# resp.replication_groups[0].configuration_endpoint.port #=> Integer
|
2432
2523
|
# resp.replication_groups[0].snapshot_retention_limit #=> Integer
|
2433
2524
|
# resp.replication_groups[0].snapshot_window #=> String
|
2525
|
+
# resp.replication_groups[0].cluster_enabled #=> Boolean
|
2526
|
+
# resp.replication_groups[0].cache_node_type #=> String
|
2527
|
+
#
|
2528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReplicationGroups AWS API Documentation
|
2434
2529
|
#
|
2435
2530
|
# @overload describe_replication_groups(params = {})
|
2436
2531
|
# @param [Hash] params ({})
|
@@ -2570,6 +2665,8 @@ module Aws::ElastiCache
|
|
2570
2665
|
# resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_amount #=> Float
|
2571
2666
|
# resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_frequency #=> String
|
2572
2667
|
#
|
2668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReservedCacheNodes AWS API Documentation
|
2669
|
+
#
|
2573
2670
|
# @overload describe_reserved_cache_nodes(params = {})
|
2574
2671
|
# @param [Hash] params ({})
|
2575
2672
|
def describe_reserved_cache_nodes(params = {}, options = {})
|
@@ -2701,6 +2798,8 @@ module Aws::ElastiCache
|
|
2701
2798
|
# resp.reserved_cache_nodes_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
|
2702
2799
|
# resp.reserved_cache_nodes_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String
|
2703
2800
|
#
|
2801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReservedCacheNodesOfferings AWS API Documentation
|
2802
|
+
#
|
2704
2803
|
# @overload describe_reserved_cache_nodes_offerings(params = {})
|
2705
2804
|
# @param [Hash] params ({})
|
2706
2805
|
def describe_reserved_cache_nodes_offerings(params = {}, options = {})
|
@@ -2814,6 +2913,8 @@ module Aws::ElastiCache
|
|
2814
2913
|
# resp.snapshots[0].node_snapshots[0].cache_node_create_time #=> Time
|
2815
2914
|
# resp.snapshots[0].node_snapshots[0].snapshot_create_time #=> Time
|
2816
2915
|
#
|
2916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeSnapshots AWS API Documentation
|
2917
|
+
#
|
2817
2918
|
# @overload describe_snapshots(params = {})
|
2818
2919
|
# @param [Hash] params ({})
|
2819
2920
|
def describe_snapshots(params = {}, options = {})
|
@@ -2863,6 +2964,8 @@ module Aws::ElastiCache
|
|
2863
2964
|
# resp.scale_up_modifications #=> Array
|
2864
2965
|
# resp.scale_up_modifications[0] #=> String
|
2865
2966
|
#
|
2967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ListAllowedNodeTypeModifications AWS API Documentation
|
2968
|
+
#
|
2866
2969
|
# @overload list_allowed_node_type_modifications(params = {})
|
2867
2970
|
# @param [Hash] params ({})
|
2868
2971
|
def list_allowed_node_type_modifications(params = {}, options = {})
|
@@ -2875,7 +2978,7 @@ module Aws::ElastiCache
|
|
2875
2978
|
# case-sensitive and the value is optional. You can use cost allocation
|
2876
2979
|
# tags to categorize and track your AWS costs.
|
2877
2980
|
#
|
2878
|
-
# You can have a maximum of
|
2981
|
+
# You can have a maximum of 50 cost allocation tags on an ElastiCache
|
2879
2982
|
# resource. For more information, see [Using Cost Allocation Tags in
|
2880
2983
|
# Amazon ElastiCache][1].
|
2881
2984
|
#
|
@@ -2912,6 +3015,8 @@ module Aws::ElastiCache
|
|
2912
3015
|
# resp.tag_list[0].key #=> String
|
2913
3016
|
# resp.tag_list[0].value #=> String
|
2914
3017
|
#
|
3018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ListTagsForResource AWS API Documentation
|
3019
|
+
#
|
2915
3020
|
# @overload list_tags_for_resource(params = {})
|
2916
3021
|
# @param [Hash] params ({})
|
2917
3022
|
def list_tags_for_resource(params = {}, options = {})
|
@@ -3271,6 +3376,8 @@ module Aws::ElastiCache
|
|
3271
3376
|
# resp.cache_cluster.snapshot_retention_limit #=> Integer
|
3272
3377
|
# resp.cache_cluster.snapshot_window #=> String
|
3273
3378
|
#
|
3379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheCluster AWS API Documentation
|
3380
|
+
#
|
3274
3381
|
# @overload modify_cache_cluster(params = {})
|
3275
3382
|
# @param [Hash] params ({})
|
3276
3383
|
def modify_cache_cluster(params = {}, options = {})
|
@@ -3311,6 +3418,8 @@ module Aws::ElastiCache
|
|
3311
3418
|
#
|
3312
3419
|
# resp.cache_parameter_group_name #=> String
|
3313
3420
|
#
|
3421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheParameterGroup AWS API Documentation
|
3422
|
+
#
|
3314
3423
|
# @overload modify_cache_parameter_group(params = {})
|
3315
3424
|
# @param [Hash] params ({})
|
3316
3425
|
def modify_cache_parameter_group(params = {}, options = {})
|
@@ -3356,6 +3465,8 @@ module Aws::ElastiCache
|
|
3356
3465
|
# resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
|
3357
3466
|
# resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
|
3358
3467
|
#
|
3468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheSubnetGroup AWS API Documentation
|
3469
|
+
#
|
3359
3470
|
# @overload modify_cache_subnet_group(params = {})
|
3360
3471
|
# @param [Hash] params ({})
|
3361
3472
|
def modify_cache_subnet_group(params = {}, options = {})
|
@@ -3526,6 +3637,9 @@ module Aws::ElastiCache
|
|
3526
3637
|
# A valid cache node type that you want to scale this replication group
|
3527
3638
|
# to.
|
3528
3639
|
#
|
3640
|
+
# @option params [String] :node_group_id
|
3641
|
+
# The name of the Node Group (called shard in the console).
|
3642
|
+
#
|
3529
3643
|
# @return [Types::ModifyReplicationGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3530
3644
|
#
|
3531
3645
|
# * {Types::ModifyReplicationGroupResult#replication_group #replication_group} => Types::ReplicationGroup
|
@@ -3550,6 +3664,7 @@ module Aws::ElastiCache
|
|
3550
3664
|
# snapshot_retention_limit: 1,
|
3551
3665
|
# snapshot_window: "String",
|
3552
3666
|
# cache_node_type: "String",
|
3667
|
+
# node_group_id: "String",
|
3553
3668
|
# })
|
3554
3669
|
#
|
3555
3670
|
# @example Response structure
|
@@ -3580,6 +3695,10 @@ module Aws::ElastiCache
|
|
3580
3695
|
# resp.replication_group.configuration_endpoint.port #=> Integer
|
3581
3696
|
# resp.replication_group.snapshot_retention_limit #=> Integer
|
3582
3697
|
# resp.replication_group.snapshot_window #=> String
|
3698
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
3699
|
+
# resp.replication_group.cache_node_type #=> String
|
3700
|
+
#
|
3701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroup AWS API Documentation
|
3583
3702
|
#
|
3584
3703
|
# @overload modify_replication_group(params = {})
|
3585
3704
|
# @param [Hash] params ({})
|
@@ -3640,6 +3759,8 @@ module Aws::ElastiCache
|
|
3640
3759
|
# resp.reserved_cache_node.recurring_charges[0].recurring_charge_amount #=> Float
|
3641
3760
|
# resp.reserved_cache_node.recurring_charges[0].recurring_charge_frequency #=> String
|
3642
3761
|
#
|
3762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/PurchaseReservedCacheNodesOffering AWS API Documentation
|
3763
|
+
#
|
3643
3764
|
# @overload purchase_reserved_cache_nodes_offering(params = {})
|
3644
3765
|
# @param [Hash] params ({})
|
3645
3766
|
def purchase_reserved_cache_nodes_offering(params = {}, options = {})
|
@@ -3724,6 +3845,8 @@ module Aws::ElastiCache
|
|
3724
3845
|
# resp.cache_cluster.snapshot_retention_limit #=> Integer
|
3725
3846
|
# resp.cache_cluster.snapshot_window #=> String
|
3726
3847
|
#
|
3848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RebootCacheCluster AWS API Documentation
|
3849
|
+
#
|
3727
3850
|
# @overload reboot_cache_cluster(params = {})
|
3728
3851
|
# @param [Hash] params ({})
|
3729
3852
|
def reboot_cache_cluster(params = {}, options = {})
|
@@ -3768,6 +3891,8 @@ module Aws::ElastiCache
|
|
3768
3891
|
# resp.tag_list[0].key #=> String
|
3769
3892
|
# resp.tag_list[0].value #=> String
|
3770
3893
|
#
|
3894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RemoveTagsFromResource AWS API Documentation
|
3895
|
+
#
|
3771
3896
|
# @overload remove_tags_from_resource(params = {})
|
3772
3897
|
# @param [Hash] params ({})
|
3773
3898
|
def remove_tags_from_resource(params = {}, options = {})
|
@@ -3818,6 +3943,8 @@ module Aws::ElastiCache
|
|
3818
3943
|
#
|
3819
3944
|
# resp.cache_parameter_group_name #=> String
|
3820
3945
|
#
|
3946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ResetCacheParameterGroup AWS API Documentation
|
3947
|
+
#
|
3821
3948
|
# @overload reset_cache_parameter_group(params = {})
|
3822
3949
|
# @param [Hash] params ({})
|
3823
3950
|
def reset_cache_parameter_group(params = {}, options = {})
|
@@ -3862,6 +3989,8 @@ module Aws::ElastiCache
|
|
3862
3989
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
|
3863
3990
|
# resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
|
3864
3991
|
#
|
3992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RevokeCacheSecurityGroupIngress AWS API Documentation
|
3993
|
+
#
|
3865
3994
|
# @overload revoke_cache_security_group_ingress(params = {})
|
3866
3995
|
# @param [Hash] params ({})
|
3867
3996
|
def revoke_cache_security_group_ingress(params = {}, options = {})
|
@@ -3869,6 +3998,121 @@ module Aws::ElastiCache
|
|
3869
3998
|
req.send_request(options)
|
3870
3999
|
end
|
3871
4000
|
|
4001
|
+
# Represents the input of a `TestFailover` operation which test
|
4002
|
+
# automatic failover on a specified node group (called shard in the
|
4003
|
+
# console) in a replication group (called cluster in the console).
|
4004
|
+
#
|
4005
|
+
# **Note the following**
|
4006
|
+
#
|
4007
|
+
# * A customer can use this operation to test automatic failover on up
|
4008
|
+
# to 5 shards (called node groups in the ElastiCache API and AWS CLI)
|
4009
|
+
# in any rolling 24-hour period.
|
4010
|
+
#
|
4011
|
+
# * If calling this operation on shards in different clusters (called
|
4012
|
+
# replication groups in the API and CLI), the calls can be made
|
4013
|
+
# concurrently.
|
4014
|
+
#
|
4015
|
+
#
|
4016
|
+
#
|
4017
|
+
# * If calling this operation multiple times on different shards in the
|
4018
|
+
# same Redis (cluster mode enabled) replication group, the first node
|
4019
|
+
# replacement must complete before a subsequent call can be made.
|
4020
|
+
#
|
4021
|
+
# * To determine whether the node replacement is complete you can check
|
4022
|
+
# Events using the Amazon ElastiCache console, the AWS CLI, or the
|
4023
|
+
# ElastiCache API. Look for the following automatic failover related
|
4024
|
+
# events, listed here in order of occurrance:
|
4025
|
+
#
|
4026
|
+
# 1. Replication group message: `Test Failover API called for node
|
4027
|
+
# group <node-group-id>`
|
4028
|
+
#
|
4029
|
+
# 2. Cache cluster message: `Failover from master node
|
4030
|
+
# <primary-node-id> to replica node <node-id> completed`
|
4031
|
+
#
|
4032
|
+
# 3. Replication group message: `Failover from master node
|
4033
|
+
# <primary-node-id> to replica node <node-id> completed`
|
4034
|
+
#
|
4035
|
+
# 4. Cache cluster message: `Recovering cache nodes <node-id>`
|
4036
|
+
#
|
4037
|
+
# 5. Cache cluster message: `Finished recovery for cache nodes
|
4038
|
+
# <node-id>`
|
4039
|
+
#
|
4040
|
+
# For more information see:
|
4041
|
+
#
|
4042
|
+
# * [Viewing ElastiCache Events][1] in the *ElastiCache User Guide*
|
4043
|
+
#
|
4044
|
+
# * [DescribeEvents][2] in the ElastiCache API Reference
|
4045
|
+
#
|
4046
|
+
# Also see, [Testing Multi-AZ with Automatic Failover][3] in the
|
4047
|
+
# *ElastiCache User Guide*.
|
4048
|
+
#
|
4049
|
+
#
|
4050
|
+
#
|
4051
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/ECEvents.Viewing.html
|
4052
|
+
# [2]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html
|
4053
|
+
# [3]: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoFailover.html#auto-failover-test
|
4054
|
+
#
|
4055
|
+
# @option params [required, String] :replication_group_id
|
4056
|
+
# The name of the replication group (console: cluster) whose automatic
|
4057
|
+
# failover is being tested by this operation.
|
4058
|
+
#
|
4059
|
+
# @option params [required, String] :node_group_id
|
4060
|
+
# The name of the node group (called shard in the console) in this
|
4061
|
+
# replication group on which automatic failover is to be tested. You may
|
4062
|
+
# test automatic failover on up to 5 node groups in any rolling 24-hour
|
4063
|
+
# period.
|
4064
|
+
#
|
4065
|
+
# @return [Types::TestFailoverResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4066
|
+
#
|
4067
|
+
# * {Types::TestFailoverResult#replication_group #replication_group} => Types::ReplicationGroup
|
4068
|
+
#
|
4069
|
+
# @example Request syntax with placeholder values
|
4070
|
+
#
|
4071
|
+
# resp = client.test_failover({
|
4072
|
+
# replication_group_id: "String", # required
|
4073
|
+
# node_group_id: "String", # required
|
4074
|
+
# })
|
4075
|
+
#
|
4076
|
+
# @example Response structure
|
4077
|
+
#
|
4078
|
+
# resp.replication_group.replication_group_id #=> String
|
4079
|
+
# resp.replication_group.description #=> String
|
4080
|
+
# resp.replication_group.status #=> String
|
4081
|
+
# resp.replication_group.pending_modified_values.primary_cluster_id #=> String
|
4082
|
+
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
4083
|
+
# resp.replication_group.member_clusters #=> Array
|
4084
|
+
# resp.replication_group.member_clusters[0] #=> String
|
4085
|
+
# resp.replication_group.node_groups #=> Array
|
4086
|
+
# resp.replication_group.node_groups[0].node_group_id #=> String
|
4087
|
+
# resp.replication_group.node_groups[0].status #=> String
|
4088
|
+
# resp.replication_group.node_groups[0].primary_endpoint.address #=> String
|
4089
|
+
# resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
|
4090
|
+
# resp.replication_group.node_groups[0].slots #=> String
|
4091
|
+
# resp.replication_group.node_groups[0].node_group_members #=> Array
|
4092
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
|
4093
|
+
# resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
|
4094
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
4095
|
+
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
4096
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
4097
|
+
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
4098
|
+
# resp.replication_group.snapshotting_cluster_id #=> String
|
4099
|
+
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
4100
|
+
# resp.replication_group.configuration_endpoint.address #=> String
|
4101
|
+
# resp.replication_group.configuration_endpoint.port #=> Integer
|
4102
|
+
# resp.replication_group.snapshot_retention_limit #=> Integer
|
4103
|
+
# resp.replication_group.snapshot_window #=> String
|
4104
|
+
# resp.replication_group.cluster_enabled #=> Boolean
|
4105
|
+
# resp.replication_group.cache_node_type #=> String
|
4106
|
+
#
|
4107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/TestFailover AWS API Documentation
|
4108
|
+
#
|
4109
|
+
# @overload test_failover(params = {})
|
4110
|
+
# @param [Hash] params ({})
|
4111
|
+
def test_failover(params = {}, options = {})
|
4112
|
+
req = build_request(:test_failover, params)
|
4113
|
+
req.send_request(options)
|
4114
|
+
end
|
4115
|
+
|
3872
4116
|
# @!endgroup
|
3873
4117
|
|
3874
4118
|
# @param params ({})
|
@@ -3882,7 +4126,7 @@ module Aws::ElastiCache
|
|
3882
4126
|
params: params,
|
3883
4127
|
config: config)
|
3884
4128
|
context[:gem_name] = 'aws-sdk-elasticache'
|
3885
|
-
context[:gem_version] = '1.0.0.
|
4129
|
+
context[:gem_version] = '1.0.0.rc3'
|
3886
4130
|
Seahorse::Client::Request.new(handlers, context)
|
3887
4131
|
end
|
3888
4132
|
|