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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#health_status ⇒ String

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.

Returns:

  • (String) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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

#max_results ⇒ Integer

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.

Returns:

  • (Integer) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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

#namespace_name ⇒ String

The ‘HttpName` name of the namespace. It’s found in the ‘HttpProperties` member of the `Properties` member of the namespace. In most cases, `Name` and `HttpName` match. However, if you reuse `Name` for namespace creation, a generated hash is added to `HttpName` to distinguish the two.

Returns:

  • (String) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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

#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, 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.

Returns:

  • (Hash<String,String>) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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

#query_parameters ⇒ Hash<String,String>

Filters to scope the results based on custom attributes for the instance (for example, ‘az=1a`). Only instances that match all the specified key-value pairs are returned.

Returns:

  • (Hash<String,String>) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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

#service_name ⇒ String

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

Returns:

  • (String) 


513
514
515
516
517
518
519
520
521
522
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 513

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