Class: Aws::NetworkManager::Types::StartRouteAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb

Overview

Note:

When making an API call, you may pass StartRouteAnalysisRequest data as a hash:

{
  global_network_id: "GlobalNetworkId", # required
  source: { # required
    transit_gateway_attachment_arn: "TransitGatewayAttachmentArn",
    ip_address: "IPAddress",
  },
  destination: { # required
    transit_gateway_attachment_arn: "TransitGatewayAttachmentArn",
    ip_address: "IPAddress",
  },
  include_return_path: false,
  use_middleboxes: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationTypes::RouteAnalysisEndpointOptionsSpecification

The destination.



5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5944

class StartRouteAnalysisRequest < Struct.new(
  :global_network_id,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes)
  SENSITIVE = []
  include Aws::Structure
end

#global_network_idString

The ID of the global network.

Returns:

  • (String)


5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5944

class StartRouteAnalysisRequest < Struct.new(
  :global_network_id,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes)
  SENSITIVE = []
  include Aws::Structure
end

#include_return_pathBoolean

Indicates whether to analyze the return path. The default is false.

Returns:

  • (Boolean)


5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5944

class StartRouteAnalysisRequest < Struct.new(
  :global_network_id,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes)
  SENSITIVE = []
  include Aws::Structure
end

#sourceTypes::RouteAnalysisEndpointOptionsSpecification

The source from which traffic originates.



5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5944

class StartRouteAnalysisRequest < Struct.new(
  :global_network_id,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes)
  SENSITIVE = []
  include Aws::Structure
end

#use_middleboxesBoolean

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

Returns:

  • (Boolean)


5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 5944

class StartRouteAnalysisRequest < Struct.new(
  :global_network_id,
  :source,
  :destination,
  :include_return_path,
  :use_middleboxes)
  SENSITIVE = []
  include Aws::Structure
end