Package software.amazon.awscdk.services.deadline

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.deadline.CfnBudget
All Implemented Interfaces:
IInspectable, IBudgetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:07.459Z") @Stability(Stable) public class CfnBudget extends CfnResource implements IInspectable, IBudgetRef, ITaggableV2
Creates a budget to set spending thresholds for your rendering activity.

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.*;
 CfnBudget cfnBudget = CfnBudget.Builder.create(this, "MyCfnBudget")
         .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:

  • 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::Deadline::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

    • arnForBudget

      @Stability(Stable) @NotNull public static String arnForBudget(@NotNull IBudgetRef resource)
      Parameters:
      resource - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the budget.

    • getAttrBudgetId

      @Stability(Stable) @NotNull public String getAttrBudgetId()
      The budget ID.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the budget.

    • getBudgetRef

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getActions

      @Stability(Stable) @NotNull public 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>

    • setActions

      @Stability(Stable) public void setActions(@NotNull IResolvable value)
      The budget actions to specify what happens when the budget runs out.

    • setActions

      @Stability(Stable) public void setActions(@NotNull List<Object> value)
      The budget actions to specify what happens when the budget runs out.

    • getApproximateDollarLimit

      @Stability(Stable) @NotNull public Number getApproximateDollarLimit()
      The dollar limit based on consumed usage.

    • setApproximateDollarLimit

      @Stability(Stable) public void setApproximateDollarLimit(@NotNull Number value)
      The dollar limit based on consumed usage.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The display name of the budget.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The display name of the budget.

    • getFarmId

      @Stability(Stable) @NotNull public String getFarmId()
      The farm ID.

    • setFarmId

      @Stability(Stable) public void setFarmId(@NotNull String value)
      The farm ID.

    • getSchedule

      @Stability(Stable) @NotNull public Object getSchedule()
      The start and end time of the budget.

      Returns union: either IResolvable or CfnBudget.BudgetScheduleProperty

    • setSchedule

      @Stability(Stable) public void setSchedule(@NotNull IResolvable value)
      The start and end time of the budget.

    • setSchedule

      @Stability(Stable) public void setSchedule(@NotNull CfnBudget.BudgetScheduleProperty value)
      The start and end time of the budget.

    • getUsageTrackingResource

      @Stability(Stable) @NotNull public Object getUsageTrackingResource()
      The usage details of the allotted budget.

      Returns union: either IResolvable or CfnBudget.UsageTrackingResourceProperty

    • setUsageTrackingResource

      @Stability(Stable) public void setUsageTrackingResource(@NotNull IResolvable value)
      The usage details of the allotted budget.

    • setUsageTrackingResource

      @Stability(Stable) public void setUsageTrackingResource(@NotNull CfnBudget.UsageTrackingResourceProperty value)
      The usage details of the allotted budget.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the budget.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the budget.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.