interface CfnBudgetProps

Language	Type name
.NET	`Amazon.CDK.AWS.Budgets.CfnBudgetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbudgets#CfnBudgetProps`
Java	`software.amazon.awscdk.services.budgets.CfnBudgetProps`
Python	`aws_cdk.aws_budgets.CfnBudgetProps`
TypeScript	`aws-cdk-lib` » `aws_budgets` » `CfnBudgetProps`

Properties for defining a CfnBudget.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_budgets as budgets } from 'aws-cdk-lib';

declare const costFilters: any;
declare const plannedBudgetLimits: any;
const cfnBudgetProps: budgets.CfnBudgetProps = {
  budget: {
    budgetType: 'budgetType',
    timeUnit: 'timeUnit',

    // the properties below are optional
    autoAdjustData: {
      autoAdjustType: 'autoAdjustType',

      // the properties below are optional
      historicalOptions: {
        budgetAdjustmentPeriod: 123,
      },
    },
    budgetLimit: {
      amount: 123,
      unit: 'unit',
    },
    budgetName: 'budgetName',
    costFilters: costFilters,
    costTypes: {
      includeCredit: false,
      includeDiscount: false,
      includeOtherSubscription: false,
      includeRecurring: false,
      includeRefund: false,
      includeSubscription: false,
      includeSupport: false,
      includeTax: false,
      includeUpfront: false,
      useAmortized: false,
      useBlended: false,
    },
    plannedBudgetLimits: plannedBudgetLimits,
    timePeriod: {
      end: 'end',
      start: 'start',
    },
  },

  // the properties below are optional
  notificationsWithSubscribers: [{
    notification: {
      comparisonOperator: 'comparisonOperator',
      notificationType: 'notificationType',
      threshold: 123,

      // the properties below are optional
      thresholdType: 'thresholdType',
    },
    subscribers: [{
      address: 'address',
      subscriptionType: 'subscriptionType',
    }],
  }],
  resourceTags: [{
    key: 'key',

    // the properties below are optional
    value: 'value',
  }],
};

Properties

Name	Type	Description
budget	`IResolvable` `\|` `BudgetDataProperty`	The budget object that you want to create.
notificationsWithSubscribers?	`IResolvable` `\|` `IResolvable` `\|` `NotificationWithSubscribersProperty[]`	A notification that you want to associate with a budget.
resourceTags?	`IResolvable` `\|` `IResolvable` `\|` `ResourceTagProperty[]`	An optional list of tags to associate with the specified budget.

budget

Type: IResolvable | BudgetDataProperty

The budget object that you want to create.

notificationsWithSubscribers?

Type: IResolvable | IResolvable | NotificationWithSubscribersProperty[] (optional)

A notification that you want to associate with a budget.

A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

resourceTags?

Type: IResolvable | IResolvable | ResourceTagProperty[] (optional)

An optional list of tags to associate with the specified budget.

Each tag consists of a key and a value, and each key must be unique for the resource.