1.204.0

interface NotificationProperty

LanguageType name
.NETAmazon.CDK.AWS.Budgets.CfnBudget.NotificationProperty
Javasoftware.amazon.awscdk.services.budgets.CfnBudget.NotificationProperty
Pythonaws_cdk.aws_budgets.CfnBudget.NotificationProperty
TypeScript @aws-cdk/aws-budgets » CfnBudget » NotificationProperty

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 * as budgets from '@aws-cdk/aws-budgets';
const notificationProperty: budgets.CfnBudget.NotificationProperty = {
  comparisonOperator: 'comparisonOperator',
  notificationType: 'notificationType',
  threshold: 123,

  // the properties below are optional
  thresholdType: 'thresholdType',
};

Properties

NameTypeDescription
comparisonOperatorstringThe comparison that's used for this notification.
notificationTypestringSpecifies whether the notification is for how much you have spent ( ACTUAL ) or for how much that you're forecasted to spend ( FORECASTED ).
thresholdnumberThe threshold that's associated with a notification.
thresholdType?stringThe type of threshold for a notification.

comparisonOperator

Type: string

The comparison that's used for this notification.

notificationType

Type: string

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

threshold

Type: number

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?

Type: string (optional)

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.

← PreviousNext →