aws-sdk-elasticache 1.50.0 → 1.55.0

Sign up to get free protection for your applications and to get access to all the features.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.55.0
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-elasticache/customizations'
49
49
  # @!group service
50
50
  module Aws::ElastiCache
51
51
 
52
- GEM_VERSION = '1.50.0'
52
+ GEM_VERSION = '1.55.0'
53
53
 
54
54
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -327,22 +327,27 @@ module Aws::ElastiCache
327
327
 
328
328
  # @!group API Operations
329
329
 
330
- # Adds up to 50 cost allocation tags to the named resource. A cost
331
- # allocation tag is a key-value pair where the key and value are
332
- # case-sensitive. You can use cost allocation tags to categorize and
333
- # track your AWS costs.
330
+ # A tag is a key-value pair where the key and value are case-sensitive.
331
+ # You can use tags to categorize and track all your ElastiCache
332
+ # resources, with the exception of global replication group. When you
333
+ # add or remove tags on replication groups, those actions will be
334
+ # replicated to all nodes in the replication group. For more
335
+ # information, see [Resource-level permissions][1].
334
336
  #
335
- # When you apply tags to your ElastiCache resources, AWS generates a
336
- # cost allocation report as a comma-separated value (CSV) file with your
337
- # usage and costs aggregated by your tags. You can apply tags that
338
- # represent business categories (such as cost centers, application
339
- # names, or owners) to organize your costs across multiple services. For
340
- # more information, see [Using Cost Allocation Tags in Amazon
341
- # ElastiCache][1] in the *ElastiCache User Guide*.
337
+ # For example, you can use cost-allocation tags to your ElastiCache
338
+ # resources, AWS generates a cost allocation report as a comma-separated
339
+ # value (CSV) file with your usage and costs aggregated by your tags.
340
+ # You can apply tags that represent business categories (such as cost
341
+ # centers, application names, or owners) to organize your costs across
342
+ # multiple services.
342
343
  #
344
+ # For more information, see [Using Cost Allocation Tags in Amazon
345
+ # ElastiCache][2] in the *ElastiCache User Guide*.
343
346
  #
344
347
  #
345
- # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html
348
+ #
349
+ # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html
350
+ # [2]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html
346
351
  #
347
352
  # @option params [required, String] :resource_name
348
353
  # The Amazon Resource Name (ARN) of the resource to which the tags are
@@ -359,8 +364,9 @@ module Aws::ElastiCache
359
364
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
360
365
  #
361
366
  # @option params [required, Array<Types::Tag>] :tags
362
- # A list of cost allocation tags to be added to this resource. A tag is
363
- # a key-value pair. A tag key must be accompanied by a tag value.
367
+ # A list of tags to be added to this resource. A tag is a key-value
368
+ # pair. A tag key must be accompanied by a tag value, although null is
369
+ # accepted.
364
370
  #
365
371
  # @return [Types::TagListMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
366
372
  #
@@ -779,12 +785,17 @@ module Aws::ElastiCache
779
785
  #
780
786
  #
781
787
  #
782
- # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access
783
- # [2]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html
788
+ # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access
789
+ # [2]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html
784
790
  #
785
791
  # @option params [String] :kms_key_id
786
792
  # The ID of the KMS key used to encrypt the target snapshot.
787
793
  #
794
+ # @option params [Array<Types::Tag>] :tags
795
+ # A list of tags to be added to this resource. A tag is a key-value
796
+ # pair. A tag key must be accompanied by a tag value, although null is
797
+ # accepted.
798
+ #
788
799
  # @return [Types::CopySnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
789
800
  #
790
801
  # * {Types::CopySnapshotResult#snapshot #snapshot} => Types::Snapshot
@@ -839,6 +850,12 @@ module Aws::ElastiCache
839
850
  # target_snapshot_name: "String", # required
840
851
  # target_bucket: "String",
841
852
  # kms_key_id: "String",
853
+ # tags: [
854
+ # {
855
+ # key: "String",
856
+ # value: "String",
857
+ # },
858
+ # ],
842
859
  # })
843
860
  #
844
861
  # @example Response structure
@@ -1137,7 +1154,7 @@ module Aws::ElastiCache
1137
1154
  # Virtual Private Cloud (Amazon VPC).
1138
1155
  #
1139
1156
  # @option params [Array<Types::Tag>] :tags
1140
- # A list of cost allocation tags to be added to this resource.
1157
+ # A list of tags to be added to this resource.
1141
1158
  #
1142
1159
  # @option params [Array<String>] :snapshot_arns
1143
1160
  # A single-element string list containing an Amazon Resource Name (ARN)
@@ -1166,29 +1183,6 @@ module Aws::ElastiCache
1166
1183
  # ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
1167
1184
  # window is a 60 minute period. Valid values for `ddd` are:
1168
1185
  #
1169
- # Specifies the weekly time range during which maintenance on the
1170
- # cluster is performed. It is specified as a range in the format
1171
- # ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
1172
- # window is a 60 minute period.
1173
- #
1174
- # Valid values for `ddd` are:
1175
- #
1176
- # * `sun`
1177
- #
1178
- # * `mon`
1179
- #
1180
- # * `tue`
1181
- #
1182
- # * `wed`
1183
- #
1184
- # * `thu`
1185
- #
1186
- # * `fri`
1187
- #
1188
- # * `sat`
1189
- #
1190
- # Example: `sun:23:00-mon:01:30`
1191
- #
1192
1186
  # @option params [Integer] :port
1193
1187
  # The port number on which each of the cache nodes accepts connections.
1194
1188
  #
@@ -1486,6 +1480,11 @@ module Aws::ElastiCache
1486
1480
  # @option params [required, String] :description
1487
1481
  # A user-specified description for the cache parameter group.
1488
1482
  #
1483
+ # @option params [Array<Types::Tag>] :tags
1484
+ # A list of tags to be added to this resource. A tag is a key-value
1485
+ # pair. A tag key must be accompanied by a tag value, although null is
1486
+ # accepted.
1487
+ #
1489
1488
  # @return [Types::CreateCacheParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1490
1489
  #
1491
1490
  # * {Types::CreateCacheParameterGroupResult#cache_parameter_group #cache_parameter_group} => Types::CacheParameterGroup
@@ -1516,6 +1515,12 @@ module Aws::ElastiCache
1516
1515
  # cache_parameter_group_name: "String", # required
1517
1516
  # cache_parameter_group_family: "String", # required
1518
1517
  # description: "String", # required
1518
+ # tags: [
1519
+ # {
1520
+ # key: "String",
1521
+ # value: "String",
1522
+ # },
1523
+ # ],
1519
1524
  # })
1520
1525
  #
1521
1526
  # @example Response structure
@@ -1559,6 +1564,11 @@ module Aws::ElastiCache
1559
1564
  # @option params [required, String] :description
1560
1565
  # A description for the cache security group.
1561
1566
  #
1567
+ # @option params [Array<Types::Tag>] :tags
1568
+ # A list of tags to be added to this resource. A tag is a key-value
1569
+ # pair. A tag key must be accompanied by a tag value, although null is
1570
+ # accepted.
1571
+ #
1562
1572
  # @return [Types::CreateCacheSecurityGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1563
1573
  #
1564
1574
  # * {Types::CreateCacheSecurityGroupResult#cache_security_group #cache_security_group} => Types::CacheSecurityGroup
@@ -1578,6 +1588,12 @@ module Aws::ElastiCache
1578
1588
  # resp = client.create_cache_security_group({
1579
1589
  # cache_security_group_name: "String", # required
1580
1590
  # description: "String", # required
1591
+ # tags: [
1592
+ # {
1593
+ # key: "String",
1594
+ # value: "String",
1595
+ # },
1596
+ # ],
1581
1597
  # })
1582
1598
  #
1583
1599
  # @example Response structure
@@ -1620,6 +1636,11 @@ module Aws::ElastiCache
1620
1636
  # @option params [required, Array<String>] :subnet_ids
1621
1637
  # A list of VPC subnet IDs for the cache subnet group.
1622
1638
  #
1639
+ # @option params [Array<Types::Tag>] :tags
1640
+ # A list of tags to be added to this resource. A tag is a key-value
1641
+ # pair. A tag key must be accompanied by a tag value, although null is
1642
+ # accepted.
1643
+ #
1623
1644
  # @return [Types::CreateCacheSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1624
1645
  #
1625
1646
  # * {Types::CreateCacheSubnetGroupResult#cache_subnet_group #cache_subnet_group} => Types::CacheSubnetGroup
@@ -1674,6 +1695,12 @@ module Aws::ElastiCache
1674
1695
  # cache_subnet_group_name: "String", # required
1675
1696
  # cache_subnet_group_description: "String", # required
1676
1697
  # subnet_ids: ["String"], # required
1698
+ # tags: [
1699
+ # {
1700
+ # key: "String",
1701
+ # value: "String",
1702
+ # },
1703
+ # ],
1677
1704
  # })
1678
1705
  #
1679
1706
  # @example Response structure
@@ -1704,7 +1731,7 @@ module Aws::ElastiCache
1704
1731
  # Global Datastore][1].
1705
1732
  #
1706
1733
  # * The **GlobalReplicationGroupIdSuffix** is the name of the Global
1707
- # Datastore.
1734
+ # datastore.
1708
1735
  #
1709
1736
  # * The **PrimaryReplicationGroupId** represents the name of the primary
1710
1737
  # cluster that accepts writes and will replicate updates to the
@@ -1715,23 +1742,23 @@ module Aws::ElastiCache
1715
1742
  # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html
1716
1743
  #
1717
1744
  # @option params [required, String] :global_replication_group_id_suffix
1718
- # The suffix name of a Global Datastore. Amazon ElastiCache
1719
- # automatically applies a prefix to the Global Datastore ID when it is
1745
+ # The suffix name of a Global datastore. Amazon ElastiCache
1746
+ # automatically applies a prefix to the Global datastore ID when it is
1720
1747
  # created. Each AWS Region has its own prefix. For instance, a Global
1721
- # Datastore ID created in the US-West-1 region will begin with "dsdfu"
1748
+ # datastore ID created in the US-West-1 region will begin with "dsdfu"
1722
1749
  # along with the suffix name you provide. The suffix, combined with the
1723
- # auto-generated prefix, guarantees uniqueness of the Global Datastore
1750
+ # auto-generated prefix, guarantees uniqueness of the Global datastore
1724
1751
  # name across multiple regions.
1725
1752
  #
1726
- # For a full list of AWS Regions and their respective Global Datastore
1727
- # iD prefixes, see [Using the AWS CLI with Global Datastores ][1].
1753
+ # For a full list of AWS Regions and their respective Global datastore
1754
+ # iD prefixes, see [Using the AWS CLI with Global datastores ][1].
1728
1755
  #
1729
1756
  #
1730
1757
  #
1731
1758
  # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html
1732
1759
  #
1733
1760
  # @option params [String] :global_replication_group_description
1734
- # Provides details of the Global Datastore
1761
+ # Provides details of the Global datastore
1735
1762
  #
1736
1763
  # @option params [required, String] :primary_replication_group_id
1737
1764
  # The name of the primary cluster that accepts writes and will replicate
@@ -1785,26 +1812,39 @@ module Aws::ElastiCache
1785
1812
  # enabled) replication group.
1786
1813
  #
1787
1814
  # This API can be used to create a standalone regional replication group
1788
- # or a secondary replication group associated with a Global Datastore.
1815
+ # or a secondary replication group associated with a Global datastore.
1789
1816
  #
1790
1817
  # A Redis (cluster mode disabled) replication group is a collection of
1791
1818
  # clusters, where one of the clusters is a read/write primary and the
1792
1819
  # others are read-only replicas. Writes to the primary are
1793
1820
  # asynchronously propagated to the replicas.
1794
1821
  #
1795
- # A Redis (cluster mode enabled) replication group is a collection of 1
1796
- # to 90 node groups (shards). Each node group (shard) has one read/write
1797
- # primary node and up to 5 read-only replica nodes. Writes to the
1798
- # primary are asynchronously propagated to the replicas. Redis (cluster
1799
- # mode enabled) replication groups partition the data across node groups
1800
- # (shards).
1822
+ # A Redis cluster-mode enabled cluster is comprised of from 1 to 90
1823
+ # shards (API/CLI: node groups). Each shard has a primary node and up to
1824
+ # 5 read-only replica nodes. The configuration can range from 90 shards
1825
+ # and 0 replicas to 15 shards and 5 replicas, which is the maximum
1826
+ # number or replicas allowed.
1827
+ #
1828
+ # The node or shard limit can be increased to a maximum of 500 per
1829
+ # cluster if the Redis engine version is 5.0.6 or higher. For example,
1830
+ # you can choose to configure a 500 node cluster that ranges between 83
1831
+ # shards (one primary and 5 replicas per shard) and 500 shards (single
1832
+ # primary and no replicas). Make sure there are enough available IP
1833
+ # addresses to accommodate the increase. Common pitfalls include the
1834
+ # subnets in the subnet group have too small a CIDR range or the subnets
1835
+ # are shared and heavily used by other clusters. For more information,
1836
+ # see [Creating a Subnet Group][1]. For versions below 5.0.6, the limit
1837
+ # is 250 per cluster.
1838
+ #
1839
+ # To request a limit increase, see [AWS Service Limits][2] and choose
1840
+ # the limit type **Nodes per cluster per instance type**.
1801
1841
  #
1802
1842
  # When a Redis (cluster mode disabled) replication group has been
1803
1843
  # successfully created, you can add one or more read replicas to it, up
1804
1844
  # to a total of 5 read replicas. If you need to increase or decrease the
1805
1845
  # number of node groups (console: shards), you can avail yourself of
1806
1846
  # ElastiCache for Redis' scaling. For more information, see [Scaling
1807
- # ElastiCache for Redis Clusters][1] in the *ElastiCache User Guide*.
1847
+ # ElastiCache for Redis Clusters][3] in the *ElastiCache User Guide*.
1808
1848
  #
1809
1849
  # <note markdown="1"> This operation is valid for Redis only.
1810
1850
  #
@@ -1812,7 +1852,9 @@ module Aws::ElastiCache
1812
1852
  #
1813
1853
  #
1814
1854
  #
1815
- # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html
1855
+ # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html
1856
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html
1857
+ # [3]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html
1816
1858
  #
1817
1859
  # @option params [required, String] :replication_group_id
1818
1860
  # The replication group identifier. This parameter is stored as a
@@ -1830,7 +1872,7 @@ module Aws::ElastiCache
1830
1872
  # A user-created description for the replication group.
1831
1873
  #
1832
1874
  # @option params [String] :global_replication_group_id
1833
- # The name of the Global Datastore
1875
+ # The name of the Global datastore
1834
1876
  #
1835
1877
  # @option params [String] :primary_cluster_id
1836
1878
  # The identifier of the cluster that serves as the primary for this
@@ -2022,7 +2064,7 @@ module Aws::ElastiCache
2022
2064
  #
2023
2065
  # @option params [String] :engine
2024
2066
  # The name of the cache engine to be used for the clusters in this
2025
- # replication group.
2067
+ # replication group. Must be Redis.
2026
2068
  #
2027
2069
  # @option params [String] :engine_version
2028
2070
  # The version number of the cache engine to be used for the clusters in
@@ -2045,12 +2087,6 @@ module Aws::ElastiCache
2045
2087
  # group. If this argument is omitted, the default cache parameter group
2046
2088
  # for the specified engine is used.
2047
2089
  #
2048
- # <note markdown="1"> If you are restoring to an engine version that is different than the
2049
- # original, you must specify the default version of that version. For
2050
- # example, `CacheParameterGroupName=default.redis4.0`.
2051
- #
2052
- # </note>
2053
- #
2054
2090
  # If you are running Redis version 3.2.4 or later, only one node group
2055
2091
  # (shard), and want to use a default parameter group, we recommend that
2056
2092
  # you specify the parameter group by name.
@@ -2085,10 +2121,11 @@ module Aws::ElastiCache
2085
2121
  # an Amazon Virtual Private Cloud (Amazon VPC).
2086
2122
  #
2087
2123
  # @option params [Array<Types::Tag>] :tags
2088
- # A list of cost allocation tags to be added to this resource. Tags are
2089
- # comma-separated key,value pairs (e.g. Key=`myKey`, Value=`myKeyValue`.
2090
- # You can include multiple tags as shown following: Key=`myKey`,
2091
- # Value=`myKeyValue` Key=`mySecondKey`, Value=`mySecondKeyValue`.
2124
+ # A list of tags to be added to this resource. Tags are comma-separated
2125
+ # key,value pairs (e.g. Key=`myKey`, Value=`myKeyValue`. You can include
2126
+ # multiple tags as shown following: Key=`myKey`, Value=`myKeyValue`
2127
+ # Key=`mySecondKey`, Value=`mySecondKeyValue`. Tags on replication
2128
+ # groups will be replicated to all nodes.
2092
2129
  #
2093
2130
  # @option params [Array<String>] :snapshot_arns
2094
2131
  # A list of Amazon Resource Names (ARN) that uniquely identify the Redis
@@ -2468,6 +2505,11 @@ module Aws::ElastiCache
2468
2505
  # @option params [String] :kms_key_id
2469
2506
  # The ID of the KMS key used to encrypt the snapshot.
2470
2507
  #
2508
+ # @option params [Array<Types::Tag>] :tags
2509
+ # A list of tags to be added to this resource. A tag is a key-value
2510
+ # pair. A tag key must be accompanied by a tag value, although null is
2511
+ # accepted.
2512
+ #
2471
2513
  # @return [Types::CreateSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2472
2514
  #
2473
2515
  # * {Types::CreateSnapshotResult#snapshot #snapshot} => Types::Snapshot
@@ -2604,6 +2646,12 @@ module Aws::ElastiCache
2604
2646
  # cache_cluster_id: "String",
2605
2647
  # snapshot_name: "String", # required
2606
2648
  # kms_key_id: "String",
2649
+ # tags: [
2650
+ # {
2651
+ # key: "String",
2652
+ # value: "String",
2653
+ # },
2654
+ # ],
2607
2655
  # })
2608
2656
  #
2609
2657
  # @example Response structure
@@ -2686,6 +2734,11 @@ module Aws::ElastiCache
2686
2734
  # @option params [Boolean] :no_password_required
2687
2735
  # Indicates a password is not required for this user.
2688
2736
  #
2737
+ # @option params [Array<Types::Tag>] :tags
2738
+ # A list of tags to be added to this resource. A tag is a key-value
2739
+ # pair. A tag key must be accompanied by a tag value, although null is
2740
+ # accepted.
2741
+ #
2689
2742
  # @return [Types::User] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2690
2743
  #
2691
2744
  # * {Types::User#user_id #user_id} => String
@@ -2706,6 +2759,12 @@ module Aws::ElastiCache
2706
2759
  # passwords: ["String"],
2707
2760
  # access_string: "AccessString", # required
2708
2761
  # no_password_required: false,
2762
+ # tags: [
2763
+ # {
2764
+ # key: "String",
2765
+ # value: "String",
2766
+ # },
2767
+ # ],
2709
2768
  # })
2710
2769
  #
2711
2770
  # @example Response structure
@@ -2746,6 +2805,11 @@ module Aws::ElastiCache
2746
2805
  # @option params [Array<String>] :user_ids
2747
2806
  # The list of user IDs that belong to the user group.
2748
2807
  #
2808
+ # @option params [Array<Types::Tag>] :tags
2809
+ # A list of tags to be added to this resource. A tag is a key-value
2810
+ # pair. A tag key must be accompanied by a tag value, although null is
2811
+ # accepted.
2812
+ #
2749
2813
  # @return [Types::UserGroup] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2750
2814
  #
2751
2815
  # * {Types::UserGroup#user_group_id #user_group_id} => String
@@ -2762,6 +2826,12 @@ module Aws::ElastiCache
2762
2826
  # user_group_id: "String", # required
2763
2827
  # engine: "EngineType", # required
2764
2828
  # user_ids: ["UserId"],
2829
+ # tags: [
2830
+ # {
2831
+ # key: "String",
2832
+ # value: "String",
2833
+ # },
2834
+ # ],
2765
2835
  # })
2766
2836
  #
2767
2837
  # @example Response structure
@@ -2788,10 +2858,10 @@ module Aws::ElastiCache
2788
2858
  req.send_request(options)
2789
2859
  end
2790
2860
 
2791
- # Decreases the number of node groups in a Global Datastore
2861
+ # Decreases the number of node groups in a Global datastore
2792
2862
  #
2793
2863
  # @option params [required, String] :global_replication_group_id
2794
- # The name of the Global Datastore
2864
+ # The name of the Global datastore
2795
2865
  #
2796
2866
  # @option params [required, Integer] :node_group_count
2797
2867
  # The number of node groups (shards) that results from the modification
@@ -3212,8 +3282,8 @@ module Aws::ElastiCache
3212
3282
 
3213
3283
  # Deletes a cache subnet group.
3214
3284
  #
3215
- # <note markdown="1"> You cannot delete a cache subnet group if it is associated with any
3216
- # clusters.
3285
+ # <note markdown="1"> You cannot delete a default cache subnet group or one that is
3286
+ # associated with any clusters.
3217
3287
  #
3218
3288
  # </note>
3219
3289
  #
@@ -3249,25 +3319,28 @@ module Aws::ElastiCache
3249
3319
  req.send_request(options)
3250
3320
  end
3251
3321
 
3252
- # Deleting a Global Datastore is a two-step process:
3322
+ # Deleting a Global datastore is a two-step process:
3253
3323
  #
3254
3324
  # * First, you must DisassociateGlobalReplicationGroup to remove the
3255
- # secondary clusters in the Global Datastore.
3325
+ # secondary clusters in the Global datastore.
3256
3326
  #
3257
- # * Once the Global Datastore contains only the primary cluster, you can
3258
- # use DeleteGlobalReplicationGroup API to delete the Global Datastore
3259
- # while retainining the primary cluster using Retain…= true.
3327
+ # * Once the Global datastore contains only the primary cluster, you can
3328
+ # use the `DeleteGlobalReplicationGroup` API to delete the Global
3329
+ # datastore while retainining the primary cluster using
3330
+ # `RetainPrimaryReplicationGroup=true`.
3260
3331
  #
3261
3332
  # Since the Global Datastore has only a primary cluster, you can delete
3262
3333
  # the Global Datastore while retaining the primary by setting
3263
- # `RetainPrimaryCluster=true`.
3334
+ # `RetainPrimaryReplicationGroup=true`. The primary cluster is never
3335
+ # deleted when deleting a Global Datastore. It can only be deleted when
3336
+ # it no longer is associated with any Global Datastore.
3264
3337
  #
3265
3338
  # When you receive a successful response from this operation, Amazon
3266
3339
  # ElastiCache immediately begins deleting the selected resources; you
3267
3340
  # cannot cancel or revert this operation.
3268
3341
  #
3269
3342
  # @option params [required, String] :global_replication_group_id
3270
- # The name of the Global Datastore
3343
+ # The name of the Global datastore
3271
3344
  #
3272
3345
  # @option params [required, Boolean] :retain_primary_replication_group
3273
3346
  # The primary replication group is retained as a standalone replication
@@ -3608,8 +3681,8 @@ module Aws::ElastiCache
3608
3681
  req.send_request(options)
3609
3682
  end
3610
3683
 
3611
- # For Redis engine version 6.x onwards: Deletes a ser group. The user
3612
- # group must first be disassociated from the replcation group before it
3684
+ # For Redis engine version 6.x onwards: Deletes a user group. The user
3685
+ # group must first be disassociated from the replication group before it
3613
3686
  # can be deleted. For more information, see [Using Role Based Access
3614
3687
  # Control (RBAC)][1].
3615
3688
  #
@@ -5777,10 +5850,10 @@ module Aws::ElastiCache
5777
5850
 
5778
5851
  # Returns information about a particular global replication group. If no
5779
5852
  # identifier is specified, returns information about all Global
5780
- # Datastores.
5853
+ # datastores.
5781
5854
  #
5782
5855
  # @option params [String] :global_replication_group_id
5783
- # The name of the Global Datastore
5856
+ # The name of the Global datastore
5784
5857
  #
5785
5858
  # @option params [Integer] :max_records
5786
5859
  # The maximum number of records to include in the response. If more
@@ -5795,7 +5868,7 @@ module Aws::ElastiCache
5795
5868
  # the value specified by `MaxRecords`.
5796
5869
  #
5797
5870
  # @option params [Boolean] :show_member_info
5798
- # Returns the list of members that comprise the Global Datastore.
5871
+ # Returns the list of members that comprise the Global datastore.
5799
5872
  #
5800
5873
  # @return [Types::DescribeGlobalReplicationGroupsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5801
5874
  #
@@ -7203,21 +7276,21 @@ module Aws::ElastiCache
7203
7276
  req.send_request(options)
7204
7277
  end
7205
7278
 
7206
- # Remove a secondary cluster from the Global Datastore using the Global
7207
- # Datastore name. The secondary cluster will no longer receive updates
7279
+ # Remove a secondary cluster from the Global datastore using the Global
7280
+ # datastore name. The secondary cluster will no longer receive updates
7208
7281
  # from the primary cluster, but will remain as a standalone cluster in
7209
7282
  # that AWS region.
7210
7283
  #
7211
7284
  # @option params [required, String] :global_replication_group_id
7212
- # The name of the Global Datastore
7285
+ # The name of the Global datastore
7213
7286
  #
7214
7287
  # @option params [required, String] :replication_group_id
7215
7288
  # The name of the secondary cluster you wish to remove from the Global
7216
- # Datastore
7289
+ # datastore
7217
7290
  #
7218
7291
  # @option params [required, String] :replication_group_region
7219
7292
  # The AWS region of secondary cluster you wish to remove from the Global
7220
- # Datastore
7293
+ # datastore
7221
7294
  #
7222
7295
  # @return [Types::DisassociateGlobalReplicationGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7223
7296
  #
@@ -7268,10 +7341,10 @@ module Aws::ElastiCache
7268
7341
  # clusters will become secondary.
7269
7342
  #
7270
7343
  # @option params [required, String] :global_replication_group_id
7271
- # The name of the Global Datastore
7344
+ # The name of the Global datastore
7272
7345
  #
7273
7346
  # @option params [required, String] :primary_region
7274
- # The AWS region of the primary cluster of the Global Datastore
7347
+ # The AWS region of the primary cluster of the Global datastore
7275
7348
  #
7276
7349
  # @option params [required, String] :primary_replication_group_id
7277
7350
  # The name of the primary replication group
@@ -7320,10 +7393,10 @@ module Aws::ElastiCache
7320
7393
  req.send_request(options)
7321
7394
  end
7322
7395
 
7323
- # Increase the number of node groups in the Global Datastore
7396
+ # Increase the number of node groups in the Global datastore
7324
7397
  #
7325
7398
  # @option params [required, String] :global_replication_group_id
7326
- # The name of the Global Datastore
7399
+ # The name of the Global datastore
7327
7400
  #
7328
7401
  # @option params [required, Integer] :node_group_count
7329
7402
  # The number of node groups you wish to add
@@ -7331,7 +7404,7 @@ module Aws::ElastiCache
7331
7404
  # @option params [Array<Types::RegionalConfiguration>] :regional_configurations
7332
7405
  # Describes the replication group IDs, the AWS regions where they are
7333
7406
  # stored and the shard configuration for each that comprise the Global
7334
- # Datastore
7407
+ # datastore
7335
7408
  #
7336
7409
  # @option params [required, Boolean] :apply_immediately
7337
7410
  # Indicates that the process begins immediately. At present, the only
@@ -7393,7 +7466,7 @@ module Aws::ElastiCache
7393
7466
  req.send_request(options)
7394
7467
  end
7395
7468
 
7396
- # Dynamically increases the number of replics in a Redis (cluster mode
7469
+ # Dynamically increases the number of replicas in a Redis (cluster mode
7397
7470
  # disabled) replication group or the number of replica nodes in one or
7398
7471
  # more node groups (shards) of a Redis (cluster mode enabled)
7399
7472
  # replication group. This operation is performed with no cluster down
@@ -7593,20 +7666,21 @@ module Aws::ElastiCache
7593
7666
  req.send_request(options)
7594
7667
  end
7595
7668
 
7596
- # Lists all cost allocation tags currently on the named resource. A
7597
- # `cost allocation tag` is a key-value pair where the key is
7598
- # case-sensitive and the value is optional. You can use cost allocation
7599
- # tags to categorize and track your AWS costs.
7669
+ # Lists all tags currently on a named resource.
7670
+ #
7671
+ # A tag is a key-value pair where the key and value are case-sensitive.
7672
+ # You can use tags to categorize and track all your ElastiCache
7673
+ # resources, with the exception of global replication group. When you
7674
+ # add or remove tags on replication groups, those actions will be
7675
+ # replicated to all nodes in the replication group. For more
7676
+ # information, see [Resource-level permissions][1].
7600
7677
  #
7601
7678
  # If the cluster is not in the *available* state, `ListTagsForResource`
7602
7679
  # returns an error.
7603
7680
  #
7604
- # You can have a maximum of 50 cost allocation tags on an ElastiCache
7605
- # resource. For more information, see [Monitoring Costs with Tags][1].
7606
7681
  #
7607
7682
  #
7608
- #
7609
- # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html
7683
+ # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html
7610
7684
  #
7611
7685
  # @option params [required, String] :resource_name
7612
7686
  # The Amazon Resource Name (ARN) of the resource for which you want the
@@ -8273,10 +8347,10 @@ module Aws::ElastiCache
8273
8347
  req.send_request(options)
8274
8348
  end
8275
8349
 
8276
- # Modifies the settings for a Global Datastore.
8350
+ # Modifies the settings for a Global datastore.
8277
8351
  #
8278
8352
  # @option params [required, String] :global_replication_group_id
8279
- # The name of the Global Datastore
8353
+ # The name of the Global datastore
8280
8354
  #
8281
8355
  # @option params [required, Boolean] :apply_immediately
8282
8356
  # This parameter causes the modifications in this request and any
@@ -8285,15 +8359,20 @@ module Aws::ElastiCache
8285
8359
  # requested to be applied in PreferredMaintenceWindow.
8286
8360
  #
8287
8361
  # @option params [String] :cache_node_type
8288
- # A valid cache node type that you want to scale this Global Datastore
8362
+ # A valid cache node type that you want to scale this Global datastore
8289
8363
  # to.
8290
8364
  #
8291
8365
  # @option params [String] :engine_version
8292
8366
  # The upgraded version of the cache engine to be run on the clusters in
8293
- # the Global Datastore.
8367
+ # the Global datastore.
8368
+ #
8369
+ # @option params [String] :cache_parameter_group_name
8370
+ # The name of the cache parameter group to use with the Global
8371
+ # datastore. It must be compatible with the major engine version used by
8372
+ # the Global datastore.
8294
8373
  #
8295
8374
  # @option params [String] :global_replication_group_description
8296
- # A description of the Global Datastore
8375
+ # A description of the Global datastore
8297
8376
  #
8298
8377
  # @option params [Boolean] :automatic_failover_enabled
8299
8378
  # Determines whether a read replica is automatically promoted to
@@ -8310,6 +8389,7 @@ module Aws::ElastiCache
8310
8389
  # apply_immediately: false, # required
8311
8390
  # cache_node_type: "String",
8312
8391
  # engine_version: "String",
8392
+ # cache_parameter_group_name: "String",
8313
8393
  # global_replication_group_description: "String",
8314
8394
  # automatic_failover_enabled: false,
8315
8395
  # })
@@ -8388,13 +8468,9 @@ module Aws::ElastiCache
8388
8468
  # Valid values: `true` \| `false`
8389
8469
  #
8390
8470
  # @option params [Boolean] :multi_az_enabled
8391
- # A flag indicating if you have Multi-AZ enabled to enhance fault
8392
- # tolerance. For more information, see [Minimizing Downtime:
8393
- # Multi-AZ][1].
8394
- #
8395
- #
8396
- #
8397
- # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html
8471
+ # A list of tags to be added to this resource. A tag is a key-value
8472
+ # pair. A tag key must be accompanied by a tag value, although null is
8473
+ # accepted.
8398
8474
  #
8399
8475
  # @option params [String] :node_group_id
8400
8476
  # Deprecated. This parameter is not used.
@@ -8728,7 +8804,7 @@ module Aws::ElastiCache
8728
8804
 
8729
8805
  # Modifies a replication group's shards (node groups) by allowing you
8730
8806
  # to add shards, remove shards, or rebalance the keyspaces among
8731
- # exisiting shards.
8807
+ # existing shards.
8732
8808
  #
8733
8809
  # @option params [required, String] :replication_group_id
8734
8810
  # The name of the Redis (cluster mode enabled) cluster (replication
@@ -8967,7 +9043,15 @@ module Aws::ElastiCache
8967
9043
  req.send_request(options)
8968
9044
  end
8969
9045
 
8970
- # Allows you to purchase a reserved cache node offering.
9046
+ # Allows you to purchase a reserved cache node offering. Reserved nodes
9047
+ # are not eligible for cancellation and are non-refundable. For more
9048
+ # information, see [Managing Costs with Reserved Nodes][1] for Redis or
9049
+ # [Managing Costs with Reserved Nodes][2] for Memcached.
9050
+ #
9051
+ #
9052
+ #
9053
+ # [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html
9054
+ # [2]: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html
8971
9055
  #
8972
9056
  # @option params [required, String] :reserved_cache_nodes_offering_id
8973
9057
  # The ID of the reserved cache node offering to purchase.
@@ -8990,6 +9074,11 @@ module Aws::ElastiCache
8990
9074
  #
8991
9075
  # Default: `1`
8992
9076
  #
9077
+ # @option params [Array<Types::Tag>] :tags
9078
+ # A list of tags to be added to this resource. A tag is a key-value
9079
+ # pair. A tag key must be accompanied by a tag value, although null is
9080
+ # accepted.
9081
+ #
8993
9082
  # @return [Types::PurchaseReservedCacheNodesOfferingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8994
9083
  #
8995
9084
  # * {Types::PurchaseReservedCacheNodesOfferingResult#reserved_cache_node #reserved_cache_node} => Types::ReservedCacheNode
@@ -9009,6 +9098,12 @@ module Aws::ElastiCache
9009
9098
  # reserved_cache_nodes_offering_id: "String", # required
9010
9099
  # reserved_cache_node_id: "String",
9011
9100
  # cache_node_count: 1,
9101
+ # tags: [
9102
+ # {
9103
+ # key: "String",
9104
+ # value: "String",
9105
+ # },
9106
+ # ],
9012
9107
  # })
9013
9108
  #
9014
9109
  # @example Response structure
@@ -9042,7 +9137,7 @@ module Aws::ElastiCache
9042
9137
  # shards in the cluster.
9043
9138
  #
9044
9139
  # @option params [required, String] :global_replication_group_id
9045
- # The name of the Global Datastore
9140
+ # The name of the Global datastore
9046
9141
  #
9047
9142
  # @option params [required, Boolean] :apply_immediately
9048
9143
  # If `True`, redistribution is applied immediately.
@@ -9242,7 +9337,16 @@ module Aws::ElastiCache
9242
9337
  end
9243
9338
 
9244
9339
  # Removes the tags identified by the `TagKeys` list from the named
9245
- # resource.
9340
+ # resource. A tag is a key-value pair where the key and value are
9341
+ # case-sensitive. You can use tags to categorize and track all your
9342
+ # ElastiCache resources, with the exception of global replication group.
9343
+ # When you add or remove tags on replication groups, those actions will
9344
+ # be replicated to all nodes in the replication group. For more
9345
+ # information, see [Resource-level permissions][1].
9346
+ #
9347
+ #
9348
+ #
9349
+ # [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html
9246
9350
  #
9247
9351
  # @option params [required, String] :resource_name
9248
9352
  # The Amazon Resource Name (ARN) of the resource from which you want the
@@ -9689,7 +9793,7 @@ module Aws::ElastiCache
9689
9793
  params: params,
9690
9794
  config: config)
9691
9795
  context[:gem_name] = 'aws-sdk-elasticache'
9692
- context[:gem_version] = '1.50.0'
9796
+ context[:gem_version] = '1.55.0'
9693
9797
  Seahorse::Client::Request.new(handlers, context)
9694
9798
  end
9695
9799