Package software.amazon.awssdk.services.budgets.model

Class 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:
    Serialized Form

    • Method Detail

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

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

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

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

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

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

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