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

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:



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

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)
end

Instance Method Details

#clientClient

Returns:



56
57
58
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 56

def client
  @client
end

#dataTypes::RouteTableAssociation

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

Returns:

Raises:



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

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.



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

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)


192
193
194
195
196
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 192

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

#idString Also known as: route_table_association_id

Returns:

  • (String)


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

def id
  @id
end

#mainBoolean

Indicates whether this is the main route table.

Returns:

  • (Boolean)


36
37
38
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 36

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: "String", # 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:



213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 213

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:



225
226
227
228
229
230
231
232
233
234
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 225

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)


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

def route_table_id
  data[:route_table_id]
end

#subnetSubnet?

Returns:



237
238
239
240
241
242
243
244
245
246
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 237

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)


49
50
51
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 49

def subnet_id
  data[:subnet_id]
end

#wait_until(options = {}, &block) ⇒ 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) {|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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 161

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