Class LocalHealthEventsConfig

java.lang.Object
software.amazon.awssdk.services.internetmonitor.model.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:

  • Method Details

    • 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:

    • 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:

    • 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.1%.

      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.1%.

    • toBuilder

      public LocalHealthEventsConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LocalHealthEventsConfig.Builder,LocalHealthEventsConfig>
      Returns:
      a builder for type T

    • builder

      public static LocalHealthEventsConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LocalHealthEventsConfig.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.