Interface Budget.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Budget.Builder,
,Budget> SdkBuilder<Budget.Builder,
,Budget> SdkPojo
- Enclosing class:
Budget
-
Method Summary
Modifier and TypeMethodDescriptiondefault Budget.Builder
autoAdjustData
(Consumer<AutoAdjustData.Builder> autoAdjustData) The parameters that determine the budget amount for an auto-adjusting budget.autoAdjustData
(AutoAdjustData autoAdjustData) The parameters that determine the budget amount for an auto-adjusting budget.default Budget.Builder
budgetLimit
(Consumer<Spend.Builder> 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
(Spend 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.budgetName
(String budgetName) The name of a budget.budgetType
(String budgetType) Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.budgetType
(BudgetType budgetType) Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.default Budget.Builder
calculatedSpend
(Consumer<CalculatedSpend.Builder> calculatedSpend) The actual and forecasted cost or usage that the budget tracks.calculatedSpend
(CalculatedSpend calculatedSpend) The actual and forecasted cost or usage that the budget tracks.costFilters
(Map<String, ? extends Collection<String>> costFilters) The cost filters, such asRegion
,Service
,member account
,Tag
, orCost Category
, that are applied to a budget.default Budget.Builder
costTypes
(Consumer<CostTypes.Builder> costTypes) The types of costs that are included in thisCOST
budget.The types of costs that are included in thisCOST
budget.lastUpdatedTime
(Instant lastUpdatedTime) The last time that you updated this budget.plannedBudgetLimits
(Map<String, Spend> plannedBudgetLimits) A map containing multipleBudgetLimit
, including current or future limits.default Budget.Builder
timePeriod
(Consumer<TimePeriod.Builder> timePeriod) The period of time that's covered by a budget.timePeriod
(TimePeriod timePeriod) The period of time that's covered by a budget.The length of time until a budget resets the actual and forecasted spend.The length of time until a budget resets the actual and forecasted spend.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
budgetName
The name of a budget. The name must be unique within an account. The
:
and\
characters, and the "/action/" substring, aren't allowed inBudgetName
.- Parameters:
budgetName
- The name of a budget. The name must be unique within an account. The:
and\
characters, and the "/action/" substring, aren't allowed inBudgetName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 to100
. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't useBudgetLimit
withPlannedBudgetLimits
forCreateBudget
andUpdateBudget
actions.- 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 to100
. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't useBudgetLimit
withPlannedBudgetLimits
forCreateBudget
andUpdateBudget
actions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 to100
. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't useBudgetLimit
withPlannedBudgetLimits
forCreateBudget
andUpdateBudget
actions.Spend.Builder
avoiding the need to create one manually viaSpend.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobudgetLimit(Spend)
.- Parameters:
budgetLimit
- a consumer that will call methods onSpend.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
plannedBudgetLimits
A map containing multiple
BudgetLimit
, including current or future limits.PlannedBudgetLimits
is available for cost or usage budget and supports both monthly and quarterlyTimeUnit
.For monthly budgets, provide 12 months of
PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. Thekey
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. Thekey
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 inPlannedBudgetLimits
are used, the budget continues to use the last limit as theBudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.DescribeBudget
andDescribeBudgets
response along withPlannedBudgetLimits
also containBudgetLimit
representing the current month or quarter limit present inPlannedBudgetLimits
. This only applies to budgets that are created withPlannedBudgetLimits
. Budgets that are created withoutPlannedBudgetLimits
only containBudgetLimit
. They don't containPlannedBudgetLimits
.- Parameters:
plannedBudgetLimits
- A map containing multipleBudgetLimit
, including current or future limits.PlannedBudgetLimits
is available for cost or usage budget and supports both monthly and quarterlyTimeUnit
.For monthly budgets, provide 12 months of
PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. Thekey
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. Thekey
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 inPlannedBudgetLimits
are used, the budget continues to use the last limit as theBudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.DescribeBudget
andDescribeBudgets
response along withPlannedBudgetLimits
also containBudgetLimit
representing the current month or quarter limit present inPlannedBudgetLimits
. This only applies to budgets that are created withPlannedBudgetLimits
. Budgets that are created withoutPlannedBudgetLimits
only containBudgetLimit
. They don't containPlannedBudgetLimits
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
costFilters
The cost filters, such as
Region
,Service
,member account
,Tag
, orCost Category
, that are applied to a budget.Amazon Web Services 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
- Parameters:
costFilters
- The cost filters, such asRegion
,Service
,member account
,Tag
, orCost Category
, that are applied to a budget.Amazon Web Services 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
costTypes
The types of costs that are included in this
COST
budget.USAGE
,RI_UTILIZATION
,RI_COVERAGE
,SAVINGS_PLANS_UTILIZATION
, andSAVINGS_PLANS_COVERAGE
budgets do not haveCostTypes
.- Parameters:
costTypes
- The types of costs that are included in thisCOST
budget.USAGE
,RI_UTILIZATION
,RI_COVERAGE
,SAVINGS_PLANS_UTILIZATION
, andSAVINGS_PLANS_COVERAGE
budgets do not haveCostTypes
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
costTypes
The types of costs that are included in this
COST
budget.USAGE
,RI_UTILIZATION
,RI_COVERAGE
,SAVINGS_PLANS_UTILIZATION
, andSAVINGS_PLANS_COVERAGE
budgets do not haveCostTypes
.CostTypes.Builder
avoiding the need to create one manually viaCostTypes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocostTypes(CostTypes)
.- Parameters:
costTypes
- a consumer that will call methods onCostTypes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timeUnit
The length of time until a budget resets the actual and forecasted spend.
- Parameters:
timeUnit
- The length of time until a budget resets the actual and forecasted spend.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timeUnit
The length of time until a budget resets the actual and forecasted spend.
- Parameters:
timeUnit
- The length of time until a budget resets the actual and forecasted spend.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timePeriod
The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before
06/15/87 00:00 UTC
.If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose
DAILY
, and didn't set a start date, Amazon Web Services set your start date to01/24/18 00:00 UTC
. If you choseMONTHLY
, Amazon Web Services set your start date to01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.You can change either date with the
UpdateBudget
operation.After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
- Parameters:
timePeriod
- The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before06/15/87 00:00 UTC
.If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose
DAILY
, and didn't set a start date, Amazon Web Services set your start date to01/24/18 00:00 UTC
. If you choseMONTHLY
, Amazon Web Services set your start date to01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.You can change either date with the
UpdateBudget
operation.After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before
06/15/87 00:00 UTC
.If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose
DAILY
, and didn't set a start date, Amazon Web Services set your start date to01/24/18 00:00 UTC
. If you choseMONTHLY
, Amazon Web Services set your start date to01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.You can change either date with the
UpdateBudget
operation.After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
This is a convenience method that creates an instance of theTimePeriod.Builder
avoiding the need to create one manually viaTimePeriod.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimePeriod(TimePeriod)
.- Parameters:
timePeriod
- a consumer that will call methods onTimePeriod.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
calculatedSpend
The actual and forecasted cost or usage that the budget tracks.
- Parameters:
calculatedSpend
- The actual and forecasted cost or usage that the budget tracks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
calculatedSpend
The actual and forecasted cost or usage that the budget tracks.
This is a convenience method that creates an instance of theCalculatedSpend.Builder
avoiding the need to create one manually viaCalculatedSpend.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocalculatedSpend(CalculatedSpend)
.- Parameters:
calculatedSpend
- a consumer that will call methods onCalculatedSpend.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
budgetType
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
- Parameters:
budgetType
- Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
budgetType
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
- Parameters:
budgetType
- Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastUpdatedTime
The last time that you updated this budget.
- Parameters:
lastUpdatedTime
- The last time that you updated this budget.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoAdjustData
The parameters that determine the budget amount for an auto-adjusting budget.
- Parameters:
autoAdjustData
- The parameters that determine the budget amount for an auto-adjusting budget.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoAdjustData
The parameters that determine the budget amount for an auto-adjusting budget.
This is a convenience method that creates an instance of theAutoAdjustData.Builder
avoiding the need to create one manually viaAutoAdjustData.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoAdjustData(AutoAdjustData)
.- Parameters:
autoAdjustData
- a consumer that will call methods onAutoAdjustData.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-