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)


97
98
99
100
101
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 97

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:



118
119
120
121
122
123
124
125
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 118

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:



130
131
132
133
134
135
136
137
138
139
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 130

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:



142
143
144
145
146
147
148
149
150
151
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table_association.rb', line 142

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