Network.AWS.EC2.CreateRoute

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, 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.

Creating a Request

createRoute

Arguments

:: Text

crRouteTableId

-> Text

crDestinationCIdRBlock

-> CreateRoute

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
• crInstanceId
• crNatGatewayId
• crNetworkInterfaceId
• crGatewayId
• crDryRun
• crRouteTableId
• crDestinationCIdRBlock

data CreateRoute

Contains the parameters for CreateRoute.

See: createRoute smart constructor.

Instances

Eq CreateRoute

Methods

(==) :: CreateRoute -> CreateRoute -> Bool

(/=) :: CreateRoute -> CreateRoute -> Bool

Data CreateRoute

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateRoute -> c CreateRoute

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateRoute

toConstr :: CreateRoute -> Constr

dataTypeOf :: CreateRoute -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateRoute)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateRoute)

gmapT :: (forall b. Data b => b -> b) -> CreateRoute -> CreateRoute

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateRoute -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateRoute -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateRoute -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateRoute -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateRoute -> m CreateRoute

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRoute -> m CreateRoute

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRoute -> m CreateRoute

Read CreateRoute

Methods

readsPrec :: Int -> ReadS CreateRoute

readList :: ReadS [CreateRoute]

readPrec :: ReadPrec CreateRoute

readListPrec :: ReadPrec [CreateRoute]

Show CreateRoute

Methods

showsPrec :: Int -> CreateRoute -> ShowS

show :: CreateRoute -> String

showList :: [CreateRoute] -> ShowS

Generic CreateRoute

Associated Types

type Rep CreateRoute :: * -> *

Methods

from :: CreateRoute -> Rep CreateRoute x

to :: Rep CreateRoute x -> CreateRoute

Hashable CreateRoute

Methods

hashWithSalt :: Int -> CreateRoute -> Int

hash :: CreateRoute -> Int

NFData CreateRoute

Methods

rnf :: CreateRoute -> ()

AWSRequest CreateRoute

Associated Types

type Rs CreateRoute :: *

Methods

request :: CreateRoute -> Request CreateRoute

response :: MonadResource m => Logger -> Service -> Proxy * CreateRoute -> ClientResponse -> m (Response CreateRoute)

ToQuery CreateRoute

Methods

toQuery :: CreateRoute -> QueryString

ToPath CreateRoute

Methods

toPath :: CreateRoute -> ByteString

ToHeaders CreateRoute

Methods

toHeaders :: CreateRoute -> [Header]

type Rep CreateRoute

type Rep CreateRoute = D1 (MetaData "CreateRoute" "Network.AWS.EC2.CreateRoute" "amazonka-ec2-1.4.1-5DlWz6no0BoLQhxZVyzMyd" False) (C1 (MetaCons "CreateRoute'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crVPCPeeringConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_crNatGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crNetworkInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_crRouteTableId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_crDestinationCIdRBlock") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateRoute

type Rs CreateRoute = CreateRouteResponse

Request Lenses

crVPCPeeringConnectionId :: Lens' CreateRoute (Maybe Text)

The ID of a VPC peering connection.

crInstanceId :: Lens' CreateRoute (Maybe Text)

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.

crNatGatewayId :: Lens' CreateRoute (Maybe Text)

The ID of a NAT gateway.

crNetworkInterfaceId :: Lens' CreateRoute (Maybe Text)

The ID of a network interface.

crGatewayId :: Lens' CreateRoute (Maybe Text)

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

crDryRun :: Lens' CreateRoute (Maybe Bool)

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

The ID of the route table for the route.

crDestinationCIdRBlock :: Lens' CreateRoute Text

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

Destructuring the Response

createRouteResponse

Arguments

:: Int

crrsResponseStatus

-> CreateRouteResponse

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
• crrsResponseStatus

data CreateRouteResponse

Contains the output of CreateRoute.

See: createRouteResponse smart constructor.

Instances

Eq CreateRouteResponse

Methods

(==) :: CreateRouteResponse -> CreateRouteResponse -> Bool

(/=) :: CreateRouteResponse -> CreateRouteResponse -> Bool

Data CreateRouteResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateRouteResponse -> c CreateRouteResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateRouteResponse

toConstr :: CreateRouteResponse -> Constr

dataTypeOf :: CreateRouteResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateRouteResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateRouteResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateRouteResponse -> CreateRouteResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateRouteResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateRouteResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateRouteResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateRouteResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateRouteResponse -> m CreateRouteResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRouteResponse -> m CreateRouteResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateRouteResponse -> m CreateRouteResponse

Read CreateRouteResponse

Methods

readsPrec :: Int -> ReadS CreateRouteResponse

readList :: ReadS [CreateRouteResponse]

readPrec :: ReadPrec CreateRouteResponse

readListPrec :: ReadPrec [CreateRouteResponse]

Show CreateRouteResponse

Methods

showsPrec :: Int -> CreateRouteResponse -> ShowS

show :: CreateRouteResponse -> String

showList :: [CreateRouteResponse] -> ShowS

Generic CreateRouteResponse

Associated Types

type Rep CreateRouteResponse :: * -> *

Methods

from :: CreateRouteResponse -> Rep CreateRouteResponse x

to :: Rep CreateRouteResponse x -> CreateRouteResponse

NFData CreateRouteResponse

Methods

rnf :: CreateRouteResponse -> ()

type Rep CreateRouteResponse

type Rep CreateRouteResponse = D1 (MetaData "CreateRouteResponse" "Network.AWS.EC2.CreateRoute" "amazonka-ec2-1.4.1-5DlWz6no0BoLQhxZVyzMyd" False) (C1 (MetaCons "CreateRouteResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crrsReturn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_crrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

crrsReturn :: Lens' CreateRouteResponse (Maybe Bool)

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

crrsResponseStatus :: Lens' CreateRouteResponse Int

The response status code.