Class: Aws::EC2::RouteTableAssociation

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ RouteTableAssociation #initialize(options = {}) ⇒ RouteTableAssociation

Returns a new instance of RouteTableAssociation.

Overloads:



22
23
24
25
26
27
28
# File 'gems/aws-sdk-ec2/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_stateTypes::RouteTableAssociationState

The state of the association.



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

def association_state
  data[:association_state]
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::RouteTableAssociation

Returns the data for this Aws::EC2::RouteTableAssociation.

Returns:

Raises:



87
88
89
90
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.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-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 95

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


route_table_association.delete({
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure)


210
211
212
213
214
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 210

def delete(options = {})
  options = options.merge(association_id: @id)
  resp = @client.disassociate_route_table(options)
  resp.data
end

#gateway_idString

The ID of the internet gateway or virtual private gateway.

Returns:

  • (String)


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

def gateway_id
  data[:gateway_id]
end

#idString Also known as: route_table_association_id

Returns:

  • (String)


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

def id
  @id
end

#mainBoolean

Indicates whether this is the main route table.

Returns:

  • (Boolean)


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

def main
  data[:main]
end

#replace_subnet(options = {}) ⇒ RouteTableAssociation

Examples:

Request syntax with placeholder values


routetableassociation = route_table_association.replace_subnet({
  dry_run: false,
  route_table_id: "RouteTableId", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :route_table_id (required, String)

    The ID of the new route table to associate with the subnet.

Returns:



231
232
233
234
235
236
237
238
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 231

def replace_subnet(options = {})
  options = options.merge(association_id: @id)
  resp = @client.replace_route_table_association(options)
  RouteTableAssociation.new(
    id: resp.data.new_association_id,
    client: @client
  )
end

#route_tableRouteTable?

Returns:



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

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

#route_table_idString

The ID of the route table.

Returns:

  • (String)


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

def route_table_id
  data[:route_table_id]
end

#subnetSubnet?

Returns:



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

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

#subnet_idString

The ID of the subnet. A subnet ID is not returned for an implicit association.

Returns:

  • (String)


53
54
55
# File 'gems/aws-sdk-ec2/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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 179

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