Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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, NAT gateway, VPC peering connection, network interface, or egress-only Internet gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3
, and the route table includes the following two IPv4 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 .
- createRoute :: Text -> CreateRoute
- data CreateRoute
- crVPCPeeringConnectionId :: Lens' CreateRoute (Maybe Text)
- crInstanceId :: Lens' CreateRoute (Maybe Text)
- crEgressOnlyInternetGatewayId :: Lens' CreateRoute (Maybe Text)
- crDestinationIPv6CidrBlock :: Lens' CreateRoute (Maybe Text)
- crNatGatewayId :: Lens' CreateRoute (Maybe Text)
- crNetworkInterfaceId :: Lens' CreateRoute (Maybe Text)
- crGatewayId :: Lens' CreateRoute (Maybe Text)
- crDryRun :: Lens' CreateRoute (Maybe Bool)
- crDestinationCidrBlock :: Lens' CreateRoute (Maybe Text)
- crRouteTableId :: Lens' CreateRoute Text
- createRouteResponse :: Int -> CreateRouteResponse
- data CreateRouteResponse
- crrsReturn :: Lens' CreateRouteResponse (Maybe Bool)
- crrsResponseStatus :: Lens' CreateRouteResponse Int
Creating a Request
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:
crVPCPeeringConnectionId
- The ID of a VPC peering connection.crInstanceId
- 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.crEgressOnlyInternetGatewayId
- [IPv6 traffic only] The ID of an egress-only Internet gateway.crDestinationIPv6CidrBlock
- The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.crNatGatewayId
- [IPv4 traffic only] The ID of a NAT gateway.crNetworkInterfaceId
- The ID of a network interface.crGatewayId
- The ID of an Internet gateway or virtual private gateway attached to your VPC.crDryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.crDestinationCidrBlock
- The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.crRouteTableId
- The ID of the route table for the route.
data CreateRoute Source #
Contains the parameters for CreateRoute.
See: createRoute
smart constructor.
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.
crEgressOnlyInternetGatewayId :: Lens' CreateRoute (Maybe Text) Source #
- IPv6 traffic only
- The ID of an egress-only Internet gateway.
crDestinationIPv6CidrBlock :: Lens' CreateRoute (Maybe Text) Source #
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
crNatGatewayId :: Lens' CreateRoute (Maybe Text) Source #
- IPv4 traffic only
- The ID of a NAT gateway.
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
.
crDestinationCidrBlock :: Lens' CreateRoute (Maybe Text) Source #
The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.
crRouteTableId :: Lens' CreateRoute Text Source #
The ID of the route table for the route.
Destructuring the Response
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:
crrsReturn
- Returnstrue
if the request succeeds; otherwise, it returns an error.crrsResponseStatus
- -- | The response status code.
data CreateRouteResponse Source #
Contains the output of CreateRoute.
See: createRouteResponse
smart constructor.
Response Lenses
crrsReturn :: Lens' CreateRouteResponse (Maybe Bool) Source #
Returns true
if the request succeeds; otherwise, it returns an error.
crrsResponseStatus :: Lens' CreateRouteResponse Int Source #
- - | The response status code.