VM::EC2::REST::route_table(3pm)

1VM::EC2::REST::route_taUbsleer(3C)ontributed Perl DocumeVnMt:a:tEiCo2n::REST::route_table(3)
2
3
4

NAME VM::EC2::REST::route_table

SYNOPSIS

7        use VM::EC2 ':vpc';
8

METHODS

10       These methods allow you to create and manipulate VPC route tables.
11
12       Implemented:
13        AssociateRouteTable
14        CreateRoute
15        CreateRouteTable
16        DeleteRoute
17        DeleteRouteTable
18        DescribeRouteTables
19        DisassociateRouteTable
20        ReplaceRoute
21        ReplaceRouteTableAssociation
22
23       Unimplemented:
24        (none)
25
26   $table = $ec2->create_route_table($vpc_id)
27   $table = $ec2->create_route_table(-vpc_id=>$id)
28       This method creates a new route table within the given VPC and returns
29       a VM::EC2::VPC::RouteTable object. By default, every route table
30       includes a local route that enables traffic to flow within the VPC. You
31       may add additional routes using create_route().
32
33       This method can be called using a single argument corresponding to VPC
34       ID for the new route table, or with the named argument form.
35
36       Required arguments:
37
38        -vpc_id     A VPC ID or previously-created VM::EC2::VPC object.
39
40   $success = $ec2->delete_route_table($route_table_id)
41   $success = $ec2->delete_route_table(-route_table_id=>$id)
42       This method deletes the indicated route table and all the route entries
43       within it. It may not be called on the main route table, or if the
44       route table is currently associated with a subnet.
45
46       The method can be called with a single argument corresponding to the
47       route table's ID, or using the named form with argument
48       -route_table_id.
49
50   @tables = $ec2->describe_route_tables(@route_table_ids)
51   @tables = $ec2->describe_route_tables(\%filters)
52   @tables = $ec2->describe_route_tables(-route_table_id=> \@ids, -filter
53       => \%filters);
54       This method describes all or some of the route tables available to you.
55       You may use the filter to restrict the search to a particular type of
56       route table using one of the filters described at
57       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeRouteTables.html.
58
59       Some of the commonly used filters are:
60
61        vpc-id                  ID of the VPC the route table is in.
62        association.subnet-id   ID of the subnet the route table is
63                                 associated with.
64        route.state             State of the route, either 'active' or 'blackhole'
65        tag:<key>               Value of a tag
66
67   $associationId = $ec2->associate_route_table($subnet_id => $route_table_id)
68   $associationId = $ec2->associate_route_table(-subnet_id      => $id,
69       -route_table_id => $id)
70       This method associates a route table with a subnet. Both objects must
71       be in the same VPC. You may use either string IDs, or
72       VM::EC2::VPC::RouteTable and VM::EC2::VPC::Subnet objects.
73
74       On success, an associationID is returned, which you may use to
75       disassociate the route table from the subnet later. The association ID
76       can also be found by searching through the VM::EC2::VPC::RouteTable
77       object.
78
79       Required arguments:
80
81        -subnet_id      The subnet ID or a VM::EC2::VPC::Subnet object.
82
83        -route_table_id The route table ID or a VM::EC2::VPC::RouteTable object.
84
85       It may be more convenient to call the
86       VM::EC2::VPC::Subnet->associate_route_table() or
87       VM::EC2::VPC::RouteTable->associate_subnet() methods, which are front
88       ends to this method.
89
90   $success = $ec2->dissociate_route_table($association_id)
91   $success = $ec2->dissociate_route_table(-association_id => $id)
92       This method disassociates a route table from a subnet. You must provide
93       the association ID (either returned from associate_route_table() or
94       found among the associations() of a RouteTable object). You may use the
95       short single-argument form, or the longer named argument form with the
96       required argument -association_id.
97
98       The method returns true on success.
99
100   $new_association =
101       $ec2->replace_route_table_association($association_id=>$route_table_id)
102   $new_association = $ec2->replace_route_table_association(-association_id =>
103       $id, -route_table_id => $id)
104       This method changes the route table associated with a given subnet. You
105       must pass the replacement route table ID and the association ID. To
106       replace the main route table, use its association ID and the ID of the
107       route table you wish to replace it with.
108
109       On success, a new associationID is returned.
110
111       Required arguments:
112
113        -association_id  The association ID
114
115        -route_table_id   The route table ID or a M::EC2::VPC::RouteTable object.
116
117   $success = $ec2->create_route($route_table_id,$destination,$target)
118   $success = $ec2->create_route(-route_table_id => $id,
119       -destination_cidr_block => $block, -target=>$target)
120       This method creates a routing rule in a route table within a VPC. It
121       takes three mandatory arguments consisting of the route table, the CIDR
122       address block to match packet destinations against, and a target to
123       route matching packets to. The target may be an internet gateway, a NAT
124       instance, or a network interface ID.
125
126       Network packets are routed by matching their destination addresses
127       against a CIDR block. For example, 0.0.0.0/0 matches all addresses,
128       while 10.0.1.0/24 matches 10.0.1.* addresses. When a packet matches
129       more than one rule, the most specific matching routing rule is chosen.
130
131       In the named argument form, the following arguments are recognized:
132
133        -route_table_id    The ID of a route table, or a VM::EC2::VPC::RouteTable
134                           object.
135
136        -destination_cidr_block
137                           The CIDR address block to match against packet destinations.
138
139        -destination       A shorthand version of -destination_cidr_block.
140
141        -target            The destination of matching packets. See below for valid
142                           targets.
143
144       The -target value can be any one of the following:
145
146        1. A VM::EC2::VPC::InternetGateway object, or an internet gateway ID matching
147           the regex /^igw-[0-9a-f]{8}$/
148
149        2. A VM::EC2::Instance object, or an instance ID matching the regex
150        /^i-[0-9a-f]{8}$/.
151
152        3. A VM::EC2::NetworkInterface object, or a network interface ID
153           matching the regex /^eni-[0-9a-f]{8}$/.
154
155        4. A VM::EC2::VPC::PeeringConnection object, or a VPC peering connection ID
156           matching the regex /^pcx-[0-9a-f]{8}$/.
157
158       On success, this method returns true.
159
160   $success = $ec2->delete_route($route_table_id,$destination_block)
161       This method deletes a route in the specified routing table. The
162       destination CIDR block is used to indicate which route to delete. On
163       success, the method returns true.
164
165   $success = $ec2->replace_route($route_table_id,$destination,$target)
166   $success = $ec2->replace_route(-route_table_id => $id,
167       -destination_cidr_block => $block, -target=>$target)
168       This method replaces an existing routing rule in a route table within a
169       VPC. It takes three mandatory arguments consisting of the route table,
170       the CIDR address block to match packet destinations against, and a
171       target to route matching packets to. The target may be an internet
172       gateway, a NAT instance, or a network interface ID.
173
174       Network packets are routed by matching their destination addresses
175       against a CIDR block. For example, 0.0.0.0/0 matches all addresses,
176       while 10.0.1.0/24 matches 10.0.1.* addresses. When a packet matches
177       more than one rule, the most specific matching routing rule is chosen.
178
179       In the named argument form, the following arguments are recognized:
180
181        -route_table_id    The ID of a route table, or a VM::EC2::VPC::RouteTable
182                           object.
183
184        -destination_cidr_block
185                           The CIDR address block to match against packet destinations.
186
187        -destination       A shorthand version of -destination_cidr_block.
188
189        -target            The destination of matching packets. See below for valid
190                           targets.
191
192       The -target value can be any one of the following:
193
194        1. A VM::EC2::VPC::InternetGateway object, or an internet gateway ID matching
195           the regex /^igw-[0-9a-f]{8}$/
196
197        2. A VM::EC2::Instance object, or an instance ID matching the regex
198        /^i-[0-9a-f]{8}$/.
199
200        3. A VM::EC2::NetworkInterface object, or a network interface ID
201           matching the regex /^eni-[0-9a-f]{8}$/.
202
203        4. A VM::EC2::VPC::PeeringConnection object, or a VPC peering connection ID
204           matching the regex /^pcx-[0-9a-f]{8}$/.
205
206       On success, this method returns true.
207

AUTHOR

212       Lincoln Stein <lincoln.stein@gmail.com>.
213
214       Copyright (c) 2011 Ontario Institute for Cancer Research
215
216       This package and its accompanying libraries is free software; you can
217       redistribute it and/or modify it under the terms of the GPL (either
218       version 1, or at your option, any later version) or the Artistic
219       License 2.0.  Refer to LICENSE for the full license text. In addition,
220       please see DISCLAIMER.txt for disclaimers of warranty.
221
222
223
224perl v5.28.0                      2018-07-15     VM::EC2::REST::route_table(3)

NAME VM::EC2::REST::route_table

SYNOPSIS

METHODS

SEE ALSO

AUTHOR