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.Types.Route

Description

Synopsis

data Route = Route' {
- carrierGatewayId :: Maybe Text
- coreNetworkArn :: Maybe Text
- destinationCidrBlock :: Maybe Text
- destinationIpv6CidrBlock :: Maybe Text
- destinationPrefixListId :: Maybe Text
- egressOnlyInternetGatewayId :: Maybe Text
- gatewayId :: Maybe Text
- instanceId :: Maybe Text
- instanceOwnerId :: Maybe Text
- localGatewayId :: Maybe Text
- natGatewayId :: Maybe Text
- networkInterfaceId :: Maybe Text
- origin :: Maybe RouteOrigin
- state :: Maybe RouteState
- transitGatewayId :: Maybe Text
- vpcPeeringConnectionId :: Maybe Text
}
newRoute :: Route
route_carrierGatewayId :: Lens' Route (Maybe Text)
route_coreNetworkArn :: Lens' Route (Maybe Text)
route_destinationCidrBlock :: Lens' Route (Maybe Text)
route_destinationIpv6CidrBlock :: Lens' Route (Maybe Text)
route_destinationPrefixListId :: Lens' Route (Maybe Text)
route_egressOnlyInternetGatewayId :: Lens' Route (Maybe Text)
route_gatewayId :: Lens' Route (Maybe Text)
route_instanceId :: Lens' Route (Maybe Text)
route_instanceOwnerId :: Lens' Route (Maybe Text)
route_localGatewayId :: Lens' Route (Maybe Text)
route_natGatewayId :: Lens' Route (Maybe Text)
route_networkInterfaceId :: Lens' Route (Maybe Text)
route_origin :: Lens' Route (Maybe RouteOrigin)
route_state :: Lens' Route (Maybe RouteState)
route_transitGatewayId :: Lens' Route (Maybe Text)
route_vpcPeeringConnectionId :: Lens' Route (Maybe Text)

Documentation

data Route Source #

Describes a route in a route table.

See: newRoute smart constructor.

Constructors

Route'

Fields

carrierGatewayId :: Maybe Text
The ID of the carrier gateway.
coreNetworkArn :: Maybe Text
The Amazon Resource Name (ARN) of the core network.
destinationCidrBlock :: Maybe Text
The IPv4 CIDR block used for the destination match.
destinationIpv6CidrBlock :: Maybe Text
The IPv6 CIDR block used for the destination match.
destinationPrefixListId :: Maybe Text
The prefix of the Amazon Web Service.
egressOnlyInternetGatewayId :: Maybe Text
The ID of the egress-only internet gateway.
gatewayId :: Maybe Text
The ID of a gateway attached to your VPC.
instanceId :: Maybe Text
The ID of a NAT instance in your VPC.
instanceOwnerId :: Maybe Text
The ID of Amazon Web Services account that owns the instance.
localGatewayId :: Maybe Text
The ID of the local gateway.
natGatewayId :: Maybe Text
The ID of a NAT gateway.
networkInterfaceId :: Maybe Text
The ID of the network interface.
origin :: Maybe RouteOrigin
Describes how the route was created.
- CreateRouteTable - The route was automatically created when the route table was created.
- CreateRoute - The route was manually added to the route table.
- EnableVgwRoutePropagation - The route was propagated by route propagation.
state :: Maybe RouteState
The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
transitGatewayId :: Maybe Text
The ID of a transit gateway.
vpcPeeringConnectionId :: Maybe Text
The ID of a VPC peering connection.

Instances

Instances details

FromXML Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods parseXML :: [Node] -> Either String Route #
Generic Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Associated Types type Rep Route :: Type -> Type # Methods from :: Route -> Rep Route x # to :: Rep Route x -> Route #
Read Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods readsPrec :: Int -> ReadS Route # readList :: ReadS [Route] # readPrec :: ReadPrec Route # readListPrec :: ReadPrec [Route] #
Show Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods showsPrec :: Int -> Route -> ShowS # show :: Route -> String # showList :: [Route] -> ShowS #
NFData Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods rnf :: Route -> () #
Eq Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods (==) :: Route -> Route -> Bool # (/=) :: Route -> Route -> Bool #
Hashable Route Source #
Instance details Defined in Amazonka.EC2.Types.Route Methods hashWithSalt :: Int -> Route -> Int # hash :: Route -> Int #
type Rep Route Source #
Instance details Defined in Amazonka.EC2.Types.Route type Rep Route = D1 ('MetaData "Route" "Amazonka.EC2.Types.Route" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "Route'" '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 "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 "instanceOwnerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "localGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "natGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "networkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteOrigin)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteState))) :: (S1 ('MetaSel ('Just "transitGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcPeeringConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newRoute :: Route Source #

Create a value of Route 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:

$sel:carrierGatewayId:Route', route_carrierGatewayId - The ID of the carrier gateway.

$sel:coreNetworkArn:Route', route_coreNetworkArn - The Amazon Resource Name (ARN) of the core network.

$sel:destinationCidrBlock:Route', route_destinationCidrBlock - The IPv4 CIDR block used for the destination match.

$sel:destinationIpv6CidrBlock:Route', route_destinationIpv6CidrBlock - The IPv6 CIDR block used for the destination match.

$sel:destinationPrefixListId:Route', route_destinationPrefixListId - The prefix of the Amazon Web Service.

$sel:egressOnlyInternetGatewayId:Route', route_egressOnlyInternetGatewayId - The ID of the egress-only internet gateway.

$sel:gatewayId:Route', route_gatewayId - The ID of a gateway attached to your VPC.

$sel:instanceId:Route', route_instanceId - The ID of a NAT instance in your VPC.

$sel:instanceOwnerId:Route', route_instanceOwnerId - The ID of Amazon Web Services account that owns the instance.

$sel:localGatewayId:Route', route_localGatewayId - The ID of the local gateway.

$sel:natGatewayId:Route', route_natGatewayId - The ID of a NAT gateway.

$sel:networkInterfaceId:Route', route_networkInterfaceId - The ID of the network interface.

$sel:origin:Route', route_origin - Describes how the route was created.

CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.

$sel:state:Route', route_state - The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

$sel:transitGatewayId:Route', route_transitGatewayId - The ID of a transit gateway.

$sel:vpcPeeringConnectionId:Route', route_vpcPeeringConnectionId - The ID of a VPC peering connection.

route_carrierGatewayId :: Lens' Route (Maybe Text) Source #

The ID of the carrier gateway.

route_coreNetworkArn :: Lens' Route (Maybe Text) Source #

The Amazon Resource Name (ARN) of the core network.

route_destinationCidrBlock :: Lens' Route (Maybe Text) Source #

The IPv4 CIDR block used for the destination match.

route_destinationIpv6CidrBlock :: Lens' Route (Maybe Text) Source #

The IPv6 CIDR block used for the destination match.

route_destinationPrefixListId :: Lens' Route (Maybe Text) Source #

The prefix of the Amazon Web Service.

route_egressOnlyInternetGatewayId :: Lens' Route (Maybe Text) Source #

The ID of the egress-only internet gateway.

route_gatewayId :: Lens' Route (Maybe Text) Source #

The ID of a gateway attached to your VPC.

route_instanceId :: Lens' Route (Maybe Text) Source #

The ID of a NAT instance in your VPC.

route_instanceOwnerId :: Lens' Route (Maybe Text) Source #

The ID of Amazon Web Services account that owns the instance.

route_localGatewayId :: Lens' Route (Maybe Text) Source #

The ID of the local gateway.

route_natGatewayId :: Lens' Route (Maybe Text) Source #

The ID of a NAT gateway.

route_networkInterfaceId :: Lens' Route (Maybe Text) Source #

The ID of the network interface.

route_origin :: Lens' Route (Maybe RouteOrigin) Source #

Describes how the route was created.

CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.

route_state :: Lens' Route (Maybe RouteState) Source #

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

route_transitGatewayId :: Lens' Route (Maybe Text) Source #

The ID of a transit gateway.

route_vpcPeeringConnectionId :: Lens' Route (Maybe Text) Source #

The ID of a VPC peering connection.