aws-sdk-elasticache 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7cfa92205640cb081ddda3cece54e82edaebac848da2f7002d8d38e77a3ffc
-  data.tar.gz: 4e2b892a31349b783451c9fb1f8d3dfd0a1c1c5fd5826201d7cb4887d582cff3
+  metadata.gz: 2f06a08e941d641f7c23a44053d75e440606e4da83a38870432d1739718b1fbc
+  data.tar.gz: 00ac83cf300c2c1e183d04d2cefb3b4eb8ee4fe40d85b412e00acee04292082c
 SHA512:
-  metadata.gz: f4e0702c7e3ac231d680e5225898df6b54b1a0f6083685b3c5294f9dd285604526b6435d05e62f9e8a2e8949fbf5bf870700f45651f326fb783145152384dc8f
-  data.tar.gz: b30a468a9f0524f831078eaaae86ca372acd648c5a2ed3761cd7934b4ab63c57822ab3374b5c5c11f9b1389854129536d74c9b16e8f679c0e5b48746668fe7c9
+  metadata.gz: 364f13beb58d0e54ddbc62783e737fb1575d177730ddfb67e43d11c1f36df6d2b5817f3411c846d235cce8d6785b3578b183592dd8b90a5ce60ad9a70c6f590f
+  data.tar.gz: f8cf93da8b8e94cbd24278569490e6994c585af7c4ba32ce193cd175439a46bc1e2f2a1707b0aa1f8d4d4d71a259aef25518c9b3711bdd6881628a02cb8129f3

data/lib/aws-sdk-elasticache.rb

@@ -46,6 +46,6 @@ require_relative 'aws-sdk-elasticache/customizations'
 # @service
 module Aws::ElastiCache
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end

data/lib/aws-sdk-elasticache/client.rb

@@ -105,7 +105,7 @@ module Aws::ElastiCache
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -161,7 +161,7 @@ module Aws::ElastiCache
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -269,8 +269,7 @@ module Aws::ElastiCache
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yielded by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
     #     seconds a connection is allowed to sit idle before it is
@@ -282,7 +281,7 @@ module Aws::ElastiCache
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yielded by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -3313,6 +3312,8 @@ module Aws::ElastiCache
     #   * {Types::CacheClusterMessage#marker #marker} => String
     #   * {Types::CacheClusterMessage#cache_clusters #cache_clusters} => Array<Types::CacheCluster>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheClusters
     #
@@ -3486,6 +3487,12 @@ module Aws::ElastiCache
     #   resp.cache_clusters[0].transit_encryption_enabled #=> Boolean
     #   resp.cache_clusters[0].at_rest_encryption_enabled #=> Boolean
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * cache_cluster_available
+    #   * cache_cluster_deleted
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheClusters AWS API Documentation
     #
     # @overload describe_cache_clusters(params = {})
@@ -3545,6 +3552,8 @@ module Aws::ElastiCache
     #   * {Types::CacheEngineVersionMessage#marker #marker} => String
     #   * {Types::CacheEngineVersionMessage#cache_engine_versions #cache_engine_versions} => Array<Types::CacheEngineVersion>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheEngineVersions
     #
@@ -3774,6 +3783,8 @@ module Aws::ElastiCache
     #   * {Types::CacheParameterGroupsMessage#marker #marker} => String
     #   * {Types::CacheParameterGroupsMessage#cache_parameter_groups #cache_parameter_groups} => Array<Types::CacheParameterGroup>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheParameterGroups
     #
@@ -3854,6 +3865,8 @@ module Aws::ElastiCache
     #   * {Types::CacheParameterGroupDetails#parameters #parameters} => Array<Types::Parameter>
     #   * {Types::CacheParameterGroupDetails#cache_node_type_specific_parameters #cache_node_type_specific_parameters} => Array<Types::CacheNodeTypeSpecificParameter>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheParameters
     #
@@ -4328,6 +4341,8 @@ module Aws::ElastiCache
     #   * {Types::CacheSecurityGroupMessage#marker #marker} => String
     #   * {Types::CacheSecurityGroupMessage#cache_security_groups #cache_security_groups} => Array<Types::CacheSecurityGroup>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheSecurityGroups
     #
@@ -4396,6 +4411,8 @@ module Aws::ElastiCache
     #   * {Types::CacheSubnetGroupMessage#marker #marker} => String
     #   * {Types::CacheSubnetGroupMessage#cache_subnet_groups #cache_subnet_groups} => Array<Types::CacheSubnetGroup>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeCacheSubnetGroups
     #
@@ -4500,6 +4517,8 @@ module Aws::ElastiCache
     #
     #   * {Types::DescribeEngineDefaultParametersResult#engine_defaults #engine_defaults} => Types::EngineDefaults
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeEngineDefaultParameters
     #
@@ -5209,6 +5228,8 @@ module Aws::ElastiCache
     #   * {Types::EventsMessage#marker #marker} => String
     #   * {Types::EventsMessage#events #events} => Array<Types::Event>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeEvents
     #
@@ -5364,6 +5385,8 @@ module Aws::ElastiCache
     #   * {Types::DescribeGlobalReplicationGroupsResult#marker #marker} => String
     #   * {Types::DescribeGlobalReplicationGroupsResult#global_replication_groups #global_replication_groups} => Array<Types::GlobalReplicationGroup>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_global_replication_groups({
@@ -5442,6 +5465,8 @@ module Aws::ElastiCache
     #   * {Types::ReplicationGroupMessage#marker #marker} => String
     #   * {Types::ReplicationGroupMessage#replication_groups #replication_groups} => Array<Types::ReplicationGroup>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeReplicationGroups
     #
@@ -5557,6 +5582,12 @@ module Aws::ElastiCache
     #   resp.replication_groups[0].at_rest_encryption_enabled #=> Boolean
     #   resp.replication_groups[0].kms_key_id #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * replication_group_available
+    #   * replication_group_deleted
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeReplicationGroups AWS API Documentation
     #
     # @overload describe_replication_groups(params = {})
@@ -5691,6 +5722,8 @@ module Aws::ElastiCache
     #   * {Types::ReservedCacheNodeMessage#marker #marker} => String
     #   * {Types::ReservedCacheNodeMessage#reserved_cache_nodes #reserved_cache_nodes} => Array<Types::ReservedCacheNode>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeReservedCacheNodes
     #
@@ -5866,6 +5899,8 @@ module Aws::ElastiCache
     #   * {Types::ReservedCacheNodesOfferingMessage#marker #marker} => String
     #   * {Types::ReservedCacheNodesOfferingMessage#reserved_cache_nodes_offerings #reserved_cache_nodes_offerings} => Array<Types::ReservedCacheNodesOffering>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeReseredCacheNodeOfferings
     #
@@ -6244,6 +6279,8 @@ module Aws::ElastiCache
     #   * {Types::ServiceUpdatesMessage#marker #marker} => String
     #   * {Types::ServiceUpdatesMessage#service_updates #service_updates} => Array<Types::ServiceUpdate>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_service_updates({
@@ -6332,6 +6369,8 @@ module Aws::ElastiCache
     #   * {Types::DescribeSnapshotsListMessage#marker #marker} => String
     #   * {Types::DescribeSnapshotsListMessage#snapshots #snapshots} => Array<Types::Snapshot>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: DescribeSnapshots
     #
@@ -6481,6 +6520,8 @@ module Aws::ElastiCache
     #   * {Types::UpdateActionsMessage#marker #marker} => String
     #   * {Types::UpdateActionsMessage#update_actions #update_actions} => Array<Types::UpdateAction>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_update_actions({
@@ -8843,7 +8884,7 @@ module Aws::ElastiCache
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-elasticache'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.32.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -8909,12 +8950,12 @@ module Aws::ElastiCache
     # The following table lists the valid waiter names, the operations they call,
     # and the default `:delay` and `:max_attempts` values.
     #
-    # | waiter_name                 | params                         | :delay   | :max_attempts |
-    # | --------------------------- | ------------------------------ | -------- | ------------- |
-    # | cache_cluster_available     | {#describe_cache_clusters}     | 15       | 40            |
-    # | cache_cluster_deleted       | {#describe_cache_clusters}     | 15       | 40            |
-    # | replication_group_available | {#describe_replication_groups} | 15       | 40            |
-    # | replication_group_deleted   | {#describe_replication_groups} | 15       | 40            |
+    # | waiter_name                 | params                               | :delay   | :max_attempts |
+    # | --------------------------- | ------------------------------------ | -------- | ------------- |
+    # | cache_cluster_available     | {Client#describe_cache_clusters}     | 15       | 40            |
+    # | cache_cluster_deleted       | {Client#describe_cache_clusters}     | 15       | 40            |
+    # | replication_group_available | {Client#describe_replication_groups} | 15       | 40            |
+    # | replication_group_deleted   | {Client#describe_replication_groups} | 15       | 40            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

data/lib/aws-sdk-elasticache/resource.rb

@@ -6,13 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ElastiCache
-  # This class provides a resource oriented interface for ElastiCache.
-  # To create a resource object:
-  #     resource = Aws::ElastiCache::Resource.new(region: 'us-west-2')
-  # You can supply a client object with custom configuration that will be used for all resource operations.
-  # If you do not pass +:client+, a default client will be constructed.
-  #     client = Aws::ElastiCache::Client.new(region: 'us-west-2')
-  #     resource = Aws::ElastiCache::Resource.new(client: client)
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-elasticache/waiters.rb

@@ -8,6 +8,70 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::ElastiCache
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name                 | params                               | :delay   | :max_attempts |
+  # | --------------------------- | ------------------------------------ | -------- | ------------- |
+  # | cache_cluster_available     | {Client#describe_cache_clusters}     | 15       | 40            |
+  # | cache_cluster_deleted       | {Client#describe_cache_clusters}     | 15       | 40            |
+  # | replication_group_available | {Client#describe_replication_groups} | 15       | 40            |
+  # | replication_group_deleted   | {Client#describe_replication_groups} | 15       | 40            |
+  #
   module Waiters
 
     # Wait until ElastiCache cluster is available.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-elasticache
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -81,7 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon ElastiCache