Package software.amazon.awssdk.services.budgets.model

Interface Budget.Builder

    • Method Detail

      • budgetName

        Budget.Builder budgetName​(String budgetName)

        The name of a budget. The name must be unique within an account. The : and \ characters, and the "/action/" substring, aren't allowed in BudgetName.

        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 in BudgetName.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • budgetLimit

        Budget.Builder 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.

        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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • budgetLimit

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

        This is a convenience method that creates an instance of the Spend.Builder avoiding the need to create one manually via Spend.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to budgetLimit(Spend).

        Parameters:
        budgetLimit - a consumer that will call methods on Spend.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        budgetLimit(Spend)

      • plannedBudgetLimits

        Budget.Builder plannedBudgetLimits​(Map<String,​Spend> 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • costFilters

        Budget.Builder costFilters​(Map<String,​? extends Collection<String>> costFilters)

        The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, 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 as Region, Service, LinkedAccount, Tag, or CostCategory, 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

        Budget.Builder costTypes​(CostTypes 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • timeUnit

        Budget.Builder timeUnit​(String 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, TimeUnit

      • timeUnit

        Budget.Builder timeUnit​(TimeUnit 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, TimeUnit

      • timePeriod

        Budget.Builder timePeriod​(TimePeriod 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 to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/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 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 to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/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

        default Budget.Builder timePeriod​(Consumer<TimePeriod.Builder> 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 to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/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 the TimePeriod.Builder avoiding the need to create one manually via TimePeriod.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(TimePeriod).

        Parameters:
        timePeriod - a consumer that will call methods on TimePeriod.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        timePeriod(TimePeriod)

      • calculatedSpend

        Budget.Builder calculatedSpend​(CalculatedSpend 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.

      • budgetType

        Budget.Builder budgetType​(String 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, BudgetType

      • budgetType

        Budget.Builder budgetType​(BudgetType 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, BudgetType

      • lastUpdatedTime

        Budget.Builder lastUpdatedTime​(Instant 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

        Budget.Builder autoAdjustData​(AutoAdjustData 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.