Class AwsCloudWatchAlarmDetails

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

Specifies an alarm and associates it with the specified metric or metric math expression.

See Also:

  • Method Details

    • actionsEnabled

      public final Boolean actionsEnabled()

      Indicates whether actions should be executed during any changes to the alarm state.

      Returns:
      Indicates whether actions should be executed during any changes to the alarm state.

    • hasAlarmActions

      public final boolean hasAlarmActions()
      For responses, this returns true if the service returned a value for the AlarmActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • alarmActions

      public final List<String> alarmActions()

      The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarmActions() method.

      Returns:
      The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

    • alarmArn

      public final String alarmArn()

      The ARN of the alarm.

      Returns:
      The ARN of the alarm.

    • alarmConfigurationUpdatedTimestamp

      public final String alarmConfigurationUpdatedTimestamp()

      The time stamp of the last update to the alarm configuration.

      Returns:
      The time stamp of the last update to the alarm configuration.

    • alarmDescription

      public final String alarmDescription()

      The description of the alarm.

      Returns:
      The description of the alarm.

    • alarmName

      public final String alarmName()

      The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

      Returns:
      The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

    • comparisonOperator

      public final String comparisonOperator()

      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      Returns:
      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

    • datapointsToAlarm

      public final Integer datapointsToAlarm()

      The number of datapoints that must be breaching to trigger the alarm.

      Returns:
      The number of datapoints that must be breaching to trigger the alarm.

    • hasDimensions

      public final boolean hasDimensions()
      For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dimensions

      public final List<AwsCloudWatchAlarmDimensionsDetails> dimensions()

      The dimensions for the metric associated with the alarm.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

      Returns:
      The dimensions for the metric associated with the alarm.

    • evaluateLowSampleCountPercentile

      public final String evaluateLowSampleCountPercentile()

      Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

      Returns:
      Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

    • evaluationPeriods

      public final Integer evaluationPeriods()

      The number of periods over which data is compared to the specified threshold.

      Returns:
      The number of periods over which data is compared to the specified threshold.

    • extendedStatistic

      public final String extendedStatistic()

      The percentile statistic for the metric associated with the alarm.

      Returns:
      The percentile statistic for the metric associated with the alarm.

    • hasInsufficientDataActions

      public final boolean hasInsufficientDataActions()
      For responses, this returns true if the service returned a value for the InsufficientDataActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • insufficientDataActions

      public final List<String> insufficientDataActions()

      The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsufficientDataActions() method.

      Returns:
      The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

    • metricName

      public final String metricName()

      The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

      Returns:
      The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

    • namespace

      public final String namespace()

      The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

      Returns:
      The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

    • hasOkActions

      public final boolean hasOkActions()
      For responses, this returns true if the service returned a value for the OkActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • okActions

      public final List<String> okActions()

      The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOkActions() method.

      Returns:
      The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

    • period

      public final Integer period()

      The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

      Returns:
      The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

    • statistic

      public final String statistic()

      The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

      For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

      For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

      Returns:
      The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

      For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

      For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

    • threshold

      public final Double threshold()

      The value to compare with the specified statistic.

      Returns:
      The value to compare with the specified statistic.

    • thresholdMetricId

      public final String thresholdMetricId()

      n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

      Returns:
      n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

    • treatMissingData

      public final String treatMissingData()

      Sets how this alarm is to handle missing data points.

      Returns:
      Sets how this alarm is to handle missing data points.

    • unit

      public final String unit()

      The unit of the metric associated with the alarm.

      Returns:
      The unit of the metric associated with the alarm.

    • toBuilder

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

    • builder

      public static AwsCloudWatchAlarmDetails.Builder builder()

    • serializableBuilderClass

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