Class: Aws::ServiceDiscovery::Types::DiscoverInstancesRequest

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

Overview

Note:

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

{
  namespace_name: "NamespaceName", # required
  service_name: "ServiceName", # required
  max_results: 1,
  query_parameters: {
    "AttrKey" => "AttrValue",
  },
  health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#health_statusString

The health status of the instances that you want to discover.

Returns:

  • (String)


538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 538

class DiscoverInstancesRequest < Struct.new(
  :namespace_name,
  :service_name,
  :max_results,
  :query_parameters,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of instances that you want AWS Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

Returns:

  • (Integer)


538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 538

class DiscoverInstancesRequest < Struct.new(
  :namespace_name,
  :service_name,
  :max_results,
  :query_parameters,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_nameString

The name of the namespace that you specified when you registered the instance.

Returns:

  • (String)


538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 538

class DiscoverInstancesRequest < Struct.new(
  :namespace_name,
  :service_name,
  :max_results,
  :query_parameters,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#query_parametersHash<String,String>

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.

Returns:

  • (Hash<String,String>)


538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 538

class DiscoverInstancesRequest < Struct.new(
  :namespace_name,
  :service_name,
  :max_results,
  :query_parameters,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end

#service_nameString

The name of the service that you specified when you registered the instance.

Returns:

  • (String)


538
539
540
541
542
543
544
545
546
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 538

class DiscoverInstancesRequest < Struct.new(
  :namespace_name,
  :service_name,
  :max_results,
  :query_parameters,
  :health_status)
  SENSITIVE = []
  include Aws::Structure
end