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",
},
optional_parameters: {
"AttrKey" => "AttrValue",
},
health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
}
Constant Summary collapse
- SENSITIVE =
[]
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 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.
-
#optional_parameters ⇒ 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.
-
#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.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 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.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 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 name of the namespace that you specified when you registered the instance.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 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.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 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 will be returned.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 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.
549 550 551 552 553 554 555 556 557 558 |
# File 'lib/aws-sdk-servicediscovery/types.rb', line 549 class DiscoverInstancesRequest < Struct.new( :namespace_name, :service_name, :max_results, :query_parameters, :optional_parameters, :health_status) SENSITIVE = [] include Aws::Structure end |