Class HealthEventsConfig

java.lang.Object
software.amazon.awssdk.services.internetmonitor.model.HealthEventsConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HealthEventsConfig.Builder,HealthEventsConfig>
@Generated("software.amazon.awssdk:codegen") public final class HealthEventsConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthEventsConfig.Builder,HealthEventsConfig>

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

See Also:

  • Method Details

    • availabilityScoreThreshold

      public final Double availabilityScoreThreshold()

      The health event threshold percentage set for availability scores.

      Returns:
      The health event threshold percentage set for availability scores.

    • performanceScoreThreshold

      public final Double performanceScoreThreshold()

      The health event threshold percentage set for performance scores.

      Returns:
      The health event threshold percentage set for performance scores.

    • availabilityLocalHealthEventsConfig

      public final LocalHealthEventsConfig availabilityLocalHealthEventsConfig()

      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

      Returns:
      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

    • performanceLocalHealthEventsConfig

      public final LocalHealthEventsConfig performanceLocalHealthEventsConfig()

      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

      Returns:
      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

    • toBuilder

      public HealthEventsConfig.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<HealthEventsConfig.Builder,HealthEventsConfig>
      Returns:
      a builder for type T

    • builder

      public static HealthEventsConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HealthEventsConfig.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.