Package software.amazon.awscdk.services.budgets

Class CfnBudget.BudgetDataProperty.Builder

java.lang.Object
software.amazon.awscdk.services.budgets.CfnBudget.BudgetDataProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnBudget.BudgetDataProperty>
Enclosing interface:
CfnBudget.BudgetDataProperty
@Stability(Stable) public static final class CfnBudget.BudgetDataProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnBudget.BudgetDataProperty>
A builder for CfnBudget.BudgetDataProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • budgetType

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder budgetType(String budgetType)
      Sets the value of CfnBudget.BudgetDataProperty.getBudgetType()
      Parameters:
      budgetType - Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage. This parameter is required.
      Returns:
      this

    • timeUnit

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder timeUnit(String timeUnit)
      Sets the value of CfnBudget.BudgetDataProperty.getTimeUnit()
      Parameters:
      timeUnit - The length of time until a budget resets the actual and forecasted spend. This parameter is required. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.
      Returns:
      this

    • autoAdjustData

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder autoAdjustData(IResolvable autoAdjustData)
      Sets the value of CfnBudget.BudgetDataProperty.getAutoAdjustData()
      Parameters:
      autoAdjustData - Determine the budget amount for an auto-adjusting budget.
      Returns:
      this

    • autoAdjustData

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder autoAdjustData(CfnBudget.AutoAdjustDataProperty autoAdjustData)
      Sets the value of CfnBudget.BudgetDataProperty.getAutoAdjustData()
      Parameters:
      autoAdjustData - Determine the budget amount for an auto-adjusting budget.
      Returns:
      this

    • billingViewArn

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder billingViewArn(String billingViewArn)
      Sets the value of CfnBudget.BudgetDataProperty.getBillingViewArn()
      Parameters:
      billingViewArn - the value to be set.
      Returns:
      this

    • budgetLimit

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder budgetLimit(IResolvable budgetLimit)
      Sets the value of CfnBudget.BudgetDataProperty.getBudgetLimit()
      Parameters:
      budgetLimit - The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget. BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100 . This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
      Returns:
      this

    • budgetLimit

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder budgetLimit(CfnBudget.SpendProperty budgetLimit)
      Sets the value of CfnBudget.BudgetDataProperty.getBudgetLimit()
      Parameters:
      budgetLimit - The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget. BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100 . This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
      Returns:
      this

    • budgetName

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder budgetName(String budgetName)
      Sets the value of CfnBudget.BudgetDataProperty.getBudgetName()
      Parameters:
      budgetName - The name of a budget. The value must be unique within an account. BudgetName can't include : and \ characters. If you don't include value for BudgetName in the template, Billing and Cost Management assigns your budget a randomly generated name.
      Returns:
      this

    • costFilters

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder costFilters(Object costFilters)
      Sets the value of CfnBudget.BudgetDataProperty.getCostFilters()
      Parameters:
      costFilters - The cost filters, such as Region , Service , LinkedAccount , Tag , or CostCategory , that are applied to a budget. AWS Budgets supports the following services as a Service filter for RI budgets:

      • Amazon EC2
      • Amazon Redshift
      • Amazon Relational Database Service
      • Amazon ElastiCache
      • Amazon OpenSearch Service
      Returns:
      this

    • costTypes

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder costTypes(IResolvable costTypes)
      Sets the value of CfnBudget.BudgetDataProperty.getCostTypes()
      Parameters:
      costTypes - The types of costs that are included in this COST budget. USAGE , RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION , and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes .
      Returns:
      this

    • costTypes

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder costTypes(CfnBudget.CostTypesProperty costTypes)
      Sets the value of CfnBudget.BudgetDataProperty.getCostTypes()
      Parameters:
      costTypes - The types of costs that are included in this COST budget. USAGE , RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION , and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes .
      Returns:
      this

    • filterExpression

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder filterExpression(IResolvable filterExpression)
      Sets the value of CfnBudget.BudgetDataProperty.getFilterExpression()
      Parameters:
      filterExpression - the value to be set.
      Returns:
      this

    • filterExpression

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder filterExpression(CfnBudget.ExpressionProperty filterExpression)
      Sets the value of CfnBudget.BudgetDataProperty.getFilterExpression()
      Parameters:
      filterExpression - the value to be set.
      Returns:
      this

    • metrics

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder metrics(List<String> metrics)
      Sets the value of CfnBudget.BudgetDataProperty.getMetrics()
      Parameters:
      metrics - the value to be set.
      Returns:
      this

    • plannedBudgetLimits

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder plannedBudgetLimits(Object plannedBudgetLimits)
      Sets the value of CfnBudget.BudgetDataProperty.getPlannedBudgetLimits()
      Parameters:
      plannedBudgetLimits - A map containing multiple BudgetLimit , including current or future limits. PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit .

      For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

      For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

      If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

      If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

      After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit . At that point, the planned budget provides the same experience as a fixed budget.

      DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits . This only applies to budgets that are created with PlannedBudgetLimits . Budgets that are created without PlannedBudgetLimits only contain BudgetLimit . They don't contain PlannedBudgetLimits .

      Returns:
      this

    • timePeriod

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder timePeriod(IResolvable timePeriod)
      Sets the value of CfnBudget.BudgetDataProperty.getTimePeriod()
      Parameters:
      timePeriod - The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

      The start date for a budget. If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period (MONTHLY, QUARTERLY, or ANNUALLY). For example, if you create your budget on January 24, 2019, choose MONTHLY , and don't set a start date, the start date defaults to 01/01/19 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

      You can change your start date with the UpdateBudget operation.

      After the end date, AWS deletes the budget and all associated notifications and subscribers.

      Returns:
      this

    • timePeriod

      @Stability(Stable) public CfnBudget.BudgetDataProperty.Builder timePeriod(CfnBudget.TimePeriodProperty timePeriod)
      Sets the value of CfnBudget.BudgetDataProperty.getTimePeriod()
      Parameters:
      timePeriod - The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

      The start date for a budget. If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period (MONTHLY, QUARTERLY, or ANNUALLY). For example, if you create your budget on January 24, 2019, choose MONTHLY , and don't set a start date, the start date defaults to 01/01/19 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

      You can change your start date with the UpdateBudget operation.

      After the end date, AWS deletes the budget and all associated notifications and subscribers.

      Returns:
      this

    • build

      @Stability(Stable) public CfnBudget.BudgetDataProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnBudget.BudgetDataProperty>
      Returns:
      a new instance of CfnBudget.BudgetDataProperty
      Throws:
      NullPointerException - if any required attribute was not provided