You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Waiters::DeploymentSuccessful

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb

Overview

Wait until a deployment has completed successfully

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ DeploymentSuccessful

Returns a new instance of DeploymentSuccessful

Parameters:

  • options (Hash)

Options Hash (options):

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


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 64

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_deployments,
      acceptors: [
        {
          "expected" => "successful",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "deployments[].status"
        },
        {
          "expected" => "failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "deployments[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :stack_id (String)

    The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

  • :app_id (String)

    The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

  • :deployment_ids (Array<String>)

    An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Returns:



91
92
93
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 91

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