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

Amazonka.EC2.ReplaceRoute

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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.

Constructors

ReplaceRoute'

Fields

carrierGatewayId :: Maybe Text
IPv4 traffic only
The ID of a carrier gateway.
coreNetworkArn :: Maybe Text
The Amazon Resource Name (ARN) of the core network.
destinationCidrBlock :: Maybe Text
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.
destinationIpv6CidrBlock :: Maybe Text
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.
destinationPrefixListId :: Maybe Text
The ID of the prefix list for the route.
dryRun :: 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.
egressOnlyInternetGatewayId :: Maybe Text
IPv6 traffic only
The ID of an egress-only internet gateway.
gatewayId :: Maybe Text
The ID of an internet gateway or virtual private gateway.
instanceId :: Maybe Text
The ID of a NAT instance in your VPC.
localGatewayId :: Maybe Text
The ID of the local gateway.
localTarget :: Maybe Bool
Specifies whether to reset the local route to its default target (local).
natGatewayId :: Maybe Text
IPv4 traffic only
The ID of a NAT gateway.
networkInterfaceId :: Maybe Text
The ID of a network interface.
transitGatewayId :: Maybe Text
The ID of a transit gateway.
vpcEndpointId :: Maybe Text
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
vpcPeeringConnectionId :: Maybe Text
The ID of a VPC peering connection.
routeTableId :: Text
The ID of the route table.

Instances

Instances details

ToHeaders ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods toHeaders :: ReplaceRoute -> [Header] #
ToPath ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods toPath :: ReplaceRoute -> ByteString #
ToQuery ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods toQuery :: ReplaceRoute -> QueryString #
AWSRequest ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Associated Types type AWSResponse ReplaceRoute # Methods request :: (Service -> Service) -> ReplaceRoute -> Request ReplaceRoute # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReplaceRoute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReplaceRoute))) #
Generic ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Associated Types type Rep ReplaceRoute :: Type -> Type # Methods from :: ReplaceRoute -> Rep ReplaceRoute x # to :: Rep ReplaceRoute x -> ReplaceRoute #
Read ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods readsPrec :: Int -> ReadS ReplaceRoute # readList :: ReadS [ReplaceRoute] # readPrec :: ReadPrec ReplaceRoute # readListPrec :: ReadPrec [ReplaceRoute] #
Show ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods showsPrec :: Int -> ReplaceRoute -> ShowS # show :: ReplaceRoute -> String # showList :: [ReplaceRoute] -> ShowS #
NFData ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods rnf :: ReplaceRoute -> () #
Eq ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods (==) :: ReplaceRoute -> ReplaceRoute -> Bool # (/=) :: ReplaceRoute -> ReplaceRoute -> Bool #
Hashable ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods hashWithSalt :: Int -> ReplaceRoute -> Int # hash :: ReplaceRoute -> Int #
type AWSResponse ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute type AWSResponse ReplaceRoute = ReplaceRouteResponse
type Rep ReplaceRoute Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute type Rep ReplaceRoute = D1 ('MetaData "ReplaceRoute" "Amazonka.EC2.ReplaceRoute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ReplaceRoute'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "carrierGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "coreNetworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "destinationCidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "destinationIpv6CidrBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "destinationPrefixListId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "egressOnlyInternetGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "localGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "localTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "natGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "networkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "transitGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcPeeringConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "routeTableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newReplaceRoute Source #

Arguments

:: Text	`ReplaceRoute`
-> ReplaceRoute

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.

Constructors

ReplaceRouteResponse'

Instances

Instances details

Generic ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Associated Types type Rep ReplaceRouteResponse :: Type -> Type # Methods from :: ReplaceRouteResponse -> Rep ReplaceRouteResponse x # to :: Rep ReplaceRouteResponse x -> ReplaceRouteResponse #
Read ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods readsPrec :: Int -> ReadS ReplaceRouteResponse # readList :: ReadS [ReplaceRouteResponse] # readPrec :: ReadPrec ReplaceRouteResponse # readListPrec :: ReadPrec [ReplaceRouteResponse] #
Show ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods showsPrec :: Int -> ReplaceRouteResponse -> ShowS # show :: ReplaceRouteResponse -> String # showList :: [ReplaceRouteResponse] -> ShowS #
NFData ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods rnf :: ReplaceRouteResponse -> () #
Eq ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute Methods (==) :: ReplaceRouteResponse -> ReplaceRouteResponse -> Bool # (/=) :: ReplaceRouteResponse -> ReplaceRouteResponse -> Bool #
type Rep ReplaceRouteResponse Source #
Instance details Defined in Amazonka.EC2.ReplaceRoute type Rep ReplaceRouteResponse = D1 ('MetaData "ReplaceRouteResponse" "Amazonka.EC2.ReplaceRoute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ReplaceRouteResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newReplaceRouteResponse :: ReplaceRouteResponse Source #

Create a value of ReplaceRouteResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.