Class Notification

java.lang.Object
software.amazon.awssdk.services.budgets.model.Notification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Notification.Builder,Notification>

@Generated("software.amazon.awssdk:codegen") public final class Notification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Notification.Builder,Notification>

A notification that's associated with a budget. A budget can have up to ten notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL

  • A thresholdType of PERCENTAGE

  • A comparisonOperator of GREATER_THAN

  • A notification threshold of 80

See Also:
  • Method Details

    • notificationType

      public final NotificationType notificationType()

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

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

      Returns:
      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).
      See Also:
    • notificationTypeAsString

      public final String notificationTypeAsString()

      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

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

      Returns:
      Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).
      See Also:
    • comparisonOperator

      public final ComparisonOperator comparisonOperator()

      The comparison that's used for this notification.

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

      Returns:
      The comparison that's used for this notification.
      See Also:
    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      The comparison that's used for this notification.

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

      Returns:
      The comparison that's used for this notification.
      See Also:
    • threshold

      public final Double threshold()

      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

      Returns:
      The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
    • thresholdType

      public final ThresholdType thresholdType()

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

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

      Returns:
      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
      See Also:
    • thresholdTypeAsString

      public final String thresholdTypeAsString()

      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

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

      Returns:
      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
      See Also:
    • notificationState

      public final NotificationState notificationState()

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

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

      Returns:
      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
      See Also:
    • notificationStateAsString

      public final String notificationStateAsString()

      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

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

      Returns:
      Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
      See Also:
    • toBuilder

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

      public static Notification.Builder builder()
    • serializableBuilderClass

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