Struct aws_sdk_servicediscovery::input::DiscoverInstancesInput

#[non_exhaustive]
pub struct DiscoverInstancesInput {
    pub namespace_name: Option<String>,
    pub service_name: Option<String>,
    pub max_results: Option<i32>,
    pub query_parameters: Option<HashMap<String, String>>,
    pub optional_parameters: Option<HashMap<String, String>>,
    pub health_status: Option<HealthStatusFilter>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

namespace_name: Option<String>

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

service_name: Option<String>

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

max_results: Option<i32>

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.

query_parameters: Option<HashMap<String, String>>

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.

optional_parameters: Option<HashMap<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, 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.

health_status: Option<HealthStatusFilter>

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.

Implementations

impl DiscoverInstancesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DiscoverInstances, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DiscoverInstances>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DiscoverInstancesInput

impl DiscoverInstancesInput

pub fn namespace_name(&self) -> Option<&str>

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

pub fn service_name(&self) -> Option<&str>

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

pub fn max_results(&self) -> Option<i32>

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.

pub fn query_parameters(&self) -> Option<&HashMap<String, String>>

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.

pub fn optional_parameters(&self) -> Option<&HashMap<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, 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.

pub fn health_status(&self) -> Option<&HealthStatusFilter>

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.

Trait Implementations

impl Clone for DiscoverInstancesInput

fn clone(&self) -> DiscoverInstancesInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DiscoverInstancesInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DiscoverInstancesInput> for DiscoverInstancesInput

fn eq(&self, other: &DiscoverInstancesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DiscoverInstancesInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DiscoverInstancesInput