software.amazon.awssdk.services.budgets.model

Class Budget

java.lang.Object

software.amazon.awssdk.services.budgets.model.Budget

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Budget.Builder,Budget>

@Generated(value="software.amazon.awssdk:codegen")
public final class Budget
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Budget.Builder,Budget>

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the ARN pattern for a budget:

arn:aws:budgets::AccountId:budget/budgetName

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Budget.Builder

Method Summary

Modifier and Type	Method and Description
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.
String	budgetName() The name of a budget.
BudgetType	budgetType() Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
String	budgetTypeAsString() Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
static Budget.Builder	builder()
CalculatedSpend	calculatedSpend() The actual and forecasted cost or usage that the budget tracks.
Map<String,List<String>>	costFilters() The cost filters, such as service or tag, that are applied to a budget.
CostTypes	costTypes() The types of costs that are included in this COST budget.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCostFilters() Returns true if the CostFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPlannedBudgetLimits() Returns true if the PlannedBudgetLimits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastUpdatedTime() The last time that you updated this budget.
Map<String,Spend>	plannedBudgetLimits() A map containing multiple BudgetLimit, including current or future limits.
List<SdkField<?>>	sdkFields()
static Class<? extends Budget.Builder>	serializableBuilderClass()
TimePeriod	timePeriod() The period of time that is covered by a budget.
TimeUnit	timeUnit() The length of time until a budget resets the actual and forecasted spend.
String	timeUnitAsString() The length of time until a budget resets the actual and forecasted spend.
Budget.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

budgetName

public final String budgetName()

The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.

Returns:

The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.

budgetLimit

public final 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, which 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:

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

hasPlannedBudgetLimits

public final boolean hasPlannedBudgetLimits()

Returns true if the PlannedBudgetLimits property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

plannedBudgetLimits

public final Map<String,Spend> plannedBudgetLimits()

A map containing multiple BudgetLimit, including current or future limits.

PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPlannedBudgetLimits() to see if a value was sent in this field.

Returns:

A map containing multiple BudgetLimit, including current or future limits.

PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or 4 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 will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.

hasCostFilters

public final boolean hasCostFilters()

Returns true if the CostFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

costFilters

public final Map<String,List<String>> costFilters()

The cost filters, such as service or tag, that are applied to a budget.

AWS Budgets supports the following services as a filter for RI budgets:

• Amazon Elastic Compute Cloud - Compute

• Amazon Redshift

• Amazon Relational Database Service

• Amazon ElastiCache

• Amazon Elasticsearch Service

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCostFilters() to see if a value was sent in this field.

Returns:

The cost filters, such as service or tag, that are applied to a budget.

AWS Budgets supports the following services as a filter for RI budgets:

• Amazon Elastic Compute Cloud - Compute

• Amazon Redshift

• Amazon Relational Database Service

• Amazon ElastiCache

• Amazon Elasticsearch Service

costTypes

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

Returns:

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.

timeUnit

public final TimeUnit timeUnit()

The length of time until a budget resets the actual and forecasted spend.

If the service returns an enum value that is not available in the current SDK version, timeUnit will return TimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeUnitAsString().

Returns:

The length of time until a budget resets the actual and forecasted spend.

See Also:

TimeUnit

timeUnitAsString

public final String timeUnitAsString()

The length of time until a budget resets the actual and forecasted spend.

If the service returns an enum value that is not available in the current SDK version, timeUnit will return TimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeUnitAsString().

Returns:

The length of time until a budget resets the actual and forecasted spend.

See Also:

TimeUnit

timePeriod

public final TimePeriod 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. The end date must come before 06/15/87 00:00 UTC.

If you create your budget and don't specify a start date, AWS 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, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change either date with the UpdateBudget operation.

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

Returns:

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. The end date must come before 06/15/87 00:00 UTC.

If you create your budget and don't specify a start date, AWS 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, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change either date with the UpdateBudget operation.

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

calculatedSpend

public final CalculatedSpend calculatedSpend()

The actual and forecasted cost or usage that the budget tracks.

Returns:

The actual and forecasted cost or usage that the budget tracks.

budgetType

public final BudgetType budgetType()

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

If the service returns an enum value that is not available in the current SDK version, budgetType will return BudgetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from budgetTypeAsString().

Returns:

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

See Also:

BudgetType

budgetTypeAsString

public final String budgetTypeAsString()

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

If the service returns an enum value that is not available in the current SDK version, budgetType will return BudgetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from budgetTypeAsString().

Returns:

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

See Also:

BudgetType

lastUpdatedTime

public final Instant lastUpdatedTime()

The last time that you updated this budget.

Returns:

The last time that you updated this budget.

toBuilder

public Budget.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Budget.Builder,Budget>

builder

public static Budget.Builder builder()

serializableBuilderClass

public static Class<? extends Budget.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo