Package software.amazon.awscdk.services.deadline

Interface CfnBudgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBudgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:07.461Z")
@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.deadline.*;
 CfnBudgetProps cfnBudgetProps = CfnBudgetProps.builder()
         .actions(List.of(BudgetActionToAddProperty.builder()
                 .thresholdPercentage(123)
                 .type("type")
                 // the properties below are optional
                 .description("description")
                 .build()))
         .approximateDollarLimit(123)
         .displayName("displayName")
         .farmId("farmId")
         .schedule(BudgetScheduleProperty.builder()
                 .fixed(FixedBudgetScheduleProperty.builder()
                         .endTime("endTime")
                         .startTime("startTime")
                         .build())
                 .build())
         .usageTrackingResource(UsageTrackingResourceProperty.builder()
                 .queueId("queueId")
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-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	getActions()	The budget actions to specify what happens when the budget runs out.
Number	getApproximateDollarLimit()	The dollar limit based on consumed usage.
default String	getDescription()	The description of the budget.
String	getDisplayName()	The display name of the budget.
String	getFarmId()	The farm ID.
Object	getSchedule()	The start and end time of the budget.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
Object	getUsageTrackingResource()	The usage details of the allotted budget.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The budget actions to specify what happens when the budget runs out.

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

See Also:

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

getApproximateDollarLimit

@Stability(Stable)
@NotNull
Number getApproximateDollarLimit()

The dollar limit based on consumed usage.

See Also:

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

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The display name of the budget.

See Also:

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

getFarmId

@Stability(Stable)
@NotNull
String getFarmId()

The farm ID.

See Also:

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

getSchedule

@Stability(Stable)
@NotNull
Object getSchedule()

The start and end time of the budget.

Returns union: either IResolvable or CfnBudget.BudgetScheduleProperty

See Also:

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

getUsageTrackingResource

@Stability(Stable)
@NotNull
Object getUsageTrackingResource()

The usage details of the allotted budget.

Returns union: either IResolvable or CfnBudget.UsageTrackingResourceProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the budget.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

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

builder

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

Returns:

a CfnBudgetProps.Builder of CfnBudgetProps