Package software.amazon.awscdk.services.budgets

Class CfnBudget

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.budgets.CfnBudget
All Implemented Interfaces:
IInspectable, IBudgetRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:07.974Z") @Stability(Stable) public class CfnBudget extends CfnResource implements IInspectable, IBudgetRef
The AWS::Budgets::Budget resource allows customers to take pre-defined actions that will trigger once a budget threshold has been exceeded.

creates, replaces, or deletes budgets for Billing and Cost Management. For more information, see Managing Your Costs with Budgets in the Billing and Cost Management User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.budgets.*;
 Object costFilters;
 ExpressionProperty expressionProperty_;
 Object plannedBudgetLimits;
 CfnBudget cfnBudget = CfnBudget.Builder.create(this, "MyCfnBudget")
         .budget(BudgetDataProperty.builder()
                 .budgetType("budgetType")
                 .timeUnit("timeUnit")
                 // the properties below are optional
                 .autoAdjustData(AutoAdjustDataProperty.builder()
                         .autoAdjustType("autoAdjustType")
                         // the properties below are optional
                         .historicalOptions(HistoricalOptionsProperty.builder()
                                 .budgetAdjustmentPeriod(123)
                                 .build())
                         .build())
                 .billingViewArn("billingViewArn")
                 .budgetLimit(SpendProperty.builder()
                         .amount(123)
                         .unit("unit")
                         .build())
                 .budgetName("budgetName")
                 .costFilters(costFilters)
                 .costTypes(CostTypesProperty.builder()
                         .includeCredit(false)
                         .includeDiscount(false)
                         .includeOtherSubscription(false)
                         .includeRecurring(false)
                         .includeRefund(false)
                         .includeSubscription(false)
                         .includeSupport(false)
                         .includeTax(false)
                         .includeUpfront(false)
                         .useAmortized(false)
                         .useBlended(false)
                         .build())
                 .filterExpression(ExpressionProperty.builder()
                         .and(List.of(expressionProperty_))
                         .costCategories(CostCategoryValuesProperty.builder()
                                 .key("key")
                                 .matchOptions(List.of("matchOptions"))
                                 .values(List.of("values"))
                                 .build())
                         .dimensions(ExpressionDimensionValuesProperty.builder()
                                 .key("key")
                                 .matchOptions(List.of("matchOptions"))
                                 .values(List.of("values"))
                                 .build())
                         .not(expressionProperty_)
                         .or(List.of(expressionProperty_))
                         .tags(TagValuesProperty.builder()
                                 .key("key")
                                 .matchOptions(List.of("matchOptions"))
                                 .values(List.of("values"))
                                 .build())
                         .build())
                 .metrics(List.of("metrics"))
                 .plannedBudgetLimits(plannedBudgetLimits)
                 .timePeriod(TimePeriodProperty.builder()
                         .end("end")
                         .start("start")
                         .build())
                 .build())
         // the properties below are optional
         .notificationsWithSubscribers(List.of(NotificationWithSubscribersProperty.builder()
                 .notification(NotificationProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .notificationType("notificationType")
                         .threshold(123)
                         // the properties below are optional
                         .thresholdType("thresholdType")
                         .build())
                 .subscribers(List.of(SubscriberProperty.builder()
                         .address("address")
                         .subscriptionType("subscriptionType")
                         .build()))
                 .build()))
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 // the properties below are optional
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBudget

      protected CfnBudget(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBudget

      protected CfnBudget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBudget

      @Stability(Stable) public CfnBudget(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBudgetProps props)
      Create a new AWS::Budgets::Budget.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnBudget

      @Stability(Stable) @NotNull public static Boolean isCfnBudget(@NotNull Object x)
      Checks whether the given object is a CfnBudget.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getBudgetRef

      @Stability(Stable) @NotNull public BudgetReference getBudgetRef()
      A reference to a Budget resource.
      Specified by:
      getBudgetRef in interface IBudgetRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getBudget

      @Stability(Stable) @NotNull public Object getBudget()
      The budget object that you want to create.

      Returns union: either IResolvable or CfnBudget.BudgetDataProperty

    • setBudget

      @Stability(Stable) public void setBudget(@NotNull IResolvable value)
      The budget object that you want to create.

    • setBudget

      @Stability(Stable) public void setBudget(@NotNull CfnBudget.BudgetDataProperty value)
      The budget object that you want to create.

    • getNotificationsWithSubscribers

      @Stability(Stable) @Nullable public Object getNotificationsWithSubscribers()
      A notification that you want to associate with a budget.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBudget.NotificationWithSubscribersProperty>

    • setNotificationsWithSubscribers

      @Stability(Stable) public void setNotificationsWithSubscribers(@Nullable IResolvable value)
      A notification that you want to associate with a budget.

    • setNotificationsWithSubscribers

      @Stability(Stable) public void setNotificationsWithSubscribers(@Nullable List<Object> value)
      A notification that you want to associate with a budget.

    • getResourceTags

      @Stability(Stable) @Nullable public Object getResourceTags()
      An optional list of tags to associate with the specified budget.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBudget.ResourceTagProperty>

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable IResolvable value)
      An optional list of tags to associate with the specified budget.

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable List<Object> value)
      An optional list of tags to associate with the specified budget.