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

Class: Aws::AutoScaling::NotificationConfiguration

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name, type, topic_arn, options = {}) ⇒ NotificationConfiguration #initialize(options = {}) ⇒ NotificationConfiguration

Returns a new instance of NotificationConfiguration

Overloads:

  • #initialize(group_name, type, topic_arn, options = {}) ⇒ NotificationConfiguration

    Parameters:

    • group_name (String)
    • type (String)
    • topic_arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ NotificationConfiguration

    Options Hash (options):

    • :group_name (required, String)
    • :type (required, String)
    • :topic_arn (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 23

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @group_name = extract_group_name(args, options)
  @type = extract_type(args, options)
  @topic_arn = extract_topic_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



54
55
56
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 54

def client
  @client
end

#dataTypes::NotificationConfiguration

Returns the data for this Aws::AutoScaling::NotificationConfiguration.

Returns:

Raises:



69
70
71
72
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 69

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.



77
78
79
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 77

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification_configuration.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


183
184
185
186
187
188
189
190
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 183

def delete(options = {})
  options = options.merge(
    auto_scaling_group_name: @group_name,
    topic_arn: @topic_arn
  )
  resp = @client.delete_notification_configuration(options)
  resp.data
end

#groupAutoScalingGroup

Returns:



210
211
212
213
214
215
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 210

def group
  AutoScalingGroup.new(
    name: @group_name,
    client: @client
  )
end

#group_nameString Also known as: auto_scaling_group_name

Returns:

  • (String)


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

def group_name
  @group_name
end

#put(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification_configuration.put()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


197
198
199
200
201
202
203
204
205
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 197

def put(options = {})
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @name,
    topic_arn: @topic_arn,
    notification_types: [@notification_type]
  )
  resp = @client.put_notification_configuration(options)
  resp.data
end

#topic_arnString

Returns:

  • (String)


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

def topic_arn
  @topic_arn
end

#typeString Also known as: notification_type

Returns:

  • (String)


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

def type
  @type
end

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

Deprecated.

Use [Aws::AutoScaling::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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/notification_configuration.rb', line 159

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