Class: Aws::AppConfig::Waiters::DeploymentComplete

Inherits:

Object

Object
Aws::AppConfig::Waiters::DeploymentComplete

show all

Defined in:: lib/aws-sdk-appconfig/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ DeploymentComplete constructor

A new instance of DeploymentComplete.
#wait(params = {}) ⇒ Types::Deployment

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

Constructor Details

#initialize(options) ⇒ `DeploymentComplete`

Returns a new instance of DeploymentComplete.

Parameters:

options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-appconfig/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 999,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_deployment,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "COMPLETE"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "ROLLED_BACK"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "REVERTED"
        }
      ]
    )
  }.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.



123
124
125

# File 'lib/aws-sdk-appconfig/waiters.rb', line 123

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::Deployment`

Returns a response object which responds to the following methods:

#application_id => String
#environment_id => String
#deployment_strategy_id => String
#configuration_profile_id => String
#deployment_number => Integer
#configuration_name => String
#configuration_location_uri => String
#configuration_version => String
#description => String
#deployment_duration_in_minutes => Integer
#growth_type => String
#growth_factor => Float
#final_bake_time_in_minutes => Integer
#state => String
#event_log => Array<Types::DeploymentEvent>
#percentage_complete => Float
#started_at => Time
#completed_at => Time
#applied_extensions => Array<Types::AppliedExtension>
#kms_key_arn => String
#kms_key_identifier => String
#version_label => String

Options Hash (params):

:application_id (required, String) —

The ID of the application that includes the deployment you want to get.
:environment_id (required, String) —

The ID of the environment that includes the deployment you want to get.
:deployment_number (required, Integer) —

The sequence number of the deployment.

Returns:

(Types::Deployment) —
Returns a response object which responds to the following methods:
- #application_id => String
- #environment_id => String
- #deployment_strategy_id => String
- #configuration_profile_id => String
- #deployment_number => Integer
- #configuration_name => String
- #configuration_location_uri => String
- #configuration_version => String
- #description => String
- #deployment_duration_in_minutes => Integer
- #growth_type => String
- #growth_factor => Float
- #final_bake_time_in_minutes => Integer
- #state => String
- #event_log => Array<Types::DeploymentEvent>
- #percentage_complete => Float
- #started_at => Time
- #completed_at => Time
- #applied_extensions => Array<Types::AppliedExtension>
- #kms_key_arn => String
- #kms_key_identifier => String
- #version_label => String



118
119
120

# File 'lib/aws-sdk-appconfig/waiters.rb', line 118

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