Class: Aws::ServiceDiscovery::Types::DiscoverInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ServiceDiscovery::Types::DiscoverInstancesRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-servicediscovery/types.rb
Overview
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
}
Instance Attribute Summary collapse
-
#health_status ⇒ String
The health status of the instances that you want to discover.
-
#max_results ⇒ Integer
The maximum number of instances that you want 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.
-
#query_parameters ⇒ Hash<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.
-
#service_name ⇒ String
The name of the service that you specified when you registered the instance.
Instance Attribute Details
#health_status ⇒ String
The health status of the instances that you want to discover.
401 402 403 404 405 406 407 408 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 401 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :health_status) 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.
401 402 403 404 405 406 407 408 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 401 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :health_status) include Aws::Structure end |
#namespace_name ⇒ String
The name of the namespace that you specified when you registered the instance.
401 402 403 404 405 406 407 408 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 401 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :health_status) include Aws::Structure end |
#query_parameters ⇒ Hash<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.
401 402 403 404 405 406 407 408 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 401 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :health_status) include Aws::Structure end |
#service_name ⇒ String
The name of the service that you specified when you registered the instance.
401 402 403 404 405 406 407 408 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 401 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :health_status) include Aws::Structure end |