You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DiscoverInstancesRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#health_status ⇒ String

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

Possible values:

  • HEALTHY
  • UNHEALTHY
  • ALL

Returns:

  • (String) —

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

#max_results ⇒ Integer

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) —

    The maximum number of instances that you want AWS Cloud Map to return in the response to a DiscoverInstances request.

#namespace_name ⇒ String

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

Returns:

  • (String) —

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

#optional_parameters ⇒ Hash<String,String>

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, they are returned. Otherwise, these filters are ignored and only instances that match the filters specified in the QueryParameters parameter are returned.

Returns:

  • (Hash<String,String>) —

    Opportunistic filters to scope the results based on custom attributes.

#query_parameters ⇒ Hash<String,String>

Filters to scope the results based on custom attributes for the instance. For example, {version=v1, az=1a}. Only instances that match all the specified key-value pairs will be returned.

Returns:

  • (Hash<String,String>) —

    Filters to scope the results based on custom attributes for the instance.

#service_name ⇒ String

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

Returns:

  • (String) —

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