Class Notification
- All Implemented Interfaces:
Serializable
,SdkPojo
,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
ofPERCENTAGE
-
A
comparisonOperator
ofGREATER_THAN
-
A notification
threshold
of80
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Notification.Builder
builder()
final ComparisonOperator
The comparison that's used for this notification.final String
The comparison that's used for this notification.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final NotificationState
Specifies whether this notification is in alarm.final String
Specifies whether this notification is in alarm.final NotificationType
Specifies whether the notification is for how much you have spent (ACTUAL
) or for how much that you're forecasted to spend (FORECASTED
).final String
Specifies whether the notification is for how much you have spent (ACTUAL
) or for how much that you're forecasted to spend (FORECASTED
).static Class
<? extends Notification.Builder> final Double
The threshold that's associated with a notification.final ThresholdType
The type of threshold for a notification.final String
The type of threshold for a notification.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnNotificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotificationTypeAsString()
.- 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
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 returnNotificationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotificationTypeAsString()
.- 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
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- The comparison that's used for this notification.
- See Also:
-
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- The comparison that's used for this notification.
- See Also:
-
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
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. ForPERCENTAGE
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 aPERCENTAGE
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 returnThresholdType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthresholdTypeAsString()
.- 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. ForPERCENTAGE
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 aPERCENTAGE
threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars. - See Also:
-
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. ForPERCENTAGE
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 aPERCENTAGE
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 returnThresholdType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthresholdTypeAsString()
.- 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. ForPERCENTAGE
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 aPERCENTAGE
threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars. - See Also:
-
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 returnNotificationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotificationStateAsString()
.- 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
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 returnNotificationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnotificationStateAsString()
.- 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
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 interfaceToCopyableBuilder<Notification.Builder,
Notification> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-