Class: Aws::NetworkManager::Types::RouteAnalysis

Inherits:

Struct

• Object
• Struct
• Aws::NetworkManager::Types::RouteAnalysis

Defined in:

gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb

Overview

Describes a route analysis.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination ⇒ Types::RouteAnalysisEndpointOptions

  The destination.

• #forward_path ⇒ Types::RouteAnalysisPath

  The forward path.

• #global_network_id ⇒ String

  The ID of the global network.

• #include_return_path ⇒ Boolean

  Indicates whether to analyze the return path.

• #owner_account_id ⇒ String

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

• #return_path ⇒ Types::RouteAnalysisPath

  The return path.

• #route_analysis_id ⇒ String

  The ID of the route analysis.

• #source ⇒ Types::RouteAnalysisEndpointOptions

  The source.

• #start_timestamp ⇒ Time

  The time that the analysis started.

• #status ⇒ String

  The status of the route analysis.

• #use_middleboxes ⇒ Boolean

  Indicates whether to include the location of middlebox appliances in the route analysis.

Instance Attribute Details

#destination ⇒ Types::RouteAnalysisEndpointOptions

The destination.

Returns:

• (Types::RouteAnalysisEndpointOptions)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#forward_path ⇒ Types::RouteAnalysisPath

The forward path.

Returns:

• (Types::RouteAnalysisPath)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#global_network_id ⇒ String

The ID of the global network.

Returns:

• (String)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#include_return_path ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#return_path ⇒ Types::RouteAnalysisPath

The return path.

Returns:

• (Types::RouteAnalysisPath)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#route_analysis_id ⇒ String

The ID of the route analysis.

Returns:

• (String)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::RouteAnalysisEndpointOptions

The source.

Returns:

• (Types::RouteAnalysisEndpointOptions)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#start_timestamp ⇒ Time

The time that the analysis started.

Returns:

• (Time)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the route analysis.

Returns:

• (String)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end

#use_middleboxes ⇒ Boolean

Indicates whether to include the location of middlebox appliances in the route analysis.

Returns:

• (Boolean)

# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5599

class RouteAnalysis < Struct.new(
  :global_network_id,
  :owner_account_id,
  :route_analysis_id,
  :start_timestamp,
  :status,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes,
  :forward_path,
  :return_path)
  SENSITIVE = []
  include Aws::Structure
end