NetworkInsightsAnalysisState class

Input properties used for looking up and filtering NetworkInsightsAnalysis resources.

Constructors

NetworkInsightsAnalysisState({Input<List<NetworkInsightsAnalysisAlternatePathHint>?>? alternatePathHints, Input<String?>? arn, Input<List<NetworkInsightsAnalysisExplanation>?>? explanations, Input<List<String>?>? filterInArns, Input<List<NetworkInsightsAnalysisForwardPathComponent>?>? forwardPathComponents, Input<String?>? networkInsightsPathId, Input<bool?>? pathFound, Input<String?>? region, Input<List<NetworkInsightsAnalysisReturnPathComponent>?>? returnPathComponents, Input<String?>? startDate, Input<String?>? status, Input<String?>? statusMessage, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<bool?>? waitForCompletion, Input<String?>? warningMessage})
Creates a new NetworkInsightsAnalysisState. alternatePathHints Potential intermediate components of a feasible path. Described below. arn ARN of the Network Insights Analysis. explanations Explanation codes for an unreachable path. See the AWS documentation for details. filterInArns A list of ARNs for resources the path must traverse. forwardPathComponents The components in the path from source to destination. See the AWS documentation for details. networkInsightsPathId ID of the Network Insights Path to run an analysis on. pathFound Set to true if the destination was reachable. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. returnPathComponents The components in the path from destination to source. See the AWS documentation for details. startDate The date/time the analysis was started. status The status of the analysis. succeeded means the analysis was completed, not that a path was found, for that see pathFound. statusMessage A message to provide more context when the status is failed. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. waitForCompletion If enabled, the resource will wait for the Network Insights Analysis status to change to succeeded or failed. Setting this to false will skip the process. Default: true. warningMessage The warning message.
const
NetworkInsightsAnalysisState.fromMap(Map<String, dynamic> map)
factory

Properties

alternatePathHints → Input<List<NetworkInsightsAnalysisAlternatePathHint>?>?
Potential intermediate components of a feasible path. Described below.
final
arn → Input<String?>?
ARN of the Network Insights Analysis.
final
explanations → Input<List<NetworkInsightsAnalysisExplanation>?>?
Explanation codes for an unreachable path. See the AWS documentation for details.
final
filterInArns → Input<List<String>?>?
A list of ARNs for resources the path must traverse.
final
forwardPathComponents → Input<List<NetworkInsightsAnalysisForwardPathComponent>?>?
The components in the path from source to destination. See the AWS documentation for details.
final
hashCode → int
The hash code for this object.
no setterinherited
networkInsightsPathId → Input<String?>?
ID of the Network Insights Path to run an analysis on.
final
pathFound → Input<bool?>?
Set to true if the destination was reachable.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
returnPathComponents → Input<List<NetworkInsightsAnalysisReturnPathComponent>?>?
The components in the path from destination to source. See the AWS documentation for details.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startDate → Input<String?>?
The date/time the analysis was started.
final
status → Input<String?>?
The status of the analysis. succeeded means the analysis was completed, not that a path was found, for that see pathFound.
final
statusMessage → Input<String?>?
A message to provide more context when the status is failed.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
waitForCompletion → Input<bool?>?
If enabled, the resource will wait for the Network Insights Analysis status to change to succeeded or failed. Setting this to false will skip the process. Default: true.
final
warningMessage → Input<String?>?
The warning message.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited