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

Class CfnBudgetPropsMixin.BudgetDataProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBudgetPropsMixin.BudgetDataProperty>

Enclosing interface:

CfnBudgetPropsMixin.BudgetDataProperty

@Stability(Stable)
public static final class CfnBudgetPropsMixin.BudgetDataProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBudgetPropsMixin.BudgetDataProperty>

A builder for CfnBudgetPropsMixin.BudgetDataProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnBudgetPropsMixin.BudgetDataProperty.Builder	autoAdjustData(CfnBudgetPropsMixin.AutoAdjustDataProperty autoAdjustData)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getAutoAdjustData()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	autoAdjustData(IResolvable autoAdjustData)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getAutoAdjustData()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	billingViewArn(String billingViewArn)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBillingViewArn()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	budgetLimit(CfnBudgetPropsMixin.SpendProperty budgetLimit)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBudgetLimit()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	budgetLimit(IResolvable budgetLimit)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBudgetLimit()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	budgetName(String budgetName)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBudgetName()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	budgetType(String budgetType)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBudgetType()
CfnBudgetPropsMixin.BudgetDataProperty	build()	Builds the configured instance.
CfnBudgetPropsMixin.BudgetDataProperty.Builder	costFilters(Object costFilters)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getCostFilters()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	costTypes(CfnBudgetPropsMixin.CostTypesProperty costTypes)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getCostTypes()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	costTypes(IResolvable costTypes)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getCostTypes()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	filterExpression(CfnBudgetPropsMixin.ExpressionProperty filterExpression)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getFilterExpression()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	filterExpression(IResolvable filterExpression)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getFilterExpression()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	metrics(List<String> metrics)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getMetrics()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	plannedBudgetLimits(Object plannedBudgetLimits)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getPlannedBudgetLimits()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	timePeriod(CfnBudgetPropsMixin.TimePeriodProperty timePeriod)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getTimePeriod()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	timePeriod(IResolvable timePeriod)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getTimePeriod()
CfnBudgetPropsMixin.BudgetDataProperty.Builder	timeUnit(String timeUnit)	Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getTimeUnit()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

autoAdjustData

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder autoAdjustData(IResolvable autoAdjustData)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getAutoAdjustData()

Parameters:

autoAdjustData - Determine the budget amount for an auto-adjusting budget.

Returns:

this

autoAdjustData

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder autoAdjustData(CfnBudgetPropsMixin.AutoAdjustDataProperty autoAdjustData)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getAutoAdjustData()

Parameters:

autoAdjustData - Determine the budget amount for an auto-adjusting budget.

Returns:

this

billingViewArn

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder billingViewArn(String billingViewArn)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBillingViewArn()

Parameters:

billingViewArn - the value to be set.

Returns:

this

budgetLimit

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder budgetLimit(IResolvable budgetLimit)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder budgetLimit(CfnBudgetPropsMixin.SpendProperty budgetLimit)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder budgetName(String budgetName)

Sets the value of CfnBudgetPropsMixin.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

budgetType

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder budgetType(String budgetType)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getBudgetType()

Parameters:

budgetType - Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

Returns:

this

costFilters

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder costFilters(Object costFilters)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder costTypes(IResolvable costTypes)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder costTypes(CfnBudgetPropsMixin.CostTypesProperty costTypes)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder filterExpression(IResolvable filterExpression)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getFilterExpression()

Parameters:

filterExpression - the value to be set.

Returns:

this

filterExpression

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder filterExpression(CfnBudgetPropsMixin.ExpressionProperty filterExpression)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getFilterExpression()

Parameters:

filterExpression - the value to be set.

Returns:

this

metrics

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder metrics(List<String> metrics)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getMetrics()

Parameters:

metrics - the value to be set.

Returns:

this

plannedBudgetLimits

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder plannedBudgetLimits(Object plannedBudgetLimits)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder timePeriod(IResolvable timePeriod)

Sets the value of CfnBudgetPropsMixin.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 CfnBudgetPropsMixin.BudgetDataProperty.Builder timePeriod(CfnBudgetPropsMixin.TimePeriodProperty timePeriod)

Sets the value of CfnBudgetPropsMixin.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

timeUnit

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty.Builder timeUnit(String timeUnit)

Sets the value of CfnBudgetPropsMixin.BudgetDataProperty.getTimeUnit()

Parameters:

timeUnit - The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Returns:

this

build

@Stability(Stable)
public CfnBudgetPropsMixin.BudgetDataProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnBudgetPropsMixin.BudgetDataProperty>

Returns:

a new instance of CfnBudgetPropsMixin.BudgetDataProperty

Throws:

NullPointerException - if any required attribute was not provided