Class: Aws::Redshift::Waiters::ClusterRestored

Inherits:

Object

• Object
• Aws::Redshift::Waiters::ClusterRestored

Defined in:

lib/aws-sdk-redshift/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ ClusterRestored constructor

  A new instance of ClusterRestored.

• #wait(params = {}) ⇒ Types::ClustersMessage

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ ClusterRestored

Returns a new instance of ClusterRestored.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 30
• :delay (Integer) — default: 60
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'lib/aws-sdk-redshift/waiters.rb', line 185

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 30,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_clusters,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "clusters[].restore_status.status",
          "expected" => "completed"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "clusters[].cluster_status",
          "expected" => "deleting"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-redshift/waiters.rb', line 217

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::ClustersMessage

Returns a response object which responds to the following methods:

• #marker => String

• #clusters => Array<Types::Cluster>

Options Hash (params):

• :cluster_identifier (String) —

  The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

  The default is that all clusters defined for an account are returned.

• :max_records (Integer) —

  The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ‘MaxRecords` value, a value is returned in a `marker` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  Default: ‘100`

  Constraints: minimum 20, maximum 100.

• :marker (String) —

  An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in ‘MaxRecords`, Amazon Web Services returns a value in the `Marker` field of the response. You can retrieve the next set of response records by providing the returned marker value in the `Marker` parameter and retrying the request.

  Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

• :tag_keys (Array<String>) —

  A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called ‘owner` and `environment`. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

• :tag_values (Array<String>) —

  A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called ‘admin` and `test`. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Returns:

• (Types::ClustersMessage) —

  Returns a response object which responds to the following methods:

  • #marker => String

  • #clusters => Array&lt;Types::Cluster&gt;

# File 'lib/aws-sdk-redshift/waiters.rb', line 212

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end