amazonka-ec2-2.0: gen/Amazonka/EC2/CreateRoute.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.EC2.CreateRoute
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates a route in a route table within a VPC.
--
-- You must specify either a destination CIDR block or a prefix list ID.
-- You must also specify exactly one of the resources from the parameter
-- list.
--
-- 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
-- <https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html Route tables>
-- in the /Amazon Virtual Private Cloud User Guide/.
module Amazonka.EC2.CreateRoute
( -- * Creating a Request
CreateRoute (..),
newCreateRoute,
-- * Request Lenses
createRoute_carrierGatewayId,
createRoute_coreNetworkArn,
createRoute_destinationCidrBlock,
createRoute_destinationIpv6CidrBlock,
createRoute_destinationPrefixListId,
createRoute_dryRun,
createRoute_egressOnlyInternetGatewayId,
createRoute_gatewayId,
createRoute_instanceId,
createRoute_localGatewayId,
createRoute_natGatewayId,
createRoute_networkInterfaceId,
createRoute_transitGatewayId,
createRoute_vpcEndpointId,
createRoute_vpcPeeringConnectionId,
createRoute_routeTableId,
-- * Destructuring the Response
CreateRouteResponse (..),
newCreateRouteResponse,
-- * Response Lenses
createRouteResponse_return,
createRouteResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.EC2.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | /See:/ 'newCreateRoute' smart constructor.
data CreateRoute = CreateRoute'
{ -- | The ID of the carrier gateway.
--
-- You can only use this option when the VPC contains a subnet which is
-- associated with a Wavelength Zone.
carrierGatewayId :: Prelude.Maybe Prelude.Text,
-- | The Amazon Resource Name (ARN) of the core network.
coreNetworkArn :: Prelude.Maybe Prelude.Text,
-- | The IPv4 CIDR address block used for the destination match. Routing
-- decisions are based on the most specific match. We modify the specified
-- CIDR block to its canonical form; for example, if you specify
-- @100.68.0.18\/18@, we modify it to @100.68.0.0\/18@.
destinationCidrBlock :: Prelude.Maybe Prelude.Text,
-- | The IPv6 CIDR block used for the destination match. Routing decisions
-- are based on the most specific match.
destinationIpv6CidrBlock :: Prelude.Maybe Prelude.Text,
-- | The ID of a prefix list used for the destination match.
destinationPrefixListId :: Prelude.Maybe Prelude.Text,
-- | 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@.
dryRun :: Prelude.Maybe Prelude.Bool,
-- | [IPv6 traffic only] The ID of an egress-only internet gateway.
egressOnlyInternetGatewayId :: Prelude.Maybe Prelude.Text,
-- | The ID of an internet gateway or virtual private gateway attached to
-- your VPC.
gatewayId :: Prelude.Maybe Prelude.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.
instanceId :: Prelude.Maybe Prelude.Text,
-- | The ID of the local gateway.
localGatewayId :: Prelude.Maybe Prelude.Text,
-- | [IPv4 traffic only] The ID of a NAT gateway.
natGatewayId :: Prelude.Maybe Prelude.Text,
-- | The ID of a network interface.
networkInterfaceId :: Prelude.Maybe Prelude.Text,
-- | The ID of a transit gateway.
transitGatewayId :: Prelude.Maybe Prelude.Text,
-- | The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints
-- only.
vpcEndpointId :: Prelude.Maybe Prelude.Text,
-- | The ID of a VPC peering connection.
vpcPeeringConnectionId :: Prelude.Maybe Prelude.Text,
-- | The ID of the route table for the route.
routeTableId :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateRoute' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'carrierGatewayId', 'createRoute_carrierGatewayId' - The ID of the carrier gateway.
--
-- You can only use this option when the VPC contains a subnet which is
-- associated with a Wavelength Zone.
--
-- 'coreNetworkArn', 'createRoute_coreNetworkArn' - The Amazon Resource Name (ARN) of the core network.
--
-- 'destinationCidrBlock', 'createRoute_destinationCidrBlock' - The IPv4 CIDR address block used for the destination match. Routing
-- decisions are based on the most specific match. We modify the specified
-- CIDR block to its canonical form; for example, if you specify
-- @100.68.0.18\/18@, we modify it to @100.68.0.0\/18@.
--
-- 'destinationIpv6CidrBlock', 'createRoute_destinationIpv6CidrBlock' - The IPv6 CIDR block used for the destination match. Routing decisions
-- are based on the most specific match.
--
-- 'destinationPrefixListId', 'createRoute_destinationPrefixListId' - The ID of a prefix list used for the destination match.
--
-- 'dryRun', 'createRoute_dryRun' - 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@.
--
-- 'egressOnlyInternetGatewayId', 'createRoute_egressOnlyInternetGatewayId' - [IPv6 traffic only] The ID of an egress-only internet gateway.
--
-- 'gatewayId', 'createRoute_gatewayId' - The ID of an internet gateway or virtual private gateway attached to
-- your VPC.
--
-- 'instanceId', 'createRoute_instanceId' - 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.
--
-- 'localGatewayId', 'createRoute_localGatewayId' - The ID of the local gateway.
--
-- 'natGatewayId', 'createRoute_natGatewayId' - [IPv4 traffic only] The ID of a NAT gateway.
--
-- 'networkInterfaceId', 'createRoute_networkInterfaceId' - The ID of a network interface.
--
-- 'transitGatewayId', 'createRoute_transitGatewayId' - The ID of a transit gateway.
--
-- 'vpcEndpointId', 'createRoute_vpcEndpointId' - The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints
-- only.
--
-- 'vpcPeeringConnectionId', 'createRoute_vpcPeeringConnectionId' - The ID of a VPC peering connection.
--
-- 'routeTableId', 'createRoute_routeTableId' - The ID of the route table for the route.
newCreateRoute ::
-- | 'routeTableId'
Prelude.Text ->
CreateRoute
newCreateRoute pRouteTableId_ =
CreateRoute'
{ carrierGatewayId = Prelude.Nothing,
coreNetworkArn = Prelude.Nothing,
destinationCidrBlock = Prelude.Nothing,
destinationIpv6CidrBlock = Prelude.Nothing,
destinationPrefixListId = Prelude.Nothing,
dryRun = Prelude.Nothing,
egressOnlyInternetGatewayId = Prelude.Nothing,
gatewayId = Prelude.Nothing,
instanceId = Prelude.Nothing,
localGatewayId = Prelude.Nothing,
natGatewayId = Prelude.Nothing,
networkInterfaceId = Prelude.Nothing,
transitGatewayId = Prelude.Nothing,
vpcEndpointId = Prelude.Nothing,
vpcPeeringConnectionId = Prelude.Nothing,
routeTableId = pRouteTableId_
}
-- | The ID of the carrier gateway.
--
-- You can only use this option when the VPC contains a subnet which is
-- associated with a Wavelength Zone.
createRoute_carrierGatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_carrierGatewayId = Lens.lens (\CreateRoute' {carrierGatewayId} -> carrierGatewayId) (\s@CreateRoute' {} a -> s {carrierGatewayId = a} :: CreateRoute)
-- | The Amazon Resource Name (ARN) of the core network.
createRoute_coreNetworkArn :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_coreNetworkArn = Lens.lens (\CreateRoute' {coreNetworkArn} -> coreNetworkArn) (\s@CreateRoute' {} a -> s {coreNetworkArn = a} :: CreateRoute)
-- | The IPv4 CIDR address block used for the destination match. Routing
-- decisions are based on the most specific match. We modify the specified
-- CIDR block to its canonical form; for example, if you specify
-- @100.68.0.18\/18@, we modify it to @100.68.0.0\/18@.
createRoute_destinationCidrBlock :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_destinationCidrBlock = Lens.lens (\CreateRoute' {destinationCidrBlock} -> destinationCidrBlock) (\s@CreateRoute' {} a -> s {destinationCidrBlock = a} :: CreateRoute)
-- | The IPv6 CIDR block used for the destination match. Routing decisions
-- are based on the most specific match.
createRoute_destinationIpv6CidrBlock :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_destinationIpv6CidrBlock = Lens.lens (\CreateRoute' {destinationIpv6CidrBlock} -> destinationIpv6CidrBlock) (\s@CreateRoute' {} a -> s {destinationIpv6CidrBlock = a} :: CreateRoute)
-- | The ID of a prefix list used for the destination match.
createRoute_destinationPrefixListId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_destinationPrefixListId = Lens.lens (\CreateRoute' {destinationPrefixListId} -> destinationPrefixListId) (\s@CreateRoute' {} a -> s {destinationPrefixListId = a} :: CreateRoute)
-- | 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@.
createRoute_dryRun :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Bool)
createRoute_dryRun = Lens.lens (\CreateRoute' {dryRun} -> dryRun) (\s@CreateRoute' {} a -> s {dryRun = a} :: CreateRoute)
-- | [IPv6 traffic only] The ID of an egress-only internet gateway.
createRoute_egressOnlyInternetGatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_egressOnlyInternetGatewayId = Lens.lens (\CreateRoute' {egressOnlyInternetGatewayId} -> egressOnlyInternetGatewayId) (\s@CreateRoute' {} a -> s {egressOnlyInternetGatewayId = a} :: CreateRoute)
-- | The ID of an internet gateway or virtual private gateway attached to
-- your VPC.
createRoute_gatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_gatewayId = Lens.lens (\CreateRoute' {gatewayId} -> gatewayId) (\s@CreateRoute' {} a -> s {gatewayId = a} :: CreateRoute)
-- | 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.
createRoute_instanceId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_instanceId = Lens.lens (\CreateRoute' {instanceId} -> instanceId) (\s@CreateRoute' {} a -> s {instanceId = a} :: CreateRoute)
-- | The ID of the local gateway.
createRoute_localGatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_localGatewayId = Lens.lens (\CreateRoute' {localGatewayId} -> localGatewayId) (\s@CreateRoute' {} a -> s {localGatewayId = a} :: CreateRoute)
-- | [IPv4 traffic only] The ID of a NAT gateway.
createRoute_natGatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_natGatewayId = Lens.lens (\CreateRoute' {natGatewayId} -> natGatewayId) (\s@CreateRoute' {} a -> s {natGatewayId = a} :: CreateRoute)
-- | The ID of a network interface.
createRoute_networkInterfaceId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_networkInterfaceId = Lens.lens (\CreateRoute' {networkInterfaceId} -> networkInterfaceId) (\s@CreateRoute' {} a -> s {networkInterfaceId = a} :: CreateRoute)
-- | The ID of a transit gateway.
createRoute_transitGatewayId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_transitGatewayId = Lens.lens (\CreateRoute' {transitGatewayId} -> transitGatewayId) (\s@CreateRoute' {} a -> s {transitGatewayId = a} :: CreateRoute)
-- | The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints
-- only.
createRoute_vpcEndpointId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_vpcEndpointId = Lens.lens (\CreateRoute' {vpcEndpointId} -> vpcEndpointId) (\s@CreateRoute' {} a -> s {vpcEndpointId = a} :: CreateRoute)
-- | The ID of a VPC peering connection.
createRoute_vpcPeeringConnectionId :: Lens.Lens' CreateRoute (Prelude.Maybe Prelude.Text)
createRoute_vpcPeeringConnectionId = Lens.lens (\CreateRoute' {vpcPeeringConnectionId} -> vpcPeeringConnectionId) (\s@CreateRoute' {} a -> s {vpcPeeringConnectionId = a} :: CreateRoute)
-- | The ID of the route table for the route.
createRoute_routeTableId :: Lens.Lens' CreateRoute Prelude.Text
createRoute_routeTableId = Lens.lens (\CreateRoute' {routeTableId} -> routeTableId) (\s@CreateRoute' {} a -> s {routeTableId = a} :: CreateRoute)
instance Core.AWSRequest CreateRoute where
type AWSResponse CreateRoute = CreateRouteResponse
request overrides =
Request.postQuery (overrides defaultService)
response =
Response.receiveXML
( \s h x ->
CreateRouteResponse'
Prelude.<$> (x Data..@? "return")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable CreateRoute where
hashWithSalt _salt CreateRoute' {..} =
_salt
`Prelude.hashWithSalt` carrierGatewayId
`Prelude.hashWithSalt` coreNetworkArn
`Prelude.hashWithSalt` destinationCidrBlock
`Prelude.hashWithSalt` destinationIpv6CidrBlock
`Prelude.hashWithSalt` destinationPrefixListId
`Prelude.hashWithSalt` dryRun
`Prelude.hashWithSalt` egressOnlyInternetGatewayId
`Prelude.hashWithSalt` gatewayId
`Prelude.hashWithSalt` instanceId
`Prelude.hashWithSalt` localGatewayId
`Prelude.hashWithSalt` natGatewayId
`Prelude.hashWithSalt` networkInterfaceId
`Prelude.hashWithSalt` transitGatewayId
`Prelude.hashWithSalt` vpcEndpointId
`Prelude.hashWithSalt` vpcPeeringConnectionId
`Prelude.hashWithSalt` routeTableId
instance Prelude.NFData CreateRoute where
rnf CreateRoute' {..} =
Prelude.rnf carrierGatewayId
`Prelude.seq` Prelude.rnf coreNetworkArn
`Prelude.seq` Prelude.rnf destinationCidrBlock
`Prelude.seq` Prelude.rnf destinationIpv6CidrBlock
`Prelude.seq` Prelude.rnf destinationPrefixListId
`Prelude.seq` Prelude.rnf dryRun
`Prelude.seq` Prelude.rnf egressOnlyInternetGatewayId
`Prelude.seq` Prelude.rnf gatewayId
`Prelude.seq` Prelude.rnf instanceId
`Prelude.seq` Prelude.rnf localGatewayId
`Prelude.seq` Prelude.rnf natGatewayId
`Prelude.seq` Prelude.rnf networkInterfaceId
`Prelude.seq` Prelude.rnf transitGatewayId
`Prelude.seq` Prelude.rnf vpcEndpointId
`Prelude.seq` Prelude.rnf vpcPeeringConnectionId
`Prelude.seq` Prelude.rnf routeTableId
instance Data.ToHeaders CreateRoute where
toHeaders = Prelude.const Prelude.mempty
instance Data.ToPath CreateRoute where
toPath = Prelude.const "/"
instance Data.ToQuery CreateRoute where
toQuery CreateRoute' {..} =
Prelude.mconcat
[ "Action"
Data.=: ("CreateRoute" :: Prelude.ByteString),
"Version"
Data.=: ("2016-11-15" :: Prelude.ByteString),
"CarrierGatewayId" Data.=: carrierGatewayId,
"CoreNetworkArn" Data.=: coreNetworkArn,
"DestinationCidrBlock" Data.=: destinationCidrBlock,
"DestinationIpv6CidrBlock"
Data.=: destinationIpv6CidrBlock,
"DestinationPrefixListId"
Data.=: destinationPrefixListId,
"DryRun" Data.=: dryRun,
"EgressOnlyInternetGatewayId"
Data.=: egressOnlyInternetGatewayId,
"GatewayId" Data.=: gatewayId,
"InstanceId" Data.=: instanceId,
"LocalGatewayId" Data.=: localGatewayId,
"NatGatewayId" Data.=: natGatewayId,
"NetworkInterfaceId" Data.=: networkInterfaceId,
"TransitGatewayId" Data.=: transitGatewayId,
"VpcEndpointId" Data.=: vpcEndpointId,
"VpcPeeringConnectionId"
Data.=: vpcPeeringConnectionId,
"RouteTableId" Data.=: routeTableId
]
-- | /See:/ 'newCreateRouteResponse' smart constructor.
data CreateRouteResponse = CreateRouteResponse'
{ -- | Returns @true@ if the request succeeds; otherwise, it returns an error.
return' :: Prelude.Maybe Prelude.Bool,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CreateRouteResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'return'', 'createRouteResponse_return' - Returns @true@ if the request succeeds; otherwise, it returns an error.
--
-- 'httpStatus', 'createRouteResponse_httpStatus' - The response's http status code.
newCreateRouteResponse ::
-- | 'httpStatus'
Prelude.Int ->
CreateRouteResponse
newCreateRouteResponse pHttpStatus_ =
CreateRouteResponse'
{ return' = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | Returns @true@ if the request succeeds; otherwise, it returns an error.
createRouteResponse_return :: Lens.Lens' CreateRouteResponse (Prelude.Maybe Prelude.Bool)
createRouteResponse_return = Lens.lens (\CreateRouteResponse' {return'} -> return') (\s@CreateRouteResponse' {} a -> s {return' = a} :: CreateRouteResponse)
-- | The response's http status code.
createRouteResponse_httpStatus :: Lens.Lens' CreateRouteResponse Prelude.Int
createRouteResponse_httpStatus = Lens.lens (\CreateRouteResponse' {httpStatus} -> httpStatus) (\s@CreateRouteResponse' {} a -> s {httpStatus = a} :: CreateRouteResponse)
instance Prelude.NFData CreateRouteResponse where
rnf CreateRouteResponse' {..} =
Prelude.rnf return'
`Prelude.seq` Prelude.rnf httpStatus