Package software.amazon.awscdk.services.budgets

Interface CfnBudgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBudgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:55.688Z")
@Stability(Stable)
public interface CfnBudgetProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.budgets.*;
 Object costFilters;
 Object plannedBudgetLimits;
 CfnBudgetProps cfnBudgetProps = CfnBudgetProps.builder()
         .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())
                 .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())
                 .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBudgetProps.Builder	A builder for CfnBudgetProps
static final class	CfnBudgetProps.Jsii$Proxy	An implementation for CfnBudgetProps

Method Summary

Modifier and Type	Method	Description
static CfnBudgetProps.Builder	builder()
Object	getBudget()	The budget object that you want to create.
default Object	getNotificationsWithSubscribers()	A notification that you want to associate with a budget.
default Object	getResourceTags()	An optional list of tags to associate with the specified budget.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBudget

@Stability(Stable)
@NotNull
Object getBudget()

The budget object that you want to create.

See Also:

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

getNotificationsWithSubscribers

@Stability(Stable)
@Nullable
default Object getNotificationsWithSubscribers()

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.

See Also:

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

getResourceTags

@Stability(Stable)
@Nullable
default Object getResourceTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnBudgetProps.Builder builder()

Returns:

a CfnBudgetProps.Builder of CfnBudgetProps