Package software.amazon.awscdk.services.budgets

Interface CfnBudget.NotificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBudget.NotificationProperty.Jsii$Proxy

Enclosing class:

CfnBudget

@Stability(Stable)
public static interface CfnBudget.NotificationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.budgets.*;
 NotificationProperty notificationProperty = NotificationProperty.builder()
         .comparisonOperator("comparisonOperator")
         .notificationType("notificationType")
         .threshold(123)
         // the properties below are optional
         .thresholdType("thresholdType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBudget.NotificationProperty.Builder	A builder for CfnBudget.NotificationProperty
static final class	CfnBudget.NotificationProperty.Jsii$Proxy	An implementation for CfnBudget.NotificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBudget.NotificationProperty.Builder	builder()
String	getComparisonOperator()	The comparison that's used for this notification.
String	getNotificationType()	Specifies whether the notification is for how much you have spent ( ACTUAL ) or for how much that you're forecasted to spend ( FORECASTED ).
Number	getThreshold()	The threshold that's associated with a notification.
default String	getThresholdType()	The type of threshold for a notification.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComparisonOperator

@Stability(Stable)
@NotNull
String getComparisonOperator()

The comparison that's used for this notification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-comparisonoperator

getNotificationType

@Stability(Stable)
@NotNull
String getNotificationType()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype

getThreshold

@Stability(Stable)
@NotNull
Number getThreshold()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold

getThresholdType

@Stability(Stable)
@Nullable
default String getThresholdType()

The type of threshold for a notification.

For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS 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%, AWS notifies you when you go over 160 dollars.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-thresholdtype

builder

@Stability(Stable)
static CfnBudget.NotificationProperty.Builder builder()

Returns:

a CfnBudget.NotificationProperty.Builder of CfnBudget.NotificationProperty