DiscoverInstancesRequest

import type { DiscoverInstancesRequest } from "https://aws-api.deno.dev/v0.3/services/servicediscovery.ts?docs=full";

interface DiscoverInstancesRequest {

HealthStatus?: HealthStatusFilter | null;

MaxResults?: number | null;

NamespaceName: string;

OptionalParameters?: {

[key: string]: string | null | undefined;

} | null;

QueryParameters?: {

[key: string]: string | null | undefined;

} | null;

ServiceName: string;

}

§Properties

HealthStatus?: HealthStatusFilter | null

[src]

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.

MaxResults?: number | null

[src]

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.

NamespaceName: string

[src]

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

OptionalParameters?: {

[key: string]: string | null | undefined;

} | null

[src]

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.

QueryParameters?: {

[key: string]: string | null | undefined;

} | null

[src]

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.

ServiceName: string

[src]

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