Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Replaces an existing route within a route table in 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, or reset the local route to its default target.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
Synopsis
- data ReplaceRoute = ReplaceRoute' {
- carrierGatewayId :: Maybe Text
- coreNetworkArn :: Maybe Text
- destinationCidrBlock :: Maybe Text
- destinationIpv6CidrBlock :: Maybe Text
- destinationPrefixListId :: Maybe Text
- dryRun :: Maybe Bool
- egressOnlyInternetGatewayId :: Maybe Text
- gatewayId :: Maybe Text
- instanceId :: Maybe Text
- localGatewayId :: Maybe Text
- localTarget :: Maybe Bool
- natGatewayId :: Maybe Text
- networkInterfaceId :: Maybe Text
- transitGatewayId :: Maybe Text
- vpcEndpointId :: Maybe Text
- vpcPeeringConnectionId :: Maybe Text
- routeTableId :: Text
- newReplaceRoute :: Text -> ReplaceRoute
- replaceRoute_carrierGatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_coreNetworkArn :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_destinationCidrBlock :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_destinationIpv6CidrBlock :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_destinationPrefixListId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_dryRun :: Lens' ReplaceRoute (Maybe Bool)
- replaceRoute_egressOnlyInternetGatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_gatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_instanceId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_localGatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_localTarget :: Lens' ReplaceRoute (Maybe Bool)
- replaceRoute_natGatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_networkInterfaceId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_transitGatewayId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_vpcEndpointId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_vpcPeeringConnectionId :: Lens' ReplaceRoute (Maybe Text)
- replaceRoute_routeTableId :: Lens' ReplaceRoute Text
- data ReplaceRouteResponse = ReplaceRouteResponse' {
- newReplaceRouteResponse :: ReplaceRouteResponse
Creating a Request
data ReplaceRoute Source #
See: newReplaceRoute
smart constructor.
ReplaceRoute' | |
|
Instances
Create a value of ReplaceRoute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ReplaceRoute
, replaceRoute_carrierGatewayId
- [IPv4 traffic only] The ID of a carrier gateway.
ReplaceRoute
, replaceRoute_coreNetworkArn
- The Amazon Resource Name (ARN) of the core network.
ReplaceRoute
, replaceRoute_destinationCidrBlock
- The IPv4 CIDR address block used for the destination match. The value
that you provide must match the CIDR of an existing route in the table.
ReplaceRoute
, replaceRoute_destinationIpv6CidrBlock
- The IPv6 CIDR address block used for the destination match. The value
that you provide must match the CIDR of an existing route in the table.
ReplaceRoute
, replaceRoute_destinationPrefixListId
- The ID of the prefix list for the route.
$sel:dryRun:ReplaceRoute'
, replaceRoute_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
.
ReplaceRoute
, replaceRoute_egressOnlyInternetGatewayId
- [IPv6 traffic only] The ID of an egress-only internet gateway.
ReplaceRoute
, replaceRoute_gatewayId
- The ID of an internet gateway or virtual private gateway.
ReplaceRoute
, replaceRoute_instanceId
- The ID of a NAT instance in your VPC.
ReplaceRoute
, replaceRoute_localGatewayId
- The ID of the local gateway.
$sel:localTarget:ReplaceRoute'
, replaceRoute_localTarget
- Specifies whether to reset the local route to its default target
(local
).
ReplaceRoute
, replaceRoute_natGatewayId
- [IPv4 traffic only] The ID of a NAT gateway.
ReplaceRoute
, replaceRoute_networkInterfaceId
- The ID of a network interface.
ReplaceRoute
, replaceRoute_transitGatewayId
- The ID of a transit gateway.
ReplaceRoute
, replaceRoute_vpcEndpointId
- The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints
only.
ReplaceRoute
, replaceRoute_vpcPeeringConnectionId
- The ID of a VPC peering connection.
ReplaceRoute
, replaceRoute_routeTableId
- The ID of the route table.
Request Lenses
replaceRoute_carrierGatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
- IPv4 traffic only
- The ID of a carrier gateway.
replaceRoute_coreNetworkArn :: Lens' ReplaceRoute (Maybe Text) Source #
The Amazon Resource Name (ARN) of the core network.
replaceRoute_destinationCidrBlock :: Lens' ReplaceRoute (Maybe Text) Source #
The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
replaceRoute_destinationIpv6CidrBlock :: Lens' ReplaceRoute (Maybe Text) Source #
The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
replaceRoute_destinationPrefixListId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of the prefix list for the route.
replaceRoute_dryRun :: Lens' ReplaceRoute (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
.
replaceRoute_egressOnlyInternetGatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
- IPv6 traffic only
- The ID of an egress-only internet gateway.
replaceRoute_gatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of an internet gateway or virtual private gateway.
replaceRoute_instanceId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of a NAT instance in your VPC.
replaceRoute_localGatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of the local gateway.
replaceRoute_localTarget :: Lens' ReplaceRoute (Maybe Bool) Source #
Specifies whether to reset the local route to its default target
(local
).
replaceRoute_natGatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
- IPv4 traffic only
- The ID of a NAT gateway.
replaceRoute_networkInterfaceId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of a network interface.
replaceRoute_transitGatewayId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of a transit gateway.
replaceRoute_vpcEndpointId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
replaceRoute_vpcPeeringConnectionId :: Lens' ReplaceRoute (Maybe Text) Source #
The ID of a VPC peering connection.
replaceRoute_routeTableId :: Lens' ReplaceRoute Text Source #
The ID of the route table.
Destructuring the Response
data ReplaceRouteResponse Source #
See: newReplaceRouteResponse
smart constructor.
Instances
Generic ReplaceRouteResponse Source # | |
Defined in Amazonka.EC2.ReplaceRoute type Rep ReplaceRouteResponse :: Type -> Type # from :: ReplaceRouteResponse -> Rep ReplaceRouteResponse x # to :: Rep ReplaceRouteResponse x -> ReplaceRouteResponse # | |
Read ReplaceRouteResponse Source # | |
Defined in Amazonka.EC2.ReplaceRoute | |
Show ReplaceRouteResponse Source # | |
Defined in Amazonka.EC2.ReplaceRoute showsPrec :: Int -> ReplaceRouteResponse -> ShowS # show :: ReplaceRouteResponse -> String # showList :: [ReplaceRouteResponse] -> ShowS # | |
NFData ReplaceRouteResponse Source # | |
Defined in Amazonka.EC2.ReplaceRoute rnf :: ReplaceRouteResponse -> () # | |
Eq ReplaceRouteResponse Source # | |
Defined in Amazonka.EC2.ReplaceRoute (==) :: ReplaceRouteResponse -> ReplaceRouteResponse -> Bool # (/=) :: ReplaceRouteResponse -> ReplaceRouteResponse -> Bool # | |
type Rep ReplaceRouteResponse Source # | |
newReplaceRouteResponse :: ReplaceRouteResponse Source #
Create a value of ReplaceRouteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.