Skip to content
v2.275.0

CfnBudgetProps Struct ​

Properties for defining a CfnBudget.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';
const cfnBudgetProps: deadline.CfnBudgetProps = {
  actions: [{
    thresholdPercentage: 123,
    type: 'type',

    // the properties below are optional
    description: 'description',
  }],
  approximateDollarLimit: 123,
  displayName: 'displayName',
  farmId: 'farmId',
  schedule: {
    fixed: {
      endTime: 'endTime',
      startTime: 'startTime',
    },
  },
  usageTrackingResource: {
    queueId: 'queueId',
  },

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

actionsIResolvable | IResolvable | CfnBudget.BudgetActionToAddProperty[]actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BudgetActionToAddProperty]]]actionsIResolvableActionsIResolvableActionsinterface{}required#
The budget actions to specify what happens when the budget runs out.
approximateDollarLimitnumberapproximate_dollar_limitint | floatapproximateDollarLimitNumberApproximateDollarLimitdoubleApproximateDollarLimit*float64required#
The dollar limit based on consumed usage.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the budget.
displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*stringrequired#
The display name of the budget.
farmIdstringfarm_idstrfarmIdStringFarmIdstringFarmId*stringrequired#
The farm ID.
scheduleIResolvable | CfnBudget.BudgetSchedulePropertyscheduletyping.Union[IResolvable, BudgetScheduleProperty]scheduleIResolvableScheduleIResolvableScheduleinterface{}required#
The start and end time of the budget.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
usageTrackingResourceIResolvable | CfnBudget.UsageTrackingResourcePropertyusage_tracking_resourcetyping.Union[IResolvable, UsageTrackingResourceProperty]usageTrackingResourceIResolvableUsageTrackingResourceIResolvableUsageTrackingResourceinterface{}required#
The usage details of the allotted budget.