Class NotificationConfig

GlobalConfig / ReportConfig / BudgetReportConfig / NotificationConfig

Notification configuration

Example

notifications:
 - type: ACTUAL
   thresholdType: PERCENTAGE
   threshold: 90
   comparisonOperator: GREATER_THAN
   subscriptionType: EMAIL
   recipients:
    - myemail+pa1-budg@example.com
    - myemail+pa2-budg@example.com

Hierarchy

  • NotificationConfig

Implements

Constructors

constructor

Properties

address comparisonOperator recipients subscriptionType threshold thresholdType type

Constructors

constructor

Properties

Readonly address

address: undefined | string = ''

The address that AWS sends budget notifications to, either an SNS topic or an email.

Deprecated

This is a temporary property and it has been deprecated. Please use recipients property to specify address for budget notifications.

Readonly comparisonOperator

comparisonOperator: "GREATER_THAN" | "LESS_THAN" | "EQUAL_TO" = 'GREATER_THAN'

The comparison that's used for this notification.

Readonly recipients

recipients: undefined | string[] = []

The recipients list that AWS sends budget notifications to, either an SNS topic or an email.

Readonly subscriptionType

subscriptionType: "EMAIL" | "SNS" = 'EMAIL'

The type of notification that AWS sends to a subscriber.

Readonly threshold

threshold: number = 90

The type of threshold associate with a notification.

Readonly thresholdType

thresholdType: "PERCENTAGE" | "ABSOLUTE_VALUE" = 'PERCENTAGE'

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.

Readonly type

type: "ACTUAL" | "FORECASTED" = 'ACTUAL'

The comparison that's used for the notification that's associated with a budget.

Settings

Member Visibility

Theme

Generated using TypeDoc