amazonka-ec2-1.3.4: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.CreateRoute

Contents

Description

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for '192.0.2.3', and the route table includes the following two routes:

  • '192.0.2.0\/24' (goes to some target A)
  • '192.0.2.0\/28' (goes to some target B)

Both routes apply to the traffic destined for '192.0.2.3'. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

See: AWS API Reference for CreateRoute.

Synopsis

Creating a Request

createRoute Source

Creates a value of CreateRoute with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

crVPCPeeringConnectionId :: Lens' CreateRoute (Maybe Text) Source

The ID of a VPC peering connection.

crInstanceId :: Lens' CreateRoute (Maybe Text) Source

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

crNetworkInterfaceId :: Lens' CreateRoute (Maybe Text) Source

The ID of a network interface.

crGatewayId :: Lens' CreateRoute (Maybe Text) Source

The ID of an Internet gateway or virtual private gateway attached to your VPC.

crDryRun :: Lens' CreateRoute (Maybe Bool) Source

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.

crRouteTableId :: Lens' CreateRoute Text Source

The ID of the route table for the route.

crDestinationCIdRBlock :: Lens' CreateRoute Text Source

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

Destructuring the Response

createRouteResponse Source

Creates a value of CreateRouteResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

crrsReturn :: Lens' CreateRouteResponse (Maybe Bool) Source

Returns true if the request succeeds; otherwise, it returns an error.