Class: Aws::EC2::Types::NetworkInsightsAnalysis

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::NetworkInsightsAnalysis

Defined in:

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

Overview

Describes a network insights analysis.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alternate_path_hints ⇒ Array<Types::AlternatePathHint>

  Potential intermediate components.

• #explanations ⇒ Array<Types::Explanation>

  The explanations.

• #filter_in_arns ⇒ Array<String>

  The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.

• #forward_path_components ⇒ Array<Types::PathComponent>

  The components in the path from source to destination.

• #network_insights_analysis_arn ⇒ String

  The Amazon Resource Name (ARN) of the network insights analysis.

• #network_insights_analysis_id ⇒ String

  The ID of the network insights analysis.

• #network_insights_path_id ⇒ String

  The ID of the path.

• #network_path_found ⇒ Boolean

  Indicates whether the destination is reachable from the source.

• #return_path_components ⇒ Array<Types::PathComponent>

  The components in the path from destination to source.

• #start_date ⇒ Time

  The time the analysis started.

• #status ⇒ String

  The status of the network insights analysis.

• #status_message ⇒ String

  The status message, if the status is failed.

• #tags ⇒ Array<Types::Tag>

  The tags.

• #warning_message ⇒ String

  The warning message.

Instance Attribute Details

#alternate_path_hints ⇒ Array<Types::AlternatePathHint>

Potential intermediate components.

Returns:

• (Array<Types::AlternatePathHint>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#explanations ⇒ Array<Types::Explanation>

The explanations. For more information, see Reachability Analyzer explanation codes.

Returns:

• (Array<Types::Explanation>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#filter_in_arns ⇒ Array<String>

The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#forward_path_components ⇒ Array<Types::PathComponent>

The components in the path from source to destination.

Returns:

• (Array<Types::PathComponent>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_insights_analysis_arn ⇒ String

The Amazon Resource Name (ARN) of the network insights analysis.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_insights_analysis_id ⇒ String

The ID of the network insights analysis.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_insights_path_id ⇒ String

The ID of the path.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_path_found ⇒ Boolean

Indicates whether the destination is reachable from the source.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#return_path_components ⇒ Array<Types::PathComponent>

The components in the path from destination to source.

Returns:

• (Array<Types::PathComponent>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The time the analysis started.

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the network insights analysis.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

The status message, if the status is failed.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#warning_message ⇒ String

The warning message.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 52866

class NetworkInsightsAnalysis < Struct.new(
  :network_insights_analysis_id,
  :network_insights_analysis_arn,
  :network_insights_path_id,
  :filter_in_arns,
  :start_date,
  :status,
  :status_message,
  :warning_message,
  :network_path_found,
  :forward_path_components,
  :return_path_components,
  :explanations,
  :alternate_path_hints,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end