Struct aws_sdk_servicediscovery::client::fluent_builders::DiscoverInstances

source · [−]

pub struct DiscoverInstances { /* private fields */ }

Expand description

Fluent builder constructing a request to DiscoverInstances.

Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.

Implementations

source

impl DiscoverInstances

source

pub async fn send(
self
) -> Result<DiscoverInstancesOutput, SdkError<DiscoverInstancesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn namespace_name(self, input: impl Into<String>) -> Self

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

source

pub fn set_namespace_name(self, input: Option<String>) -> Self

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

source

pub fn service_name(self, input: impl Into<String>) -> Self

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

source

pub fn set_service_name(self, input: Option<String>) -> Self

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

source

pub fn max_results(self, input: i32) -> Self

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.

source

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

source

pub fn query_parameters(
 self,
 k: impl Into<String>,
 v: impl Into<String>
) -> Self

Adds a key-value pair to QueryParameters.

To override the contents of this collection use set_query_parameters.

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.

source

pub fn set_query_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self

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.

source

pub fn optional_parameters(
 self,
 k: impl Into<String>,
 v: impl Into<String>
) -> Self

Adds a key-value pair to OptionalParameters.

To override the contents of this collection use set_optional_parameters.

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.

source

pub fn set_optional_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self

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.

source

pub fn health_status(self, input: HealthStatusFilter) -> Self

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.

source

pub fn set_health_status(self, input: Option<HealthStatusFilter>) -> Self

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.