Interface IBudgetReportConfig

GlobalConfig / ReportConfig / BudgetReportConfig

Description

BudgetReport configuration

Example

budgets:
    - name: accel-budget
      timeUnit: MONTHLY
      type: COST
      amount: 2000
      includeUpfront: true
      includeTax: true
      includeSupport: true
      includeSubscription: true
      includeRecurring: true
      includeOtherSubscription: true
      includeDiscount: true
      includeCredit: false
      includeRefund: false
      useBlended: false
      useAmortized: false
      unit: USD
      notifications:
      - type: ACTUAL
        thresholdType: PERCENTAGE
        threshold: 90
        comparisonOperator: GREATER_THAN
        subscriptionType: EMAIL
        recipients:
         - myemail+pa1-budg@example.com
         - myemail+pa2-budg@example.com
interface IBudgetReportConfig {
    amount: number;
    deploymentTargets?: IDeploymentTargets;
    includeCredit?: boolean;
    includeDiscount?: boolean;
    includeOtherSubscription?: boolean;
    includeRecurring?: boolean;
    includeRefund?: boolean;
    includeSubscription?: boolean;
    includeSupport?: boolean;
    includeTax?: boolean;
    includeUpfront?: boolean;
    name: string;
    notifications?: INotificationConfig[];
    subscriptionType?: string;
    timeUnit: string;
    type: string;
    unit?: string;
    useAmortized?: boolean;
    useBlended?: boolean;
}

Properties

amount deploymentTargets? includeCredit? includeDiscount? includeOtherSubscription? includeRecurring? includeRefund? includeSubscription? includeSupport? includeTax? includeUpfront? name notifications? subscriptionType? timeUnit type unit? useAmortized? useBlended?

Properties

Readonlyamount

amount: number

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

Default

2000

Optional ReadonlydeploymentTargets

deploymentTargets?: IDeploymentTargets

List of OU's and accounts to be configured for Budgets configuration

Optional ReadonlyincludeCredit

includeCredit?: boolean

Specifies whether a budget includes credits.

Default

true

Optional ReadonlyincludeDiscount

includeDiscount?: boolean

Specifies whether a budget includes discounts.

Default

true

Optional ReadonlyincludeOtherSubscription

includeOtherSubscription?: boolean

Specifies whether a budget includes non-RI subscription costs.

Default

true

Optional ReadonlyincludeRecurring

includeRecurring?: boolean

Specifies whether a budget includes recurring fees such as monthly RI fees.

Default

true

Optional ReadonlyincludeRefund

includeRefund?: boolean

Specifies whether a budget includes refunds.

Default

true

Optional ReadonlyincludeSubscription

includeSubscription?: boolean

Specifies whether a budget includes subscriptions.

Default

true

Optional ReadonlyincludeSupport

includeSupport?: boolean

Specifies whether a budget includes support subscription fees.

Default

true

Optional ReadonlyincludeTax

includeTax?: boolean

Specifies whether a budget includes taxes.

Default

true

Optional ReadonlyincludeUpfront

includeUpfront?: boolean

Specifies whether a budget includes upfront RI costs.

Default

true

Readonlyname

name: string

The name of a budget. The value must be unique within an account. BudgetName can't include : and \ characters. If you don't include value for BudgetName in the template, Billing and Cost Management assigns your budget a randomly generated name.

Optional Readonlynotifications

notifications?: INotificationConfig[]

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

Optional ReadonlysubscriptionType

subscriptionType?: string

The type of notification that AWS sends to a subscriber.

An enum value that specifies the target subscription type either EMAIL or SNS

ReadonlytimeUnit

timeUnit: string

The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Readonlytype

type: string

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

Optional Readonlyunit

unit?: string

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.

Optional ReadonlyuseAmortized

useAmortized?: boolean

Specifies whether a budget uses the amortized rate.

Default

false

Optional ReadonlyuseBlended

useBlended?: boolean

Specifies whether a budget uses a blended rate.

Default

false

Settings

Member Visibility

On This Page

Properties