Package software.amazon.awssdk.services.internetmonitor.model

Class LocalHealthEventsConfig

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<LocalHealthEventsConfig.Builder,​LocalHealthEventsConfig>
    @Generated("software.amazon.awssdk:codegen")
public final class LocalHealthEventsConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LocalHealthEventsConfig.Builder,​LocalHealthEventsConfig>

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks.

    Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a local health event threshold, the default value is 60%.

    For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

    See Also:
    Serialized Form

    • Method Detail

      • status

        public final LocalHealthEventsConfigStatus status()

        The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.

        If the service returns an enum value that is not available in the current SDK version, status will return LocalHealthEventsConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
        See Also:
        LocalHealthEventsConfigStatus

      • statusAsString

        public final String statusAsString()

        The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.

        If the service returns an enum value that is not available in the current SDK version, status will return LocalHealthEventsConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
        See Also:
        LocalHealthEventsConfigStatus

      • healthScoreThreshold

        public final Double healthScoreThreshold()

        The health event threshold percentage set for a local health score.

        Returns:
        The health event threshold percentage set for a local health score.

      • minTrafficImpact

        public final Double minTrafficImpact()

        The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

        If you don't set a minimum traffic impact threshold, the default value is 0.01%.

        Returns:
        The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

        If you don't set a minimum traffic impact threshold, the default value is 0.01%.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)