class Aws::ServiceDiscovery::Types::DiscoverInstancesRequest

@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",
      },
      optional_parameters: {
        "AttrKey" => "AttrValue",
      },
      health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
    }

@!attribute [rw] namespace_name

The `HttpName` name of the namespace. It's found in the
`HttpProperties` member of the `Properties` member of the namespace.
@return [String]

@!attribute [rw] service_name

The name of the service that you specified when you registered the
instance.
@return [String]

@!attribute [rw] max_results

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

@!attribute [rw] query_parameters

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 are returned.
@return [Hash<String,String>]

@!attribute [rw] optional_parameters

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, all of these instances are returned. Otherwise, the
filters are ignored, and only instances that match the filters that
are specified in the `QueryParameters` parameter are returned.
@return [Hash<String,String>]

@!attribute [rw] health_status

The health status of the instances that you want to discover. This
parameter is ignored for services that don't have a health check
configured, and all instances are returned.

HEALTHY

: Returns healthy instances.

UNHEALTHY

: Returns unhealthy instances.

ALL

: Returns all instances.

HEALTHY\_OR\_ELSE\_ALL

: Returns healthy instances, unless none are reporting a healthy
  state. In that case, return all instances. This is also called
  failing open.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstancesRequest AWS API Documentation

Constants

SENSITIVE