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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
  },
  optional_parameters: {
    "AttrKey" => "AttrValue",
  },
  health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
}

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.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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, found in the `HttpProperties` member of the `Properties` member of the namespace.

Returns:

  • (String) 


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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) 


569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 569

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