Class: Aws::EC2::RouteTableAssociation

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
sig/route_table_association.rbs,
lib/aws-sdk-ec2/route_table_association.rb

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options) ⇒ void #initialize(id:, client:) ⇒ void #initialize(args) ⇒ void

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#initialize-instance_method

Overloads:

  • #initialize(id, options) ⇒ void

    Parameters:

    • id (String)
    • options (Hash[Symbol, untyped])
  • #initialize(id:, client:) ⇒ void

    Parameters:

    • id: (String)
    • client: (Client)
  • #initialize(args) ⇒ void

    Parameters:

    • args (Hash[Symbol, untyped]) 


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 22

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

Instance Method Details

#association_state ⇒ Types::RouteTableAssociationState

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#association_state-instance_method

Returns:



72
73
74
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 72

def association_state
  data[:association_state]
end

#client ⇒ Client

Returns:



79
80
81
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 79

def client
  @client
end

#data ⇒ Types::RouteTableAssociation

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#data-instance_method

Returns:



94
95
96
97
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 94

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#data_loaded?-instance_method

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 102

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#delete-instance_method



219
220
221
222
223
224
225
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 219

def delete(options = {})
  options = options.merge(association_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.disassociate_route_table(options)
  end
  resp.data
end

#gateway_id ⇒ ::String

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#gateway_id-instance_method

Returns:

  • (::String) 


59
60
61
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 59

def gateway_id
  data[:gateway_id]
end

#id ⇒ String Also known as: route_table_association_id

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#id-instance_method

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 33

def id
  @id
end

#identifiers ⇒ Object

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.

Deprecated. 


281
282
283
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 281

def identifiers
  { id: @id }
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


85
86
87
88
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 85

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#main ⇒ Boolean

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#main-instance_method

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 40

def main
  data[:main]
end

#public_ipv_4_pool ⇒ ::String

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#public_ipv_4_pool-instance_method

Returns:

  • (::String) 


66
67
68
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 66

def public_ipv_4_pool
  data[:public_ipv_4_pool]
end

#replace_subnet(options = {}) ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#replace_subnet-instance_method



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 242

def replace_subnet(options = {})
  options = options.merge(association_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.replace_route_table_association(options)
  end
  RouteTableAssociation.new(
    id: resp.data.new_association_id,
    client: @client
  )
end

#route_table ⇒ RouteTable?

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#route_table-instance_method

Returns:



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 256

def route_table
  if data[:route_table_id]
    RouteTable.new(
      id: data[:route_table_id],
      client: @client
    )
  else
    nil
  end
end

#route_table_id ⇒ ::String

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#route_table_id-instance_method

Returns:

  • (::String) 


46
47
48
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 46

def route_table_id
  data[:route_table_id]
end

#subnet ⇒ Subnet?

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#subnet-instance_method

Returns:



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 268

def subnet
  if data[:subnet_id]
    Subnet.new(
      id: data[:subnet_id],
      client: @client
    )
  else
    nil
  end
end

#subnet_id ⇒ ::String

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/RouteTableAssociation.html#subnet_id-instance_method

Returns:

  • (::String) 


53
54
55
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 53

def subnet_id
  data[:subnet_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::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) do |instance|
  instance.state.name == 'running'
end

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aws-sdk-ec2/route_table_association.rb', line 186

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end