Package software.amazon.awscdk.cfnpropertymixins.services.budgets

Class CfnBudgetPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.budgets.CfnBudgetPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.770Z")
@Stability(Stable)
public class CfnBudgetPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.budgets.*;
 import software.amazon.awscdk.*;
 Object costFilters;
 ExpressionProperty expressionProperty_;
 IMergeStrategy mergeStrategy;
 Object plannedBudgetLimits;
 CfnBudgetPropsMixin cfnBudgetPropsMixin = CfnBudgetPropsMixin.Builder.create(CfnBudgetMixinProps.builder()
         .budget(BudgetDataProperty.builder()
                 .autoAdjustData(AutoAdjustDataProperty.builder()
                         .autoAdjustType("autoAdjustType")
                         .historicalOptions(HistoricalOptionsProperty.builder()
                                 .budgetAdjustmentPeriod(123)
                                 .build())
                         .build())
                 .billingViewArn("billingViewArn")
                 .budgetLimit(SpendProperty.builder()
                         .amount(123)
                         .unit("unit")
                         .build())
                 .budgetName("budgetName")
                 .budgetType("budgetType")
                 .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())
                 .timeUnit("timeUnit")
                 .build())
         .notificationsWithSubscribers(List.of(NotificationWithSubscribersProperty.builder()
                 .notification(NotificationProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .notificationType("notificationType")
                         .threshold(123)
                         .thresholdType("thresholdType")
                         .build())
                 .subscribers(List.of(SubscriberProperty.builder()
                         .address("address")
                         .subscriptionType("subscriptionType")
                         .build()))
                 .build()))
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBudgetPropsMixin.AutoAdjustDataProperty	Determine the budget amount for an auto-adjusting budget.
static interface	CfnBudgetPropsMixin.BudgetDataProperty	Represents the output of the CreateBudget operation.
static final class	CfnBudgetPropsMixin.Builder	A fluent builder for CfnBudgetPropsMixin.
static interface	CfnBudgetPropsMixin.CostCategoryValuesProperty	The cost category values used for filtering the costs.
static interface	CfnBudgetPropsMixin.CostTypesProperty	The types of cost that are included in a COST budget, such as tax and subscriptions.
static interface	CfnBudgetPropsMixin.ExpressionDimensionValuesProperty	Contains the specifications for the filters to use for your request.
static interface	CfnBudgetPropsMixin.ExpressionProperty	Use Expression to filter in various Budgets APIs.
static interface	CfnBudgetPropsMixin.HistoricalOptionsProperty	The parameters that define or describe the historical data that your auto-adjusting budget is based on.
static interface	CfnBudgetPropsMixin.NotificationProperty	A notification that's associated with a budget.
static interface	CfnBudgetPropsMixin.NotificationWithSubscribersProperty	A notification with subscribers.
static interface	CfnBudgetPropsMixin.ResourceTagProperty	The tag structure that contains a tag key and value.
static interface	CfnBudgetPropsMixin.SpendProperty	The amount of cost or usage that's measured for a budget.
static interface	CfnBudgetPropsMixin.SubscriberProperty	The Subscriber property type specifies who to notify for a Billing and Cost Management budget notification.
static interface	CfnBudgetPropsMixin.TagValuesProperty	The values that are available for a tag.
static interface	CfnBudgetPropsMixin.TimePeriodProperty	The period of time that is covered by a budget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBudgetPropsMixin(CfnBudgetMixinProps props)	Create a mixin to apply properties to AWS::Budgets::Budget.
	CfnBudgetPropsMixin(CfnBudgetMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Budgets::Budget.
protected	CfnBudgetPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBudgetPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnBudgetMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnBudgetPropsMixin

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

CfnBudgetPropsMixin

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

CfnBudgetPropsMixin

@Stability(Stable)
public CfnBudgetPropsMixin(@NotNull
 CfnBudgetMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Budgets::Budget.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnBudgetPropsMixin

@Stability(Stable)
public CfnBudgetPropsMixin(@NotNull
 CfnBudgetMixinProps props)

Create a mixin to apply properties to AWS::Budgets::Budget.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnBudgetMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()