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

Class: Aws::OpsWorks::StackSummary

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(stack_id, options = {}) ⇒ StackSummary #initialize(options = {}) ⇒ StackSummary

Returns a new instance of StackSummary

Overloads:

  • #initialize(stack_id, options = {}) ⇒ StackSummary

    Parameters:

    • stack_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ StackSummary

    Options Hash (options):

    • :stack_id (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @stack_id = extract_stack_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#apps_countInteger

The number of apps.

Returns:

  • (Integer)


53
54
55
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 53

def apps_count
  data[:apps_count]
end

#arnString

The stack's ARN.

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 41

def arn
  data[:arn]
end

#clientClient

Returns:



67
68
69
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 67

def client
  @client
end

#dataTypes::StackSummary

Returns the data for this Aws::OpsWorks::StackSummary. Calls Client#describe_stack_summary if #data_loaded? is false.

Returns:



87
88
89
90
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 87

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



95
96
97
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 95

def data_loaded?
  !!@data
end

#instances_countTypes::InstancesCount

An InstancesCount object with the number of instances in each status.



60
61
62
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 60

def instances_count
  data[:instances_count]
end

#layers_countInteger

The number of layers.

Returns:

  • (Integer)


47
48
49
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 47

def layers_count
  data[:layers_count]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::OpsWorks::StackSummary. Returns self making it possible to chain methods.

stack_summary.reload.data

Returns:

  • (self)


77
78
79
80
81
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 77

def load
  resp = @client.describe_stack_summary(stack_id: @stack_id)
  @data = resp.stack_summary
  self
end

#nameString

The stack name.

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 35

def name
  data[:name]
end

#stackStack

Returns:



197
198
199
200
201
202
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 197

def stack
  Stack.new(
    id: @stack_id,
    client: @client
  )
end

#stack_idString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 29

def stack_id
  @stack_id
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::OpsWorks::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 177

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end