Class: Aws::ApplicationDiscoveryService::Types::ListServerNeighborsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-applicationdiscoveryservice/types.rb

Overview

Note:

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

{
  configuration_id: "ConfigurationId", # required
  port_information_needed: false,
  neighbor_configuration_ids: ["ConfigurationId"],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_idString

Configuration ID of the server for which neighbors are being listed.

Returns:

  • (String)


1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1432

class ListServerNeighborsRequest < Struct.new(
  :configuration_id,
  :port_information_needed,
  :neighbor_configuration_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

Maximum number of results to return in a single page of output.

Returns:

  • (Integer)


1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1432

class ListServerNeighborsRequest < Struct.new(
  :configuration_id,
  :port_information_needed,
  :neighbor_configuration_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#neighbor_configuration_idsArray<String>

List of configuration IDs to test for one-hop-away.

Returns:

  • (Array<String>)


1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1432

class ListServerNeighborsRequest < Struct.new(
  :configuration_id,
  :port_information_needed,
  :neighbor_configuration_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ‘ListServerNeighborsRequest$neighborConfigurationIds` but set `ListServerNeighborsRequest$maxResults` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Returns:

  • (String)


1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1432

class ListServerNeighborsRequest < Struct.new(
  :configuration_id,
  :port_information_needed,
  :neighbor_configuration_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#port_information_neededBoolean

Flag to indicate if port and protocol information is needed as part of the response.

Returns:

  • (Boolean)


1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1432

class ListServerNeighborsRequest < Struct.new(
  :configuration_id,
  :port_information_needed,
  :neighbor_configuration_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end