software.amazon.awscdk.services.appmesh

Interface OutlierDetection

All Known Implementing Classes:

OutlierDetection.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:27.858Z")
public interface OutlierDetection

Represents the outlier detection for a listener.

Example:

 Mesh mesh;
 // Cloud Map service discovery is currently required for host ejection by outlier detection
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .outlierDetection(OutlierDetection.builder()
                         .baseEjectionDuration(Duration.seconds(10))
                         .interval(Duration.seconds(30))
                         .maxEjectionPercent(50)
                         .maxServerErrors(5)
                         .build())
                 .build())))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OutlierDetection.Builder A builder for OutlierDetection
static class	OutlierDetection.Jsii$Proxy An implementation for OutlierDetection

Method Summary

Modifier and Type	Method and Description
static OutlierDetection.Builder	builder()
Duration	getBaseEjectionDuration() The base amount of time for which a host is ejected.
Duration	getInterval() The time interval between ejection sweep analysis.
java.lang.Number	getMaxEjectionPercent() Maximum percentage of hosts in load balancing pool for upstream service that can be ejected.
java.lang.Number	getMaxServerErrors() Number of consecutive 5xx errors required for ejection.

Method Detail

getBaseEjectionDuration

Duration getBaseEjectionDuration()

The base amount of time for which a host is ejected.

getInterval

Duration getInterval()

The time interval between ejection sweep analysis.

getMaxEjectionPercent

java.lang.Number getMaxEjectionPercent()

Maximum percentage of hosts in load balancing pool for upstream service that can be ejected.

Will eject at least one host regardless of the value.

getMaxServerErrors

java.lang.Number getMaxServerErrors()

Number of consecutive 5xx errors required for ejection.

builder

static OutlierDetection.Builder builder()

Returns:

a OutlierDetection.Builder of OutlierDetection