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.NetworkManager.Types.RouteAnalysis

Description

Synopsis

data RouteAnalysis = RouteAnalysis' {
- destination :: Maybe RouteAnalysisEndpointOptions
- forwardPath :: Maybe RouteAnalysisPath
- globalNetworkId :: Maybe Text
- includeReturnPath :: Maybe Bool
- ownerAccountId :: Maybe Text
- returnPath :: Maybe RouteAnalysisPath
- routeAnalysisId :: Maybe Text
- source :: Maybe RouteAnalysisEndpointOptions
- startTimestamp :: Maybe POSIX
- status :: Maybe RouteAnalysisStatus
- useMiddleboxes :: Maybe Bool
}
newRouteAnalysis :: RouteAnalysis
routeAnalysis_destination :: Lens' RouteAnalysis (Maybe RouteAnalysisEndpointOptions)
routeAnalysis_forwardPath :: Lens' RouteAnalysis (Maybe RouteAnalysisPath)
routeAnalysis_globalNetworkId :: Lens' RouteAnalysis (Maybe Text)
routeAnalysis_includeReturnPath :: Lens' RouteAnalysis (Maybe Bool)
routeAnalysis_ownerAccountId :: Lens' RouteAnalysis (Maybe Text)
routeAnalysis_returnPath :: Lens' RouteAnalysis (Maybe RouteAnalysisPath)
routeAnalysis_routeAnalysisId :: Lens' RouteAnalysis (Maybe Text)
routeAnalysis_source :: Lens' RouteAnalysis (Maybe RouteAnalysisEndpointOptions)
routeAnalysis_startTimestamp :: Lens' RouteAnalysis (Maybe UTCTime)
routeAnalysis_status :: Lens' RouteAnalysis (Maybe RouteAnalysisStatus)
routeAnalysis_useMiddleboxes :: Lens' RouteAnalysis (Maybe Bool)

Documentation

data RouteAnalysis Source #

Describes a route analysis.

See: newRouteAnalysis smart constructor.

Constructors

RouteAnalysis'

Fields

destination :: Maybe RouteAnalysisEndpointOptions
The destination.
forwardPath :: Maybe RouteAnalysisPath
The forward path.
globalNetworkId :: Maybe Text
The ID of the global network.
includeReturnPath :: Maybe Bool
Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
ownerAccountId :: Maybe Text
The ID of the AWS account that created the route analysis.
returnPath :: Maybe RouteAnalysisPath
The return path.
routeAnalysisId :: Maybe Text
The ID of the route analysis.
source :: Maybe RouteAnalysisEndpointOptions
The source.
startTimestamp :: Maybe POSIX
The time that the analysis started.
status :: Maybe RouteAnalysisStatus
The status of the route analysis.
useMiddleboxes :: Maybe Bool
Indicates whether to include the location of middlebox appliances in the route analysis.

Instances

Instances details

FromJSON RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods parseJSON :: Value -> Parser RouteAnalysis # parseJSONList :: Value -> Parser [RouteAnalysis] #
Generic RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Associated Types type Rep RouteAnalysis :: Type -> Type # Methods from :: RouteAnalysis -> Rep RouteAnalysis x # to :: Rep RouteAnalysis x -> RouteAnalysis #
Read RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods readsPrec :: Int -> ReadS RouteAnalysis # readList :: ReadS [RouteAnalysis] # readPrec :: ReadPrec RouteAnalysis # readListPrec :: ReadPrec [RouteAnalysis] #
Show RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods showsPrec :: Int -> RouteAnalysis -> ShowS # show :: RouteAnalysis -> String # showList :: [RouteAnalysis] -> ShowS #
NFData RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods rnf :: RouteAnalysis -> () #
Eq RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods (==) :: RouteAnalysis -> RouteAnalysis -> Bool # (/=) :: RouteAnalysis -> RouteAnalysis -> Bool #
Hashable RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis Methods hashWithSalt :: Int -> RouteAnalysis -> Int # hash :: RouteAnalysis -> Int #
type Rep RouteAnalysis Source #
Instance details Defined in Amazonka.NetworkManager.Types.RouteAnalysis type Rep RouteAnalysis = D1 ('MetaData "RouteAnalysis" "Amazonka.NetworkManager.Types.RouteAnalysis" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "RouteAnalysis'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteAnalysisEndpointOptions)) :: S1 ('MetaSel ('Just "forwardPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteAnalysisPath))) :: (S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "includeReturnPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "returnPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteAnalysisPath)) :: (S1 ('MetaSel ('Just "routeAnalysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteAnalysisEndpointOptions)))) :: (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteAnalysisStatus)) :: S1 ('MetaSel ('Just "useMiddleboxes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newRouteAnalysis :: RouteAnalysis Source #

Create a value of RouteAnalysis 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:destination:RouteAnalysis', routeAnalysis_destination - The destination.

$sel:forwardPath:RouteAnalysis', routeAnalysis_forwardPath - The forward path.

$sel:globalNetworkId:RouteAnalysis', routeAnalysis_globalNetworkId - The ID of the global network.

$sel:includeReturnPath:RouteAnalysis', routeAnalysis_includeReturnPath - Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

$sel:ownerAccountId:RouteAnalysis', routeAnalysis_ownerAccountId - The ID of the AWS account that created the route analysis.

$sel:returnPath:RouteAnalysis', routeAnalysis_returnPath - The return path.

$sel:routeAnalysisId:RouteAnalysis', routeAnalysis_routeAnalysisId - The ID of the route analysis.

$sel:source:RouteAnalysis', routeAnalysis_source - The source.

$sel:startTimestamp:RouteAnalysis', routeAnalysis_startTimestamp - The time that the analysis started.

$sel:status:RouteAnalysis', routeAnalysis_status - The status of the route analysis.

$sel:useMiddleboxes:RouteAnalysis', routeAnalysis_useMiddleboxes - Indicates whether to include the location of middlebox appliances in the route analysis.

routeAnalysis_destination :: Lens' RouteAnalysis (Maybe RouteAnalysisEndpointOptions) Source #

The destination.

routeAnalysis_forwardPath :: Lens' RouteAnalysis (Maybe RouteAnalysisPath) Source #

The forward path.

routeAnalysis_globalNetworkId :: Lens' RouteAnalysis (Maybe Text) Source #

The ID of the global network.

routeAnalysis_includeReturnPath :: Lens' RouteAnalysis (Maybe Bool) Source #

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

routeAnalysis_ownerAccountId :: Lens' RouteAnalysis (Maybe Text) Source #

The ID of the AWS account that created the route analysis.

routeAnalysis_returnPath :: Lens' RouteAnalysis (Maybe RouteAnalysisPath) Source #

The return path.